org.jivesoftware.smack

Class SynchronizationPoint<E extends Exception>

java.lang.Object

org.jivesoftware.smack.SynchronizationPoint<E>

public class SynchronizationPoint<E extends Exception>
extends Object

Constructor Summary

Constructors

Constructor and Description
SynchronizationPoint(AbstractXMPPConnection connection, String waitFor) Construct a new synchronization point for the given connection.

Method Summary

Modifier and Type	Method and Description
Exception	checkIfSuccessOrWait() Check if this synchronization point is successful or wait the connections reply timeout.
void	checkIfSuccessOrWaitOrThrow() Check if this synchronization point is successful or wait the connections reply timeout.
E	getFailureException()
void	init() Initialize (or reset) this synchronization point.
boolean	isNotInInitialState()
void	reportFailure() Deprecated. use reportFailure(Exception) instead.
void	reportFailure(E failureException) Report this synchronization point as failed because of the given exception.
void	reportGenericFailure(SmackException.SmackWrappedException exception) Report this synchronization point as failed because of the given exception.
void	reportSuccess() Report this synchronization point as successful.
boolean	requestSent() Check if this synchronization point has its request already sent.
Exception	sendAndWaitForResponse(TopLevelStreamElement request) Send the given top level stream element and wait for a response.
void	sendAndWaitForResponseOrThrow(Nonza request) Send the given plain stream element and wait for a response.
boolean	wasSuccessful() Check if this synchronization point was successful.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SynchronizationPoint

public SynchronizationPoint(AbstractXMPPConnection connection,
                            String waitFor)

Construct a new synchronization point for the given connection.

Parameters:

connection - the connection of this synchronization point.

waitFor - a description of the event this synchronization point handles.

Method Detail

init

public void init()

Initialize (or reset) this synchronization point.

sendAndWaitForResponse

public Exception sendAndWaitForResponse(TopLevelStreamElement request)
                                 throws SmackException.NoResponseException,
                                        SmackException.NotConnectedException,
                                        InterruptedException

Send the given top level stream element and wait for a response.

Parameters:

request - the plain stream element to send.

Returns:

null if synchronization point was successful, or the failure Exception.

Throws:

SmackException.NoResponseException - if no response was received.

SmackException.NotConnectedException - if the connection is not connected.

InterruptedException - if the connection is interrupted.

sendAndWaitForResponseOrThrow

public void sendAndWaitForResponseOrThrow(Nonza request)
                                   throws E extends Exception,
                                          SmackException.NoResponseException,
                                          SmackException.NotConnectedException,
                                          InterruptedException,
                                          SmackException.SmackWrappedException

Send the given plain stream element and wait for a response.

Parameters:

request - the plain stream element to send.

Throws:

E - if an failure was reported.

SmackException.NoResponseException - if no response was received.

SmackException.NotConnectedException - if the connection is not connected.

InterruptedException - if the connection is interrupted.

SmackException.SmackWrappedException - in case of a wrapped exception;

E extends Exception

checkIfSuccessOrWaitOrThrow

public void checkIfSuccessOrWaitOrThrow()
                                 throws SmackException.NoResponseException,
                                        E extends Exception,
                                        InterruptedException,
                                        SmackException.SmackWrappedException

Check if this synchronization point is successful or wait the connections reply timeout.

Throws:

SmackException.NoResponseException - if there was no response marking the synchronization point as success or failed.

E - if there was a failure

InterruptedException - if the connection is interrupted.

SmackException.SmackWrappedException - in case of a wrapped exception;

E extends Exception

checkIfSuccessOrWait

public Exception checkIfSuccessOrWait()
                               throws SmackException.NoResponseException,
                                      InterruptedException

Check if this synchronization point is successful or wait the connections reply timeout.

Returns:

null if synchronization point was successful, or the failure Exception.

Throws:

SmackException.NoResponseException - if there was no response marking the synchronization point as success or failed.

InterruptedException

reportSuccess

public void reportSuccess()

Report this synchronization point as successful.

reportFailure

@Deprecated
public void reportFailure()

Deprecated. use reportFailure(Exception) instead.

Deprecated.

reportFailure

public void reportFailure(E failureException)

Report this synchronization point as failed because of the given exception. The failureException must be set.

Parameters:

failureException - the exception causing this synchronization point to fail.

reportGenericFailure

public void reportGenericFailure(SmackException.SmackWrappedException exception)

Report this synchronization point as failed because of the given exception. The failureException must be set.

Parameters:

exception - the exception causing this synchronization point to fail.

wasSuccessful

public boolean wasSuccessful()

Check if this synchronization point was successful.

Returns:

true if the synchronization point was successful, false otherwise.

isNotInInitialState

public boolean isNotInInitialState()

requestSent

public boolean requestSent()

Check if this synchronization point has its request already sent.

Returns:

true if the request was already sent, false otherwise.

getFailureException

public E getFailureException()