IQRequestHandler.java

  1. /**
  2.  *
  3.  * Copyright 2015-2019 Florian Schmaus
  4.  *
  5.  * Licensed under the Apache License, Version 2.0 (the "License");
  6.  * you may not use this file except in compliance with the License.
  7.  * You may obtain a copy of the License at
  8.  *
  9.  *     http://www.apache.org/licenses/LICENSE-2.0
  10.  *
  11.  * Unless required by applicable law or agreed to in writing, software
  12.  * distributed under the License is distributed on an "AS IS" BASIS,
  13.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14.  * See the License for the specific language governing permissions and
  15.  * limitations under the License.
  16.  */
  17. package org.jivesoftware.smack.iqrequest;

  18. import javax.xml.namespace.QName;

  19. import org.jivesoftware.smack.packet.IQ;

  20. /**
  21.  * IQ request handler are responsible for handling incoming IQ requests. They can be registered with
  22.  * {@link org.jivesoftware.smack.XMPPConnection#registerIQRequestHandler(IQRequestHandler)}.
  23.  *
  24.  * @see AbstractIqRequestHandler
  25.  */
  26. public interface IQRequestHandler {

  27.     enum Mode {
  28.         /**
  29.          * Process requests synchronously, i.e. in the order they arrive. Uses a single thread, which means that the other
  30.          * requests have to wait until all previous synchronous requests have been handled. Use {@link #async} if
  31.          * possible for performance reasons.
  32.          */
  33.         sync,

  34.         /**
  35.          * Process IQ requests asynchronously, i.e. concurrent. This does not guarantee that requests are processed in the
  36.          * same order they arrive.
  37.          */
  38.         async,
  39.     }

  40.     IQ handleIQRequest(IQ iqRequest);

  41.     Mode getMode();

  42.     IQ.Type getType();

  43.     String getElement();

  44.     String getNamespace();

  45.     default QName getQName() {
  46.         return new QName(getNamespace(), getElement());
  47.     }
  48. }