public abstract class AbstractXMPPConnection extends Object implements XMPPConnection
connect()
, login()
and
disconnect()
(which are deliberately not provided by the XMPPConnection
interface).
Note: The default entry point to Smack's documentation is XMPPConnection
. If you are getting started
with Smack, then head over to XMPPConnection
and the come back here.
In case a Smack parser (Provider) throws those exceptions are handled over to the ParsingExceptionCallback
. A
common cause for a provider throwing is illegal input, for example a non-numeric String where only Integers are
allowed. Smack's default behavior follows the "fail-hard per default" principle leading to a
termination of the connection on parsing exceptions. This default was chosen to make users eventually aware that they
should configure their own callback and handle those exceptions to prevent the disconnect. Handle a parsing exception
could be as simple as using a non-throwing no-op callback, which would cause the faulty stream element to be taken
out of the stream, i.e., Smack behaves like that element was never received.
If the parsing exception is because Smack received illegal input, then please consider informing the authors of the originating entity about that. If it was thrown because of an bug in a Smack parser, then please consider filling a bug with Smack.
The "fail-hard per default" behavior is achieved by using the
ExceptionThrowingCallbackWithHint
as default parsing exception callback. You
can change the behavior using setParsingExceptionCallback(ParsingExceptionCallback)
to set a new callback.
Use SmackConfiguration.setDefaultParsingExceptionCallback(ParsingExceptionCallback)
to
set the default callback.
Modifier and Type | Class and Description |
---|---|
protected static class |
AbstractXMPPConnection.InterceptorWrapper
A wrapper class to associate a stanza filter with an interceptor.
|
protected static class |
AbstractXMPPConnection.ListenerWrapper
A wrapper class to associate a stanza filter with a listener.
|
XMPPConnection.FromMode
Modifier and Type | Field and Description |
---|---|
protected boolean |
authenticated
Flag that indicates if the user is currently authenticated with the server.
|
protected XMPPInputOutputStream |
compressionHandler |
protected ConnectionConfiguration |
config
Holds the initial configuration used while creating the connection.
|
protected boolean |
connected |
protected int |
connectionCounterValue
A number to uniquely identify connections that are created.
|
protected Set<ConnectionListener> |
connectionListeners
A collection of ConnectionListeners which listen for connection closing
and reconnection events.
|
protected Lock |
connectionLock |
protected SmackDebugger |
debugger
The SmackDebugger allows to log and debug XML traffic.
|
protected String |
host
The used host to establish the connection to
|
protected List<HostAddress> |
hostAddresses |
protected SynchronizationPoint<Exception> |
lastFeaturesReceived
Set to success if the last features stanza from the server has been parsed.
|
protected int |
port
The used port to establish the connection to
|
protected Reader |
reader
The Reader which is used for the debugger.
|
protected SASLAuthentication |
saslAuthentication
The SASLAuthentication manager that is responsible for authenticating with the server.
|
protected SynchronizationPoint<XMPPException> |
saslFeatureReceived
Set to success if the SASL feature has been received.
|
protected static ScheduledExecutorService |
SCHEDULED_EXECUTOR_SERVICE
This scheduled thread pool executor is used to remove pending callbacks.
|
protected Map<String,ExtensionElement> |
streamFeatures |
protected String |
streamId
The stream ID, see RFC 6120 ยง 4.7.3
|
protected SynchronizationPoint<SmackException> |
tlsHandled |
protected EntityFullJid |
user
The full JID of the authenticated user, as returned by the resource binding response of the server.
|
protected boolean |
wasAuthenticated
Flag that indicates if the user was authenticated with the server when the connection
to the server was closed (abruptly or not).
|
protected Writer |
writer
The Writer which is used for the debugger.
|
Modifier | Constructor and Description |
---|---|
protected |
AbstractXMPPConnection(ConnectionConfiguration configuration)
Create a new XMPPConnection to an XMPP server.
|
Modifier and Type | Method and Description |
---|---|
void |
addAsyncStanzaListener(StanzaListener packetListener,
StanzaFilter packetFilter)
Registers an asynchronous stanza listener with this connection.
|
void |
addConnectionListener(ConnectionListener connectionListener)
Adds a connection listener to this connection that will be notified when
the connection closes or fails.
|
void |
addOneTimeSyncCallback(StanzaListener callback,
StanzaFilter packetFilter)
Add a callback that is called exactly once and synchronously with the incoming stanza that matches the given
stanza filter.
|
void |
addPacketInterceptor(StanzaListener packetInterceptor,
StanzaFilter packetFilter)
Deprecated.
|
void |
addPacketSendingListener(StanzaListener packetListener,
StanzaFilter packetFilter)
Deprecated.
|
void |
addStanzaInterceptor(StanzaListener packetInterceptor,
StanzaFilter packetFilter)
Registers a stanza interceptor with this connection.
|
void |
addStanzaSendingListener(StanzaListener packetListener,
StanzaFilter packetFilter)
Registers a stanza listener with this connection.
|
protected void |
addStreamFeature(ExtensionElement feature) |
void |
addSyncStanzaListener(StanzaListener packetListener,
StanzaFilter packetFilter)
Registers a synchronous stanza listener with this connection.
|
protected void |
afterFeaturesReceived() |
protected void |
afterSuccessfulLogin(boolean resumed) |
protected static void |
asyncGo(Runnable runnable) |
protected void |
bindResourceAndEstablishSession(Resourcepart resource) |
protected void |
callConnectionAuthenticatedListener(boolean resumed) |
protected void |
callConnectionClosedOnErrorListener(Exception e) |
protected void |
callConnectionConnectedListener() |
AbstractXMPPConnection |
connect()
Establishes a connection to the XMPP server.
|
protected abstract void |
connectInternal()
Abstract method that concrete subclasses of XMPPConnection need to implement to perform their
way of XMPP connection establishment.
|
StanzaCollector |
createStanzaCollector(StanzaCollector.Configuration configuration)
Create a new stanza collector with the given stanza collector configuration.
|
StanzaCollector |
createStanzaCollector(StanzaFilter packetFilter)
Creates a new stanza collector for this connection.
|
StanzaCollector |
createStanzaCollectorAndSend(IQ packet)
Creates a new stanza collector collecting IQ responses that are replies to the IQ
request . |
StanzaCollector |
createStanzaCollectorAndSend(StanzaFilter packetFilter,
Stanza packet)
Creates a new stanza collector for this connection.
|
void |
disconnect()
Closes the connection by setting presence to unavailable then closing the connection to
the XMPP server.
|
void |
disconnect(Presence unavailablePresence)
Closes the connection.
|
protected void |
firePacketSendingListeners(Stanza packet)
Process all stanza listeners for sending packets.
|
ConnectionConfiguration |
getConfiguration()
Get the connection configuration used by this connection.
|
int |
getConnectionCounter()
Get the connection counter of this XMPPConnection instance.
|
protected Lock |
getConnectionLock() |
<F extends ExtensionElement> |
getFeature(String element,
String namespace)
Get the feature stanza extensions for a given stream feature of the
server, or
null if the server doesn't support that feature. |
XMPPConnection.FromMode |
getFromMode()
Get the currently active FromMode.
|
String |
getHost()
Returns the host name of the server where the XMPP server is running.
|
long |
getLastStanzaReceived()
Returns the timestamp in milliseconds when the last stanza was received.
|
ParsingExceptionCallback |
getParsingExceptionCallback()
Get the current active parsing exception callback.
|
int |
getPort()
Returns the port number of the XMPP server for this connection.
|
long |
getReplyTimeout()
Returns the current value of the reply timeout in milliseconds for request for this
XMPPConnection instance.
|
protected SASLAuthentication |
getSASLAuthentication()
Returns the SASLAuthentication manager that is responsible for authenticating with
the server.
|
String |
getStreamId()
Returns the stream ID for this connection, which is the value set by the server
when opening an XMPP stream.
|
String |
getUsedSaslMechansism()
Get the name of the SASL mechanism that was used to authenticate this connection.
|
EntityFullJid |
getUser()
Returns the full XMPP address of the user that is logged in to the connection or
null if not logged in yet.
|
DomainBareJid |
getXMPPServiceDomain()
Returns the XMPP Domain of the service provided by the XMPP server and used for this connection.
|
boolean |
hasFeature(String element,
String namespace)
Return true if the server supports the given stream feature.
|
protected void |
initDebugger()
Initialize the
debugger . |
protected void |
invokeStanzaCollectorsAndNotifyRecvListeners(Stanza packet)
Invoke
StanzaCollector.processStanza(Stanza) for every
StanzaCollector with the given packet. |
boolean |
isAnonymous()
Returns true if currently authenticated anonymously.
|
boolean |
isAuthenticated()
Returns true if currently authenticated by successfully calling the login method.
|
boolean |
isConnected()
Returns true if currently connected to the XMPP server.
|
abstract boolean |
isSecureConnection()
Returns true if the connection to the server has successfully negotiated encryption.
|
abstract boolean |
isUsingCompression()
Returns true if network traffic is being compressed.
|
void |
login()
Logs in to the server using the strongest SASL mechanism supported by
the server.
|
void |
login(CharSequence username,
String password)
Same as
login(CharSequence, String, Resourcepart) , but takes the resource from the connection
configuration. |
void |
login(CharSequence username,
String password,
Resourcepart resource)
Login with the given username (authorization identity).
|
protected abstract void |
loginInternal(String username,
String password,
Resourcepart resource) |
protected void |
parseAndProcessStanza(org.xmlpull.v1.XmlPullParser parser) |
protected void |
parseFeatures(org.xmlpull.v1.XmlPullParser parser) |
protected List<HostAddress> |
populateHostAddresses()
Populates
hostAddresses with the resolved addresses or with the configured host address. |
protected void |
processStanza(Stanza stanza)
Processes a stanza after it's been fully parsed by looping through the installed
stanza collectors and listeners and letting them examine the stanza to see if
they are a match with the filter.
|
IQRequestHandler |
registerIQRequestHandler(IQRequestHandler iqRequestHandler)
Register an IQ request handler with this connection.
|
boolean |
removeAsyncStanzaListener(StanzaListener packetListener)
Removes an asynchronous stanza listener for received stanzas from this connection.
|
void |
removeConnectionListener(ConnectionListener connectionListener)
Removes a connection listener from this connection.
|
void |
removePacketInterceptor(StanzaListener packetInterceptor)
Deprecated.
|
void |
removePacketSendingListener(StanzaListener packetListener)
Deprecated.
|
void |
removeStanzaCollector(StanzaCollector collector)
Remove a stanza collector of this connection.
|
void |
removeStanzaInterceptor(StanzaListener packetInterceptor)
Removes a stanza interceptor.
|
void |
removeStanzaSendingListener(StanzaListener packetListener)
Removes a stanza listener for sending stanzas from this connection.
|
boolean |
removeSyncStanzaListener(StanzaListener packetListener)
Removes a stanza listener for received stanzas from this connection.
|
protected static ScheduledFuture<?> |
schedule(Runnable runnable,
long delay,
TimeUnit unit) |
<S extends Stanza> |
sendAsync(S stanza,
StanzaFilter replyFilter)
Send a stanza asynchronously, waiting for exactly one response stanza using the given reply filter.
|
<S extends Stanza> |
sendAsync(S stanza,
StanzaFilter replyFilter,
long timeout)
Send a stanza asynchronously, waiting for exactly one response stanza using the given reply filter.
|
<I extends IQ> |
sendIqRequestAndWaitForResponse(IQ request)
Send an IQ request and wait for the response.
|
SmackFuture<IQ,Exception> |
sendIqRequestAsync(IQ request)
Send an IQ request asynchronously.
|
SmackFuture<IQ,Exception> |
sendIqRequestAsync(IQ request,
long timeout)
Send an IQ request asynchronously.
|
void |
sendIqWithResponseCallback(IQ iqRequest,
StanzaListener callback)
Send a IQ stanza and invoke
callback if there is a result of
IQ.Type.result with that result IQ. |
void |
sendIqWithResponseCallback(IQ iqRequest,
StanzaListener callback,
ExceptionCallback exceptionCallback)
Send a IQ stanza and invoke
callback if there is a result of
IQ.Type.result with that result IQ. |
void |
sendIqWithResponseCallback(IQ iqRequest,
StanzaListener callback,
ExceptionCallback exceptionCallback,
long timeout)
Send a IQ stanza and invoke
callback if there is a result of
IQ.Type.result with that result IQ. |
abstract void |
sendNonza(Nonza element)
Send a Nonza.
|
void |
sendStanza(Stanza stanza)
Sends the specified stanza to the server.
|
protected abstract void |
sendStanzaInternal(Stanza packet) |
void |
sendStanzaWithResponseCallback(Stanza stanza,
StanzaFilter replyFilter,
StanzaListener callback)
Send a stanza and wait asynchronously for a response by using
replyFilter . |
void |
sendStanzaWithResponseCallback(Stanza stanza,
StanzaFilter replyFilter,
StanzaListener callback,
ExceptionCallback exceptionCallback)
Send a stanza and wait asynchronously for a response by using
replyFilter . |
void |
sendStanzaWithResponseCallback(Stanza stanza,
StanzaFilter replyFilter,
StanzaListener callback,
ExceptionCallback exceptionCallback,
long timeout)
Send a stanza and wait asynchronously for a response by using
replyFilter . |
void |
setFromMode(XMPPConnection.FromMode fromMode)
Set the FromMode for this connection instance.
|
void |
setParsingExceptionCallback(ParsingExceptionCallback callback)
Install a parsing exception callback, which will be invoked once an exception is encountered while parsing a
stanza.
|
void |
setReplyTimeout(long timeout)
Set the stanza reply timeout in milliseconds.
|
void |
setUnknownIqRequestReplyMode(SmackConfiguration.UnknownIqRequestReplyMode unknownIqRequestReplyMode)
Set how Smack behaves when an unknown IQ request has been received.
|
protected void |
setWasAuthenticated()
Sets whether the connection has already logged in the server.
|
protected abstract void |
shutdown()
Shuts the current connection down.
|
protected void |
throwAlreadyConnectedExceptionIfAppropriate() |
protected void |
throwAlreadyLoggedInExceptionIfAppropriate() |
protected void |
throwNotConnectedExceptionIfAppropriate() |
protected void |
throwNotConnectedExceptionIfAppropriate(String optionalHint) |
String |
toString() |
IQRequestHandler |
unregisterIQRequestHandler(IQRequestHandler iqRequestHandler)
Convenience method for
XMPPConnection.unregisterIQRequestHandler(String, String, org.jivesoftware.smack.packet.IQ.Type) . |
IQRequestHandler |
unregisterIQRequestHandler(String element,
String namespace,
IQ.Type type)
Unregister an IQ request handler with this connection.
|
protected final Set<ConnectionListener> connectionListeners
protected final Lock connectionLock
protected final Map<String,ExtensionElement> streamFeatures
protected EntityFullJid user
It is important that we don't infer the user from the login() arguments and the configurations service name, as, for example, when SASL External is used, the username is not given to login but taken from the 'external' certificate.
protected boolean connected
protected final SmackDebugger debugger
protected final SynchronizationPoint<SmackException> tlsHandled
protected final SynchronizationPoint<Exception> lastFeaturesReceived
protected final SynchronizationPoint<XMPPException> saslFeatureReceived
protected final SASLAuthentication saslAuthentication
protected final int connectionCounterValue
protected final ConnectionConfiguration config
protected XMPPInputOutputStream compressionHandler
protected static final ScheduledExecutorService SCHEDULED_EXECUTOR_SERVICE
protected int port
protected boolean authenticated
protected boolean wasAuthenticated
protected List<HostAddress> hostAddresses
protected AbstractXMPPConnection(ConnectionConfiguration configuration)
configuration
- The configuration which is used to establish the connection.public ConnectionConfiguration getConfiguration()
public DomainBareJid getXMPPServiceDomain()
XMPPConnection
getXMPPServiceDomain
in interface XMPPConnection
public String getHost()
XMPPConnection
getHost
in interface XMPPConnection
public int getPort()
XMPPConnection
getPort
in interface XMPPConnection
public abstract boolean isSecureConnection()
XMPPConnection
isSecureConnection
in interface XMPPConnection
protected abstract void sendStanzaInternal(Stanza packet) throws SmackException.NotConnectedException, InterruptedException
public abstract void sendNonza(Nonza element) throws SmackException.NotConnectedException, InterruptedException
XMPPConnection
This method is not meant for end-user usage! It allows sending plain stream elements, which should not be done by a user manually. Doing so may result in a unstable or unusable connection. Certain Smack APIs use this method to send plain stream elements.
sendNonza
in interface XMPPConnection
element
- the Nonza to send.SmackException.NotConnectedException
InterruptedException
public abstract boolean isUsingCompression()
XMPPConnection
isUsingCompression
in interface XMPPConnection
public AbstractXMPPConnection connect() throws SmackException, IOException, XMPPException, InterruptedException
Listeners will be preserved from a previous connection.
connect()
with login()
.XMPPException
- if an error occurs on the XMPP protocol level.SmackException
- if an error occurs somewhere else besides XMPP protocol level.IOException
InterruptedException
protected abstract void connectInternal() throws SmackException, IOException, XMPPException, InterruptedException
public void login() throws XMPPException, SmackException, IOException, InterruptedException
SmackException.NoResponseException
will be thrown.
Before logging in (i.e. authenticate) to the server the connection must be connected
by calling connect()
.
It is possible to log in without sending an initial available presence by using
ConnectionConfiguration.Builder.setSendPresence(boolean)
.
Finally, if you want to not pass a password and instead use a more advanced mechanism
while using SASL then you may be interested in using
ConnectionConfiguration.Builder.setCallbackHandler(javax.security.auth.callback.CallbackHandler)
.
For more advanced login settings see ConnectionConfiguration
.
XMPPException
- if an error occurs on the XMPP protocol level.SmackException
- if an error occurs somewhere else besides XMPP protocol level.IOException
- if an I/O error occurs during login.InterruptedException
public void login(CharSequence username, String password) throws XMPPException, SmackException, IOException, InterruptedException
login(CharSequence, String, Resourcepart)
, but takes the resource from the connection
configuration.username
- password
- XMPPException
SmackException
IOException
InterruptedException
login()
public void login(CharSequence username, String password, Resourcepart resource) throws XMPPException, SmackException, IOException, InterruptedException
username
- password
- resource
- XMPPException
SmackException
IOException
InterruptedException
login()
protected abstract void loginInternal(String username, String password, Resourcepart resource) throws XMPPException, SmackException, IOException, InterruptedException
public final boolean isConnected()
XMPPConnection
isConnected
in interface XMPPConnection
public final boolean isAuthenticated()
XMPPConnection
isAuthenticated
in interface XMPPConnection
public final EntityFullJid getUser()
XMPPConnection
getUser
in interface XMPPConnection
public String getStreamId()
XMPPConnection
getStreamId
in interface XMPPConnection
protected void bindResourceAndEstablishSession(Resourcepart resource) throws XMPPException.XMPPErrorException, SmackException, InterruptedException
protected void afterSuccessfulLogin(boolean resumed) throws SmackException.NotConnectedException, InterruptedException
public final boolean isAnonymous()
XMPPConnection
isAnonymous
in interface XMPPConnection
public final String getUsedSaslMechansism()
null
if
this connection was not authenticated before.protected List<HostAddress> populateHostAddresses()
hostAddresses
with the resolved addresses or with the configured host address. If no host
address was configured and all lookups failed, for example with NX_DOMAIN, then hostAddresses
will be
populated with the empty list.protected Lock getConnectionLock()
protected void throwNotConnectedExceptionIfAppropriate() throws SmackException.NotConnectedException
protected void throwNotConnectedExceptionIfAppropriate(String optionalHint) throws SmackException.NotConnectedException
protected void throwAlreadyConnectedExceptionIfAppropriate() throws SmackException.AlreadyConnectedException
protected void throwAlreadyLoggedInExceptionIfAppropriate() throws SmackException.AlreadyLoggedInException
public void sendStanza(Stanza stanza) throws SmackException.NotConnectedException, InterruptedException
XMPPConnection
sendStanza
in interface XMPPConnection
stanza
- the stanza to send.SmackException.NotConnectedException
- if the connection is not connected.InterruptedException
protected SASLAuthentication getSASLAuthentication()
public void disconnect()
public void disconnect(Presence unavailablePresence) throws SmackException.NotConnectedException
unavailablePresence
- the optional presence stanza to send during shutdown.SmackException.NotConnectedException
protected abstract void shutdown()
public void addConnectionListener(ConnectionListener connectionListener)
XMPPConnection
addConnectionListener
in interface XMPPConnection
connectionListener
- a connection listener.public void removeConnectionListener(ConnectionListener connectionListener)
XMPPConnection
removeConnectionListener
in interface XMPPConnection
connectionListener
- a connection listener.public <I extends IQ> I sendIqRequestAndWaitForResponse(IQ request) throws SmackException.NoResponseException, XMPPException.XMPPErrorException, SmackException.NotConnectedException, InterruptedException
XMPPConnection
sendIqRequestAndWaitForResponse
in interface XMPPConnection
request
- the IQ requestSmackException.NoResponseException
XMPPException.XMPPErrorException
SmackException.NotConnectedException
InterruptedException
public StanzaCollector createStanzaCollectorAndSend(IQ packet) throws SmackException.NotConnectedException, InterruptedException
XMPPConnection
request
.
Does also send the request
IQ. The stanza filter for the collector is an
IQReplyFilter
, guaranteeing that stanza id and JID in the 'from' address have
expected values.createStanzaCollectorAndSend
in interface XMPPConnection
packet
- the IQ request to filter responses fromSmackException.NotConnectedException
InterruptedException
public StanzaCollector createStanzaCollectorAndSend(StanzaFilter packetFilter, Stanza packet) throws SmackException.NotConnectedException, InterruptedException
XMPPConnection
StanzaListener
when you need to wait for
a specific result.createStanzaCollectorAndSend
in interface XMPPConnection
packetFilter
- the stanza filter to use.packet
- the stanza to send right after the collector got createdSmackException.NotConnectedException
InterruptedException
public StanzaCollector createStanzaCollector(StanzaFilter packetFilter)
XMPPConnection
StanzaListener
when you need to wait for a specific result.
Note: If you send a Stanza right after using this method, then
consider using
XMPPConnection.createStanzaCollectorAndSend(StanzaFilter, Stanza)
instead.
Otherwise make sure cancel the StanzaCollector in every case, e.g. even
if an exception is thrown, or otherwise you may leak the StanzaCollector.
createStanzaCollector
in interface XMPPConnection
packetFilter
- the stanza filter to use.public StanzaCollector createStanzaCollector(StanzaCollector.Configuration configuration)
XMPPConnection
Please make sure to cancel the collector when it is no longer required. See also
XMPPConnection.createStanzaCollector(StanzaFilter)
.
createStanzaCollector
in interface XMPPConnection
configuration
- the stanza collector configuration.public void removeStanzaCollector(StanzaCollector collector)
XMPPConnection
removeStanzaCollector
in interface XMPPConnection
collector
- a stanza collectors which was created for this connection.public void addSyncStanzaListener(StanzaListener packetListener, StanzaFilter packetFilter)
XMPPConnection
Important: This stanza listeners will be called in the same single thread that processes all
incoming stanzas. Only use this kind of stanza filter if it does not perform any XMPP activity that waits for a
response. Consider using XMPPConnection.addAsyncStanzaListener(StanzaListener, StanzaFilter)
when possible, i.e. when
the invocation order doesn't have to be the same as the order of the arriving stanzas. If the order of the
arriving stanzas, consider using a StanzaCollector
when possible.
addSyncStanzaListener
in interface XMPPConnection
packetListener
- the stanza listener to notify of new received stanzas.packetFilter
- the stanza filter to use.XMPPConnection.addStanzaInterceptor(StanzaListener, StanzaFilter)
public boolean removeSyncStanzaListener(StanzaListener packetListener)
XMPPConnection
removeSyncStanzaListener
in interface XMPPConnection
packetListener
- the stanza listener to remove.public void addAsyncStanzaListener(StanzaListener packetListener, StanzaFilter packetFilter)
XMPPConnection
Unlike XMPPConnection.addAsyncStanzaListener(StanzaListener, StanzaFilter)
stanza listeners added with this method will be
invoked asynchronously in their own thread. Use this method if the order of the stanza listeners must not depend
on the order how the stanzas where received.
addAsyncStanzaListener
in interface XMPPConnection
packetListener
- the stanza listener to notify of new received stanzas.packetFilter
- the stanza filter to use.XMPPConnection.addStanzaInterceptor(StanzaListener, StanzaFilter)
public boolean removeAsyncStanzaListener(StanzaListener packetListener)
XMPPConnection
removeAsyncStanzaListener
in interface XMPPConnection
packetListener
- the stanza listener to remove.@Deprecated public void addPacketSendingListener(StanzaListener packetListener, StanzaFilter packetFilter)
XMPPConnection
addPacketSendingListener
in interface XMPPConnection
packetListener
- the stanza listener to notify of sent stanzas.packetFilter
- the stanza filter to use.public void addStanzaSendingListener(StanzaListener packetListener, StanzaFilter packetFilter)
XMPPConnection
addStanzaSendingListener
in interface XMPPConnection
packetListener
- the stanza listener to notify of sent stanzas.packetFilter
- the stanza filter to use.@Deprecated public void removePacketSendingListener(StanzaListener packetListener)
XMPPConnection
removePacketSendingListener
in interface XMPPConnection
packetListener
- the stanza listener to remove.public void removeStanzaSendingListener(StanzaListener packetListener)
XMPPConnection
removeStanzaSendingListener
in interface XMPPConnection
packetListener
- the stanza listener to remove.protected void firePacketSendingListeners(Stanza packet)
Compared to firePacketInterceptors(Stanza)
, the listeners will be invoked in a new thread.
packet
- the stanza to process.@Deprecated public void addPacketInterceptor(StanzaListener packetInterceptor, StanzaFilter packetFilter)
XMPPConnection
NOTE: For a similar functionality on incoming stanzas, see XMPPConnection.addAsyncStanzaListener(StanzaListener, StanzaFilter)
.
addPacketInterceptor
in interface XMPPConnection
packetInterceptor
- the stanza interceptor to notify of stanzas about to be sent.packetFilter
- the stanza filter to use.public void addStanzaInterceptor(StanzaListener packetInterceptor, StanzaFilter packetFilter)
XMPPConnection
NOTE: For a similar functionality on incoming stanzas, see XMPPConnection.addAsyncStanzaListener(StanzaListener, StanzaFilter)
.
addStanzaInterceptor
in interface XMPPConnection
packetInterceptor
- the stanza interceptor to notify of stanzas about to be sent.packetFilter
- the stanza filter to use.@Deprecated public void removePacketInterceptor(StanzaListener packetInterceptor)
XMPPConnection
removePacketInterceptor
in interface XMPPConnection
packetInterceptor
- the stanza interceptor to remove.public void removeStanzaInterceptor(StanzaListener packetInterceptor)
XMPPConnection
removeStanzaInterceptor
in interface XMPPConnection
packetInterceptor
- the stanza interceptor to remove.protected void initDebugger()
debugger
. You can specify a customized SmackDebugger
by setup the system property smack.debuggerClass
to the implementation.IllegalStateException
- if the reader or writer isn't yet initialized.IllegalArgumentException
- if the SmackDebugger can't be loaded.public long getReplyTimeout()
XMPPConnection
getReplyTimeout
in interface XMPPConnection
public void setReplyTimeout(long timeout)
XMPPConnection
SmackException.NoResponseException
if no reply to a request was received within the timeout period.setReplyTimeout
in interface XMPPConnection
timeout
- for a reply in millisecondspublic void setUnknownIqRequestReplyMode(SmackConfiguration.UnknownIqRequestReplyMode unknownIqRequestReplyMode)
unknownIqRequestReplyMode
- reply mode.protected void parseAndProcessStanza(org.xmlpull.v1.XmlPullParser parser) throws Exception
Exception
protected void processStanza(Stanza stanza) throws InterruptedException
stanza
- the stanza to process.InterruptedException
protected void invokeStanzaCollectorsAndNotifyRecvListeners(Stanza packet)
StanzaCollector.processStanza(Stanza)
for every
StanzaCollector with the given packet. Also notify the receive listeners with a matching stanza filter about the packet.
This method will be invoked by the connections incoming processing thread which may be shared across multiple connections and thus it is important that no user code, e.g. in form of a callback, is invoked by this method. For the same reason, this method must not block for an extended period of time.
packet
- the stanza to notify the StanzaCollectors and receive listeners about.protected void setWasAuthenticated()
wasAuthenticated
flag is never reset once it has ever been set.protected void callConnectionConnectedListener()
protected void callConnectionAuthenticatedListener(boolean resumed)
protected void callConnectionClosedOnErrorListener(Exception e)
public int getConnectionCounter()
XMPPConnection
getConnectionCounter
in interface XMPPConnection
public void setFromMode(XMPPConnection.FromMode fromMode)
XMPPConnection
setFromMode
in interface XMPPConnection
public XMPPConnection.FromMode getFromMode()
XMPPConnection
getFromMode
in interface XMPPConnection
XMPPConnection.FromMode
protected final void parseFeatures(org.xmlpull.v1.XmlPullParser parser) throws Exception
Exception
protected void afterFeaturesReceived() throws SmackException.SecurityRequiredException, SmackException.NotConnectedException, InterruptedException
public <F extends ExtensionElement> F getFeature(String element, String namespace)
XMPPConnection
null
if the server doesn't support that feature.getFeature
in interface XMPPConnection
F
- ExtensionElement
type of the feature.null
public boolean hasFeature(String element, String namespace)
XMPPConnection
hasFeature
in interface XMPPConnection
protected void addStreamFeature(ExtensionElement feature)
public void sendStanzaWithResponseCallback(Stanza stanza, StanzaFilter replyFilter, StanzaListener callback) throws SmackException.NotConnectedException, InterruptedException
XMPPConnection
replyFilter
.
If there is a response, then callback
will be invoked. The callback will be
invoked at most once and it will be not invoked after the connections default reply timeout
has been elapsed.
sendStanzaWithResponseCallback
in interface XMPPConnection
stanza
- the stanza to send (required)replyFilter
- the filter used to determine response stanza (required)callback
- the callback invoked if there is a response (required)SmackException.NotConnectedException
InterruptedException
public void sendStanzaWithResponseCallback(Stanza stanza, StanzaFilter replyFilter, StanzaListener callback, ExceptionCallback exceptionCallback) throws SmackException.NotConnectedException, InterruptedException
XMPPConnection
replyFilter
.
If there is a response, then callback
will be invoked. If there is no response
after the connections default reply timeout, then exceptionCallback
will be invoked
with a SmackException.NoResponseException
. The callback will be invoked at most once.
sendStanzaWithResponseCallback
in interface XMPPConnection
stanza
- the stanza to send (required)replyFilter
- the filter used to determine response stanza (required)callback
- the callback invoked if there is a response (required)exceptionCallback
- the callback invoked if there is an exception (optional)SmackException.NotConnectedException
InterruptedException
public SmackFuture<IQ,Exception> sendIqRequestAsync(IQ request)
XMPPConnection
sendIqRequestAsync
in interface XMPPConnection
request
- the IQ request to send.public SmackFuture<IQ,Exception> sendIqRequestAsync(IQ request, long timeout)
XMPPConnection
sendIqRequestAsync
in interface XMPPConnection
request
- the IQ request to send.timeout
- the reply timeout in milliseconds.public <S extends Stanza> SmackFuture<S,Exception> sendAsync(S stanza, StanzaFilter replyFilter)
XMPPConnection
sendAsync
in interface XMPPConnection
stanza
- the stanza to send.replyFilter
- the filter used for the response stanza.public <S extends Stanza> SmackFuture<S,Exception> sendAsync(S stanza, StanzaFilter replyFilter, long timeout)
XMPPConnection
sendAsync
in interface XMPPConnection
stanza
- the stanza to send.replyFilter
- the filter used for the response stanza.timeout
- the reply timeout in milliseconds.public void sendStanzaWithResponseCallback(Stanza stanza, StanzaFilter replyFilter, StanzaListener callback, ExceptionCallback exceptionCallback, long timeout) throws SmackException.NotConnectedException, InterruptedException
XMPPConnection
replyFilter
.
If there is a response, then callback
will be invoked. If there is no response
after timeout
milliseconds, then exceptionCallback
will be invoked
with a SmackException.NoResponseException
. The callback will be invoked at most once.
sendStanzaWithResponseCallback
in interface XMPPConnection
stanza
- the stanza to send (required)replyFilter
- the filter used to determine response stanza (required)callback
- the callback invoked if there is a response (required)exceptionCallback
- the callback invoked if there is an exception (optional)timeout
- the timeout in milliseconds to wait for a responseSmackException.NotConnectedException
InterruptedException
public void sendIqWithResponseCallback(IQ iqRequest, StanzaListener callback) throws SmackException.NotConnectedException, InterruptedException
XMPPConnection
callback
if there is a result of
IQ.Type.result
with that result IQ. The callback will
not be invoked after the connections default reply timeout has been elapsed.sendIqWithResponseCallback
in interface XMPPConnection
iqRequest
- the IQ stanza to send (required)callback
- the callback invoked if there is result response (required)SmackException.NotConnectedException
InterruptedException
public void sendIqWithResponseCallback(IQ iqRequest, StanzaListener callback, ExceptionCallback exceptionCallback) throws SmackException.NotConnectedException, InterruptedException
XMPPConnection
callback
if there is a result of
IQ.Type.result
with that result IQ. If there is an
error response exceptionCallback
will be invoked, if not null, with the received
error as XMPPException.XMPPErrorException
. If there is no response after the
connections default reply timeout, then exceptionCallback
will be invoked with a
SmackException.NoResponseException
.sendIqWithResponseCallback
in interface XMPPConnection
iqRequest
- the IQ stanza to send (required)callback
- the callback invoked if there is result response (required)exceptionCallback
- the callback invoked if there is an Exception optionalSmackException.NotConnectedException
InterruptedException
public void sendIqWithResponseCallback(IQ iqRequest, StanzaListener callback, ExceptionCallback exceptionCallback, long timeout) throws SmackException.NotConnectedException, InterruptedException
XMPPConnection
callback
if there is a result of
IQ.Type.result
with that result IQ. If there is an
error response exceptionCallback
will be invoked, if not null, with the received
error as XMPPException.XMPPErrorException
. If there is no response after
timeout
, then exceptionCallback
will be invoked with a
SmackException.NoResponseException
.sendIqWithResponseCallback
in interface XMPPConnection
iqRequest
- the IQ stanza to send (required)callback
- the callback invoked if there is result response (required)exceptionCallback
- the callback invoked if there is an Exception optionaltimeout
- the timeout in milliseconds to wait for a responseSmackException.NotConnectedException
InterruptedException
public void addOneTimeSyncCallback(StanzaListener callback, StanzaFilter packetFilter)
XMPPConnection
addOneTimeSyncCallback
in interface XMPPConnection
callback
- the callback invoked once the stanza filter matches a stanza.packetFilter
- the filter to match stanzas or null to match all.public IQRequestHandler registerIQRequestHandler(IQRequestHandler iqRequestHandler)
XMPPConnection
IQ request handler process incoming IQ requests, i.e. incoming IQ stanzas of type 'get' or 'set', and return a result.
registerIQRequestHandler
in interface XMPPConnection
iqRequestHandler
- the IQ request handler to register.public final IQRequestHandler unregisterIQRequestHandler(IQRequestHandler iqRequestHandler)
XMPPConnection
XMPPConnection.unregisterIQRequestHandler(String, String, org.jivesoftware.smack.packet.IQ.Type)
.unregisterIQRequestHandler
in interface XMPPConnection
public IQRequestHandler unregisterIQRequestHandler(String element, String namespace, IQ.Type type)
XMPPConnection
unregisterIQRequestHandler
in interface XMPPConnection
element
- the IQ element the IQ request handler is responsible for.namespace
- the IQ namespace the IQ request handler is responsible for.type
- the IQ type the IQ request handler is responsible for.public long getLastStanzaReceived()
XMPPConnection
getLastStanzaReceived
in interface XMPPConnection
public void setParsingExceptionCallback(ParsingExceptionCallback callback)
callback
- the callback to installpublic ParsingExceptionCallback getParsingExceptionCallback()
protected static ScheduledFuture<?> schedule(Runnable runnable, long delay, TimeUnit unit)