XmppSession (Babbler 0.5.1)

java.lang.Object
- rocks.xmpp.core.session.XmppSession

All Implemented Interfaces:

AutoCloseable
```
public class XmppSession
extends Object
implements AutoCloseable
```
The base class for establishing an XMPP session with a server.

Establishing an XMPP Session
The following example shows the most simple way to establish a session:
```
 XmppSession xmppSession = new XmppSession("domain");
 xmppSession.connect();
 xmppSession.login("username", "password");
 xmppSession.send(new Presence());
 
 
```
By default, the session will try to establish a TCP connection over port 5222 and will try BOSH as fallback. You can configure a session and its connection methods by passing appropriate configurations in its constructor.

Sending Messages
Once connected, you can send messages:
```
 xmppSession.send(new Message(Jid.valueOf("juliet@example.net"), Message.Type.CHAT));
 
 
```
Closing the Session
```
 xmppSession.close();
 
 
```
Listening for Messages and Presence
Note: Adding the following listeners should be added before logging in, otherwise they might not trigger.
```
 
 // Listen for messages
 xmppSession.addInboundMessageListener(new MessageListener() {
     @Override
     public void handleMessage(MessageEvent e) {
         // Handle inbound message
     }
 });

 // Listen for presence changes
 xmppSession.addInboundPresenceListener(new PresenceListener() {
     @Override
     public void handlePresence(PresenceEvent e) {
         // Handle inbound presence.
     }
 });
 
 
```
This class is thread-safe, which means you can safely add listeners or call send(), close() (and other methods) from different threads.
See Also:
XmppSessionConfiguration, TcpConnectionConfiguration, BoshConnectionConfiguration

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class XmppSession.Status
Represents the session status.

Nested Classes
Modifier and Type	Class and Description
`static class`	`XmppSession.Status` Represents the session status.

Constructor Summary

Constructors
Constructor and Description
`XmppSession(String xmppServiceDomain, ConnectionConfiguration... connectionConfigurations)` Creates a session with the specified service domain, by using the default configuration.
`XmppSession(String xmppServiceDomain, XmppSessionConfiguration configuration, ConnectionConfiguration... connectionConfigurations)` Creates a session with the specified service domain by using a configuration.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addInboundIQListener(IQListener iqListener)` Adds an inbound IQ listener to the session, which will get notified, whenever an IQ stanza is received.
`void`	`addInboundMessageListener(MessageListener messageListener)` Adds an inbound message listener to the session, which will get notified, whenever a message is received.
`void`	`addInboundPresenceListener(PresenceListener presenceListener)` Adds an inbound presence listener to the session, which will get notified, whenever a presence is received.
`void`	`addIQHandler(Class<?> type, IQHandler iqHandler)` Adds an IQ handler for a given payload type.
`void`	`addIQHandler(Class<?> type, IQHandler iqHandler, boolean invokeAsync)` Adds an IQ handler for a given payload type.
`void`	`addIQListener(IQListener iqListener)` Deprecated. Use either `removeInboundIQListener(rocks.xmpp.core.stanza.IQListener)` or `removeOutboundIQListener(rocks.xmpp.core.stanza.IQListener)`
`void`	`addMessageListener(MessageListener messageListener)` Deprecated. Use either `addInboundMessageListener(rocks.xmpp.core.stanza.MessageListener)` or `addOutboundMessageListener(rocks.xmpp.core.stanza.MessageListener)`
`void`	`addOutboundIQListener(IQListener iqListener)` Adds an outbound IQ listener to the session, which will get notified, whenever an IQ stanza is sent.
`void`	`addOutboundMessageListener(MessageListener messageListener)` Adds an outbound message listener to the session, which will get notified, whenever a message is sent.
`void`	`addOutboundPresenceListener(PresenceListener presenceListener)` Adds an outbound presence listener to the session, which will get notified, whenever a presence is sent.
`void`	`addPresenceListener(PresenceListener presenceListener)` Deprecated. Use either `addInboundPresenceListener(rocks.xmpp.core.stanza.PresenceListener)` or `addOutboundPresenceListener(rocks.xmpp.core.stanza.PresenceListener)`
`void`	`addSessionStatusListener(SessionStatusListener sessionStatusListener)` Adds a session listener, which listens for session status changes.
`void`	`close()` Explicitly closes the session and performs a clean up of all listeners.
`void`	`connect()` Connects to the XMPP server.
`void`	`connect(Jid from)` Connects to the XMPP server.
`Marshaller`	`createMarshaller()` Creates a marshaller, which can be used to create XML from objects.
`Unmarshaller`	`createUnmarshaller()` Creates a new unmarshaller, which can be used to unmarshal XML to objects.
`Connection`	`getActiveConnection()` Gets the actively used connection.
`ChatManager`	`getChatManager()` Deprecated. Use `getManager(Class)` instead.
`XmppSessionConfiguration`	`getConfiguration()` Gets the configuration for this session.
`Jid`	`getConnectedResource()` Gets the connected resource, which is assigned by the server after resource binding.
`List<Connection>`	`getConnections()` Gets an unmodifiable list of connections, which this session will try during connecting.
`XmppDebugger`	`getDebugger()` Gets the debugger or null if no debugger class was specified in the configuration.
`int`	`getDefaultTimeout()` Deprecated. Use `XmppSessionConfiguration.getDefaultResponseTimeout()`.
`String`	`getDomain()` Gets the XMPP domain of the connected server.
`<T extends ExtensionManager> T`	`getExtensionManager(Class<T> clazz)` Deprecated. Use `getManager(Class)`
`<T extends Manager> T`	`getManager(Class<T> clazz)` Gets an instance of the specified manager class.
`PresenceManager`	`getPresenceManager()` Deprecated. Use `getManager(Class)` instead.
`ReconnectionManager`	`getReconnectionManager()` Deprecated. Use `getManager(Class)` instead.
`RosterManager`	`getRosterManager()` Deprecated. Use `getManager(Class)` instead.
`XmppSession.Status`	`getStatus()` Gets the status of the session.
`StreamFeaturesManager`	`getStreamFeaturesManager()` Deprecated. Use `getManager(Class)` instead.
`boolean`	`handleElement(Object element)` Handles an XMPP element.
`boolean`	`isAnonymous()` Indicates whether the session has been logged in anonymously.
`boolean`	`isConnected()` Indicates, whether the session is connected.
`void`	`login(String authorizationId, CallbackHandler callbackHandler, String resource)` Authenticates against the server with a custom callback handler and binds a resource.
`void`	`login(String user, String password)` Authenticates against the server and binds a random resource (assigned by the server).
`void`	`login(String user, String password, String resource)` Authenticates against the server with username/password credential and binds a resource.
`void`	`login(String authorizationId, String user, String password, String resource)` Authenticates against the server with an authorization id and username/password credential and binds a resource.
`void`	`loginAnonymously()` Logs in anonymously and binds a resource.
`void`	`notifyException(Exception e)` Called if any unhandled exception is thrown during reading or writing.
`IQ`	`query(IQ iq)` Sends an `<iq/>` stanza and waits for the response.
`IQ`	`query(IQ iq, long timeout)` Sends an `<iq/>` stanza and waits for the response.
`void`	`reconnect()` Deprecated. Use `connect()` which automatically performs a connect+login, if previously logged in.
`void`	`removeInboundIQListener(IQListener iqListener)` Removes a previously added inbound IQ listener from the session.
`void`	`removeInboundMessageListener(MessageListener messageListener)` Removes a previously added inbound message listener from the session.
`void`	`removeInboundPresenceListener(PresenceListener presenceListener)` Removes a previously added inbound presence listener from the session.
`void`	`removeIQHandler(Class<?> type)` Removes an IQ handler.
`void`	`removeIQListener(IQListener iqListener)` Deprecated. Use either `removeInboundIQListener(rocks.xmpp.core.stanza.IQListener)` or `removeOutboundIQListener(rocks.xmpp.core.stanza.IQListener)`
`void`	`removeMessageListener(MessageListener messageListener)` Deprecated. Use either `removeInboundMessageListener(rocks.xmpp.core.stanza.MessageListener)` or `removeOutboundMessageListener(rocks.xmpp.core.stanza.MessageListener)`
`void`	`removeOutboundIQListener(IQListener iqListener)` Removes a previously added outbound IQ listener from the session.
`void`	`removeOutboundMessageListener(MessageListener messageListener)` Removes a previously added outbound message listener from the session.
`void`	`removeOutboundPresenceListener(PresenceListener presenceListener)` Removes a previously added outbound presence listener from the session.
`void`	`removePresenceListener(PresenceListener presenceListener)` Deprecated. Use either `removeInboundPresenceListener(rocks.xmpp.core.stanza.PresenceListener)` or `removeOutboundPresenceListener(rocks.xmpp.core.stanza.PresenceListener)`
`void`	`removeSessionStatusListener(SessionStatusListener sessionStatusListener)` Removes a previously added session listener.
`void`	`send(ClientStreamElement element)` Sends an XML element to the server, usually a stanza, i.e. a message, presence or IQ.
`Message`	`sendAndAwaitMessage(ClientStreamElement stanza, StanzaFilter<Message> filter)` Sends a stanza and then waits for a message stanza to arrive.
`Presence`	`sendAndAwaitPresence(ClientStreamElement stanza, StanzaFilter<Presence> filter)` Sends a stanza and then waits for a presence stanza to arrive.
`void`	`setXmppServiceDomain(String xmppServiceDomain)` Sets the XMPP service domain.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - XmppSession
```
public XmppSession(String xmppServiceDomain,
           ConnectionConfiguration... connectionConfigurations)
```
    Creates a session with the specified service domain, by using the default configuration.
    
    Parameters:
    xmppServiceDomain - The service domain.
    connectionConfigurations - The connection configurations.
  - XmppSession
```
public XmppSession(String xmppServiceDomain,
           XmppSessionConfiguration configuration,
           ConnectionConfiguration... connectionConfigurations)
```
    Creates a session with the specified service domain by using a configuration.
    
    Parameters:
    xmppServiceDomain - The service domain.
    configuration - The configuration.
    connectionConfigurations - The connection configurations.
- Method Detail
  - getActiveConnection
```
public final Connection getActiveConnection()
```
    Gets the actively used connection.
    
    Returns:
    The actively used connection.
  - setXmppServiceDomain
```
public final void setXmppServiceDomain(String xmppServiceDomain)
```
    Sets the XMPP service domain. This should only be set by a connection implementation.
    
    Parameters:
    xmppServiceDomain - The XMPP service domain.
  - addMessageListener
```
@Deprecated
public final void addMessageListener(MessageListener messageListener)
```
    Deprecated. Use either addInboundMessageListener(rocks.xmpp.core.stanza.MessageListener) or addOutboundMessageListener(rocks.xmpp.core.stanza.MessageListener)
    
    Adds a message listener to the session, which will get notified, whenever a message is received.
    
    Parameters:
    messageListener - The message listener.
    See Also:
    removeMessageListener(MessageListener)
  - removeMessageListener
```
@Deprecated
public final void removeMessageListener(MessageListener messageListener)
```
    Deprecated. Use either removeInboundMessageListener(rocks.xmpp.core.stanza.MessageListener) or removeOutboundMessageListener(rocks.xmpp.core.stanza.MessageListener)
    
    Removes a previously added message listener from the session.
    
    Parameters:
    messageListener - The message listener.
    See Also:
    addMessageListener(MessageListener)
  - addInboundMessageListener
```
public final void addInboundMessageListener(MessageListener messageListener)
```
    Adds an inbound message listener to the session, which will get notified, whenever a message is received.
    
    Parameters:
    messageListener - The message listener.
    See Also:
    removeInboundMessageListener(MessageListener)
  - removeInboundMessageListener
```
public final void removeInboundMessageListener(MessageListener messageListener)
```
    Removes a previously added inbound message listener from the session.
    
    Parameters:
    messageListener - The message listener.
    See Also:
    addInboundMessageListener(MessageListener)
  - addOutboundMessageListener
```
public final void addOutboundMessageListener(MessageListener messageListener)
```
    Adds an outbound message listener to the session, which will get notified, whenever a message is sent.
    
    Parameters:
    messageListener - The message listener.
    See Also:
    removeOutboundMessageListener(MessageListener)
  - removeOutboundMessageListener
```
public final void removeOutboundMessageListener(MessageListener messageListener)
```
    Removes a previously added outbound message listener from the session.
    
    Parameters:
    messageListener - The message listener.
    See Also:
    addOutboundMessageListener(MessageListener)
  - addPresenceListener
```
@Deprecated
public final void addPresenceListener(PresenceListener presenceListener)
```
    Deprecated. Use either addInboundPresenceListener(rocks.xmpp.core.stanza.PresenceListener) or addOutboundPresenceListener(rocks.xmpp.core.stanza.PresenceListener)
    
    Adds a presence listener to the session, which will get notified, whenever a presence is received.
    
    Parameters:
    presenceListener - The presence listener.
    See Also:
    removePresenceListener(PresenceListener)
  - removePresenceListener
```
@Deprecated
public final void removePresenceListener(PresenceListener presenceListener)
```
    Deprecated. Use either removeInboundPresenceListener(rocks.xmpp.core.stanza.PresenceListener) or removeOutboundPresenceListener(rocks.xmpp.core.stanza.PresenceListener)
    
    Removes a previously added presence listener from the session.
    
    Parameters:
    presenceListener - The presence listener.
    See Also:
    addPresenceListener(PresenceListener)
  - addInboundPresenceListener
```
public final void addInboundPresenceListener(PresenceListener presenceListener)
```
    Adds an inbound presence listener to the session, which will get notified, whenever a presence is received.
    
    Parameters:
    presenceListener - The presence listener.
    See Also:
    removeInboundPresenceListener(PresenceListener)
  - removeInboundPresenceListener
```
public final void removeInboundPresenceListener(PresenceListener presenceListener)
```
    Removes a previously added inbound presence listener from the session.
    
    Parameters:
    presenceListener - The presence listener.
    See Also:
    addInboundPresenceListener(PresenceListener)
  - addOutboundPresenceListener
```
public final void addOutboundPresenceListener(PresenceListener presenceListener)
```
    Adds an outbound presence listener to the session, which will get notified, whenever a presence is sent.
    
    Parameters:
    presenceListener - The presence listener.
    See Also:
    removeOutboundPresenceListener(PresenceListener)
  - removeOutboundPresenceListener
```
public final void removeOutboundPresenceListener(PresenceListener presenceListener)
```
    Removes a previously added outbound presence listener from the session.
    
    Parameters:
    presenceListener - The presence listener.
    See Also:
    addOutboundPresenceListener(PresenceListener)
  - addIQListener
```
@Deprecated
public final void addIQListener(IQListener iqListener)
```
    Deprecated. Use either removeInboundIQListener(rocks.xmpp.core.stanza.IQListener) or removeOutboundIQListener(rocks.xmpp.core.stanza.IQListener)
    
    Adds an IQ listener to the session, which will get notified, whenever an IQ stanza is received.
    
    Parameters:
    iqListener - The IQ listener.
    See Also:
    removeIQListener(IQListener)
  - removeIQListener
```
@Deprecated
public final void removeIQListener(IQListener iqListener)
```
    Deprecated. Use either removeInboundIQListener(rocks.xmpp.core.stanza.IQListener) or removeOutboundIQListener(rocks.xmpp.core.stanza.IQListener)
    
    Removes a previously added IQ listener from the session.
    
    Parameters:
    iqListener - The IQ listener.
    See Also:
    addIQListener(IQListener)
  - addInboundIQListener
```
public final void addInboundIQListener(IQListener iqListener)
```
    Adds an inbound IQ listener to the session, which will get notified, whenever an IQ stanza is received.
    
    Parameters:
    iqListener - The IQ listener.
    See Also:
    removeInboundIQListener(IQListener)
  - removeInboundIQListener
```
public final void removeInboundIQListener(IQListener iqListener)
```
    Removes a previously added inbound IQ listener from the session.
    
    Parameters:
    iqListener - The IQ listener.
    See Also:
    addInboundIQListener(IQListener)
  - addOutboundIQListener
```
public final void addOutboundIQListener(IQListener iqListener)
```
    Adds an outbound IQ listener to the session, which will get notified, whenever an IQ stanza is sent.
    
    Parameters:
    iqListener - The IQ listener.
    See Also:
    removeOutboundIQListener(IQListener)
  - removeOutboundIQListener
```
public final void removeOutboundIQListener(IQListener iqListener)
```
    Removes a previously added outbound IQ listener from the session.
    
    Parameters:
    iqListener - The IQ listener.
    See Also:
    addOutboundIQListener(IQListener)
  - addIQHandler
```
public final void addIQHandler(Class<?> type,
                IQHandler iqHandler)
```
    Adds an IQ handler for a given payload type. The handler will be processed asynchronously, which means it won't block the inbound stanza processing queue.
    
    Parameters:
    type - The payload type.
    iqHandler - The IQ handler.
    See Also:
    removeIQHandler(Class), addIQHandler(Class, rocks.xmpp.core.stanza.IQHandler, boolean)
  - addIQHandler
```
public final void addIQHandler(Class<?> type,
                IQHandler iqHandler,
                boolean invokeAsync)
```
    Adds an IQ handler for a given payload type. The handler can either be processed asynchronously (which means it won't block the inbound stanza processing queue), or synchronously, which means IQ requests are processed on the same thread as other stanzas. In other words synchronous processing means, the IQ requests are processed in the same order as they arrive and no other stanzas can be processed until the handler has returned.
    
    Parameters:
    type - The payload type.
    iqHandler - The IQ handler.
    invokeAsync - True, if the handler should be processed asynchronously; false, if the handler should be processed asynchronously.
    See Also:
    removeIQHandler(Class)
  - removeIQHandler
```
public final void removeIQHandler(Class<?> type)
```
    Removes an IQ handler.
    
    Parameters:
    type - The payload type.
    See Also:
    addIQHandler(Class, rocks.xmpp.core.stanza.IQHandler)
  - addSessionStatusListener
```
public final void addSessionStatusListener(SessionStatusListener sessionStatusListener)
```
    Adds a session listener, which listens for session status changes. Each time the session status changes, all listeners will be notified.
    
    Parameters:
    sessionStatusListener - The session listener.
    See Also:
    removeSessionStatusListener(SessionStatusListener)
  - removeSessionStatusListener
```
public final void removeSessionStatusListener(SessionStatusListener sessionStatusListener)
```
    Removes a previously added session listener.
    
    Parameters:
    sessionStatusListener - The session listener.
    See Also:
    addSessionStatusListener(SessionStatusListener)
  - query
```
public IQ query(IQ iq)
         throws XmppException
```
    Sends an <iq/> stanza and waits for the response.
    This method blocks until a result was received or a timeout occurred.
    
    Parameters:
    iq - The <iq/> stanza, which must be of type get or set.
    
    Returns:
    The result <iq/> stanza.
    
    Throws:
    
    StanzaException - If the entity returned a stanza error.
    
    NoResponseException - If the entity did not respond.
    
    XmppException
  - query
```
public IQ query(IQ iq,
       long timeout)
         throws XmppException
```
    Sends an <iq/> stanza and waits for the response.
    This method blocks until a result was received or a timeout occurred.
    
    Parameters:
    iq - The <iq/> stanza, which must be of type get or set.
    timeout - The timeout.
    
    Returns:
    The result <iq/> stanza.
    
    Throws:
    
    StanzaException - If the entity returned a stanza error.
    
    NoResponseException - If the entity did not respond.
    
    XmppException
  - sendAndAwaitPresence
```
public final Presence sendAndAwaitPresence(ClientStreamElement stanza,
                            StanzaFilter<Presence> filter)
                                    throws XmppException
```
    Sends a stanza and then waits for a presence stanza to arrive. The filter determines the characteristics of the presence stanza.
    
    Parameters:
    stanza - The stanza, which is sent.
    filter - The presence filter.
    
    Returns:
    The presence stanza.
    
    Throws:
    
    StanzaException - If the entity returned a stanza error.
    
    NoResponseException - If the entity did not respond.
    
    XmppException
  - sendAndAwaitMessage
```
public final Message sendAndAwaitMessage(ClientStreamElement stanza,
                          StanzaFilter<Message> filter)
                                  throws XmppException
```
    Sends a stanza and then waits for a message stanza to arrive. The filter determines the characteristics of the message stanza.
    
    Parameters:
    stanza - The stanza, which is sent.
    filter - The message filter.
    
    Returns:
    The message stanza.
    
    Throws:
    
    StanzaException - If the entity returned a stanza error.
    
    NoResponseException - If the entity did not respond.
    
    XmppException
  - reconnect
```
@Deprecated
public final void reconnect()
                     throws XmppException
```
    Deprecated. Use connect() which automatically performs a connect+login, if previously logged in.
    
    Reconnects to the XMPP server and automatically logs in by using the last known information (e.g. user name, password and bound resource).
    
    Throws:
    
    ConnectionException - If a connection error occurred on the transport layer, e.g. the socket could not connect.
    
    StreamErrorException - If the server returned a stream error.
    
    StreamNegotiationException - If any exception occurred during stream feature negotiation.
    
    NoResponseException - If the server didn't return a response during stream establishment.
    
    AuthenticationException - If the login failed, due to a SASL error reported by the server.
    
    XmppException - If any other XMPP exception occurs.
  - connect
```
public final void connect()
                   throws XmppException
```
    Connects to the XMPP server.
    
    Throws:
    
    ConnectionException - If a connection error occurred on the transport layer, e.g. the socket could not connect.
    
    StreamErrorException - If the server returned a stream error.
    
    StreamNegotiationException - If any exception occurred during stream feature negotiation.
    
    NoResponseException - If the server didn't return a response during stream establishment.
    
    XmppException - If any other XMPP exception occurs.
    
    IllegalStateException - If the session is in a wrong state, e.g. closed or already connected.
  - connect
```
public final void connect(Jid from)
                   throws XmppException
```
    Connects to the XMPP server.
    
    Parameters:
    from - The 'from' attribute.
    
    Throws:
    
    ConnectionException - If a connection error occurred on the transport layer, e.g. the socket could not connect.
    
    StreamErrorException - If the server returned a stream error.
    
    StreamNegotiationException - If any exception occurred during stream feature negotiation.
    
    NoResponseException - If the server didn't return a response during stream establishment.
    
    XmppException - If any other XMPP exception occurs.
    
    IllegalStateException - If the session is in a wrong state, e.g. closed or already connected.
  - close
```
public void close()
           throws XmppException
```
    Explicitly closes the session and performs a clean up of all listeners. Calling this method, if the session is already closing or closed has no effect.
    
    Specified by:
    
    close in interface AutoCloseable
    
    Throws:
    
    XmppException - If an exception occurs while closing the connection, e.g. the underlying socket connection.
  - send
```
public void send(ClientStreamElement element)
```
    Sends an XML element to the server, usually a stanza, i.e. a message, presence or IQ.
    
    Parameters:
    element - The XML element.
  - login
```
public final void login(String user,
         String password)
                 throws XmppException
```
    Authenticates against the server and binds a random resource (assigned by the server).
    
    Parameters:
    user - The user name. Usually this is the local part of the user's JID. Must not be null.
    password - The password. Must not be null.
    
    Throws:
    
    AuthenticationException - If the login failed, due to a SASL error reported by the server.
    
    StreamErrorException - If the server returned a stream error.
    
    StreamNegotiationException - If any exception occurred during stream feature negotiation.
    
    NoResponseException - If the server didn't return a response during stream establishment.
    
    StanzaException - If the server returned a stanza error during resource binding or roster retrieval.
    
    XmppException - If the login failed, due to another error.
  - login
```
public final void login(String user,
         String password,
         String resource)
                 throws XmppException
```
    Authenticates against the server with username/password credential and binds a resource.
    
    Parameters:
    user - The user name. Usually this is the local part of the user's JID. Must not be null.
    password - The password. Must not be null.
    resource - The resource. If null or empty, the resource is randomly assigned by the server.
    
    Throws:
    
    AuthenticationException - If the login failed, due to a SASL error reported by the server.
    
    StreamErrorException - If the server returned a stream error.
    
    StreamNegotiationException - If any exception occurred during stream feature negotiation.
    
    NoResponseException - If the server didn't return a response during stream establishment.
    
    StanzaException - If the server returned a stanza error during resource binding or roster retrieval.
    
    XmppException - If the login failed, due to another error.
  - login
```
public final void login(String authorizationId,
         String user,
         String password,
         String resource)
                 throws XmppException
```
    Authenticates against the server with an authorization id and username/password credential and binds a resource.
    
    Parameters:
    authorizationId - The authorization id.
    user - The user name. Usually this is the local part of the user's JID. Must not be null.
    password - The password. Must not be null.
    resource - The resource. If null or empty, the resource is randomly assigned by the server.
    
    Throws:
    
    AuthenticationException - If the login failed, due to a SASL error reported by the server.
    
    StreamErrorException - If the server returned a stream error.
    
    StreamNegotiationException - If any exception occurred during stream feature negotiation.
    
    NoResponseException - If the server didn't return a response during stream establishment.
    
    StanzaException - If the server returned a stanza error during resource binding or roster retrieval.
    
    XmppException - If the login failed, due to another error.
  - login
```
public final void login(String authorizationId,
         CallbackHandler callbackHandler,
         String resource)
                 throws XmppException
```
    Authenticates against the server with a custom callback handler and binds a resource.
    
    Parameters:
    authorizationId - The authorization id.
    callbackHandler - The callback handler.
    resource - The resource. If null or empty, the resource is randomly assigned by the server.
    
    Throws:
    
    AuthenticationException - If the login failed, due to a SASL error reported by the server.
    
    StreamErrorException - If the server returned a stream error.
    
    StreamNegotiationException - If any exception occurred during stream feature negotiation.
    
    NoResponseException - If the server didn't return a response during stream establishment.
    
    StanzaException - If the server returned a stanza error during resource binding or roster retrieval.
    
    XmppException - If the login failed, due to another error.
  - loginAnonymously
```
public final void loginAnonymously()
                            throws XmppException
```
    Logs in anonymously and binds a resource.
    
    Throws:
    
    AuthenticationException - If the login failed, due to a SASL error reported by the server.
    
    StreamErrorException - If the server returned a stream error.
    
    StreamNegotiationException - If any exception occurred during stream feature negotiation.
    
    NoResponseException - If the server didn't return a response during stream establishment.
    
    StanzaException - If the server returned a stanza error during resource binding.
    
    XmppException - If the login failed, due to another error.
  - handleElement
```
public final boolean handleElement(Object element)
                            throws XmppException
```
    Handles an XMPP element.
    This method should be called on the reader thread.
    
    Parameters:
    element - The XMPP element.
    
    Returns:
    True, if the stream needs to be restarted; otherwise false.
    
    Throws:
    
    StreamErrorException - If the element is a stream error.
    
    StreamNegotiationException - If any exception occurred during stream feature negotiation.
    
    XmppException - If any other XMPP exception occurs.
  - notifyException
```
public final void notifyException(Exception e)
```
    Called if any unhandled exception is thrown during reading or writing.
    This method will close the stream.
    
    Parameters:
    e - The exception. If an unrecoverable XMPP stream error occurred, the exception is a StreamError.
  - getExtensionManager
```
@Deprecated
public final <T extends ExtensionManager> T getExtensionManager(Class<T> clazz)
```
    Deprecated. Use getManager(Class)
    
    Gets an instance of the specified extension manager class. The class MUST have a constructor which takes a single parameter, whose type is XmppSession.
    
    Type Parameters:
    T - The type.
    Parameters:
    clazz - The class of the extension manager.
    
    Returns:
    An instance of the specified manager.
  - getManager
```
public final <T extends Manager> T getManager(Class<T> clazz)
```
    Gets an instance of the specified manager class. The class MUST have a constructor which takes a single parameter, whose type is XmppSession.
    
    Type Parameters:
    T - The type.
    Parameters:
    clazz - The class of the manager.
    
    Returns:
    An instance of the specified manager.
  - getRosterManager
```
@Deprecated
public final RosterManager getRosterManager()
```
    Deprecated. Use getManager(Class) instead.
    
    Gets the roster manager, which is responsible for retrieving, updating and deleting contacts from the roster.
    
    Returns:
    The roster manager.
  - getPresenceManager
```
@Deprecated
public final PresenceManager getPresenceManager()
```
    Deprecated. Use getManager(Class) instead.
    
    Gets the presence manager, which is responsible for presence subscriptions.
    
    Returns:
    The presence manager.
  - getReconnectionManager
```
@Deprecated
public final ReconnectionManager getReconnectionManager()
```
    Deprecated. Use getManager(Class) instead.
    
    Gets the reconnection manager, which is responsible for automatic reconnection.
    
    Returns:
    The reconnection manager.
  - getStreamFeaturesManager
```
@Deprecated
public final StreamFeaturesManager getStreamFeaturesManager()
```
    Deprecated. Use getManager(Class) instead.
    
    Gets the features manager, which is responsible for negotiating features.
    
    Returns:
    The features manager.
  - getChatManager
```
@Deprecated
public final ChatManager getChatManager()
```
    Deprecated. Use getManager(Class) instead.
    
    Gets the chat manager, which is responsible for one-to-one chat sessions.
    
    Returns:
    The chat manager.
  - getConnectedResource
```
public final Jid getConnectedResource()
```
    Gets the connected resource, which is assigned by the server after resource binding.
    
    7.1. Fundamentals
    
    After a client has bound a resource to the stream, it is referred to as a "connected resource".
    
    Returns:
    The connected resource.
  - getDomain
```
public final String getDomain()
```
    Gets the XMPP domain of the connected server. This variable is set after server has responded with a stream header. The domain is the stream header's 'from' attribute.
    
    Returns:
    The XMPP domain.
  - getStatus
```
public final XmppSession.Status getStatus()
```
    Gets the status of the session.
    
    Returns:
    The status.
  - getConnections
```
public final List<Connection> getConnections()
```
    Gets an unmodifiable list of connections, which this session will try during connecting.
    
    Returns:
    The connections.
  - createUnmarshaller
```
public final Unmarshaller createUnmarshaller()
```
    Creates a new unmarshaller, which can be used to unmarshal XML to objects.
    Note that the returned unmarshaller is not thread-safe.
    
    Returns:
    The unmarshaller.
    See Also:
    createMarshaller()
  - createMarshaller
```
public final Marshaller createMarshaller()
```
    Creates a marshaller, which can be used to create XML from objects.
    The returned marshaller is configured with Marshaller.JAXB_FRAGMENT = true, so that no XML header is written (which is usually what we want in XMPP when writing stanzas).
    Note that the returned unmarshaller is not thread-safe.
    
    Returns:
    The marshaller.
    See Also:
    createUnmarshaller()
  - getDefaultTimeout
```
@Deprecated
public final int getDefaultTimeout()
```
    Deprecated. Use XmppSessionConfiguration.getDefaultResponseTimeout().
    
    Gets the default timeout for synchronous operations.
    
    Returns:
    The default timeout.
  - isConnected
```
public final boolean isConnected()
```
    Indicates, whether the session is connected.
    
    Returns:
    True, if the status is XmppSession.Status.CONNECTED, XmppSession.Status.AUTHENTICATED or XmppSession.Status.AUTHENTICATING.
    See Also:
    getStatus()
  - isAnonymous
```
public final boolean isAnonymous()
```
    Indicates whether the session has been logged in anonymously. If never logged in at all, returns false.
    
    Returns:
    True, if the session is anonymous.
  - getConfiguration
```
public final XmppSessionConfiguration getConfiguration()
```
    Gets the configuration for this session.
    
    Returns:
    The configuration.
  - getDebugger
```
public final XmppDebugger getDebugger()
```
    Gets the debugger or null if no debugger class was specified in the configuration.
    
    Returns:
    The debugger.
    See Also:
    XmppSessionConfiguration.getDebugger()

Class XmppSession

Establishing an XMPP Session

Sending Messages

Closing the Session

Listening for Messages and Presence

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

XmppSession

XmppSession

Method Detail

getActiveConnection

setXmppServiceDomain

addMessageListener

removeMessageListener

addInboundMessageListener

removeInboundMessageListener

addOutboundMessageListener

removeOutboundMessageListener

addPresenceListener

removePresenceListener

addInboundPresenceListener

removeInboundPresenceListener

addOutboundPresenceListener

removeOutboundPresenceListener

addIQListener

removeIQListener

addInboundIQListener

removeInboundIQListener

addOutboundIQListener

removeOutboundIQListener

addIQHandler

addIQHandler

removeIQHandler

addSessionStatusListener

removeSessionStatusListener

query

query

sendAndAwaitPresence

sendAndAwaitMessage

reconnect

connect

connect

close

send

login

login

login

login

loginAnonymously

handleElement

notifyException

getExtensionManager

getManager

getRosterManager

getPresenceManager

getReconnectionManager

getStreamFeaturesManager

getChatManager

getConnectedResource

getDomain

getStatus

getConnections

createUnmarshaller

createMarshaller

getDefaultTimeout

isConnected

isAnonymous

getConfiguration

getDebugger