Package org.igniterealtime.jbosh
Class BOSHClientConnEvent
java.lang.Object
java.util.EventObject
org.igniterealtime.jbosh.BOSHClientConnEvent
- All Implemented Interfaces:
Serializable
Client connection event, notifying of changes in connection state.
This class is immutable and thread-safe.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final Throwable
Cause of the session termination, ornull
.private final boolean
Boolean flag indicating whether or not a session has been established and is currently active.private final List
<ComposableBody> List of outstanding requests which may not have been sent and/or acknowledged by the remote CM.private static final long
Serialized version.Fields inherited from class java.util.EventObject
source
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
BOSHClientConnEvent
(BOSHClient source, boolean cConnected, List<ComposableBody> cRequests, Throwable cCause) Creates a new connection event instance. -
Method Summary
Modifier and TypeMethodDescription(package private) static BOSHClientConnEvent
Creates a new successful connection closed event.(package private) static BOSHClientConnEvent
createConnectionClosedOnErrorEvent
(BOSHClient source, List<ComposableBody> outstanding, Throwable cause) Creates a connection closed on error event.(package private) static BOSHClientConnEvent
Creates a new connection establishment event.Gets the client from which this event originated.getCause()
Returns the underlying cause of the error condition.Get the list of requests which may not have been sent or were not acknowledged by the remote connection manager prior to session termination.boolean
Returns whether or not the session has been successfully established and is currently active.boolean
isError()
Returns whether or not this event indicates an error condition.Methods inherited from class java.util.EventObject
getSource, toString
-
Field Details
-
serialVersionUID
private static final long serialVersionUIDSerialized version.- See Also:
-
connected
private final boolean connectedBoolean flag indicating whether or not a session has been established and is currently active. -
requests
List of outstanding requests which may not have been sent and/or acknowledged by the remote CM. -
cause
Cause of the session termination, ornull
.
-
-
Constructor Details
-
BOSHClientConnEvent
private BOSHClientConnEvent(BOSHClient source, boolean cConnected, List<ComposableBody> cRequests, Throwable cCause) Creates a new connection event instance.- Parameters:
source
- event sourcecConnected
- flag indicating whether or not the session is currently activecRequests
- outstanding requests when an error condition is detected, ornull
when not an error conditioncCause
- cause of the error condition, ornull
when no error condition is present
-
-
Method Details
-
createConnectionEstablishedEvent
Creates a new connection establishment event.- Parameters:
source
- client which has become connected- Returns:
- event instance
-
createConnectionClosedEvent
Creates a new successful connection closed event. This represents a clean termination of the client session.- Parameters:
source
- client which has been disconnected- Returns:
- event instance
-
createConnectionClosedOnErrorEvent
static BOSHClientConnEvent createConnectionClosedOnErrorEvent(BOSHClient source, List<ComposableBody> outstanding, Throwable cause) Creates a connection closed on error event. This represents an unexpected termination of the client session.- Parameters:
source
- client which has been disconnectedoutstanding
- list of requests which may not have been received by the remote connection managercause
- cause of termination- Returns:
- event instance
-
getBOSHClient
Gets the client from which this event originated.- Returns:
- client instance
-
isConnected
public boolean isConnected()Returns whether or not the session has been successfully established and is currently active.- Returns:
true
if a session is active,false
otherwise
-
isError
public boolean isError()Returns whether or not this event indicates an error condition. This will never returntrue
whenisConnected()
returnstrue
.- Returns:
true
if the event indicates a terminal error has occurred,false
otherwise.
-
getCause
Returns the underlying cause of the error condition. This method is guaranteed to returnnull
when @{code isError()} returnsfalse
. Similarly, this method is guaranteed to return non-@{code null} ifisError()
returnstrue
.- Returns:
- underlying cause of the error condition, or
null
if this event does not represent an error condition
-
getOutstandingRequests
Get the list of requests which may not have been sent or were not acknowledged by the remote connection manager prior to session termination.- Returns:
- list of messages which may not have been received by the remote connection manager, or an empty list if the session is still connected
-