Package org.igniterealtime.jbosh
Core classes of the JBOSH API.
Users of the client portion of the API should start by reading
up on the
BOSHClient documentation.-
Interface Summary Interface Description BodyParser Interface for parser implementations to implement in order to abstract the business of XML parsing out of the Body class.BOSHClientConnListener Interface used by parties interested in monitoring the connection state of a client session.BOSHClientRequestListener Interface used by parties interested in monitoring outbound requests made by the client to the connection manager (CM).BOSHClientResponseListener Interface used by parties interested in monitoring inbound responses to the client from the connection manager (CM).HTTPResponse This class represents a complete HTTP response to a request made via aHTTPSendersend request.HTTPSender Interface used to represent code which can send a BOSH XML body over HTTP to a connection manager. -
Class Summary Class Description AbstractAttr<T extends java.lang.Comparable> Abstract base class for creating BOSH attribute classes.AbstractBody Class representing a single message to or from the BOSH connection manager (CM).AbstractIntegerAttr Abstract base class for attribute implementations based onIntegertypes.ApacheHTTPResponse ApacheHTTPSender Implementation of theHTTPSenderinterface which uses the Apache HttpClient API to send messages to the connection manager.AttrAccept Data type representing the getValue of theacceptattribute of theboshelement.AttrAck Data type representing the getValue of theackattribute of theboshelement.AttrCharsets Data type representing the getValue of thecharsetsattribute of theboshelement.AttrHold Data type representing the getValue of theholdattribute of theboshelement.Attributes Class containing constants for attribute definitions used by the XEP-0124 specification.AttrInactivity Data type representing the value of theinactivityattribute of theboshelement.AttrMaxPause Data type representing the getValue of themaxpauseattribute of theboshelement.AttrPause Data type representing the getValue of thepauseattribute of theboshelement.AttrPolling Data type representing the getValue of thepollingattribute of theboshelement.AttrRequests Data type representing the value of therequestsattribute of theboshelement.AttrSessionID Data type representing the getValue of thesidattribute of theboshelement.AttrVersion Data type representing the getValue of theverattribute of theboshelement.AttrWait Data type representing the getValue of thewaitattribute of theboshelement.BodyParserResults Data extracted from a raw XML message by a BodyParser implementation.BodyParserSAX Implementation of the BodyParser interface which uses the SAX API that is part of the JDK.BodyParserSAX.Handler SAX event handler class.BodyParserXmlPull Implementation of the BodyParser interface which uses the XmlPullParser API.BodyQName Qualified name of an attribute of the wrapper element.BOSHClient BOSH Client session instance.BOSHClient.ExchangeInterceptor Class used in testing to dynamically manipulate received exchanges at test runtime.BOSHClientConfig BOSH client configuration information.BOSHClientConfig.Builder Class instance builder, after the builder pattern.BOSHClientConnEvent Client connection event, notifying of changes in connection state.BOSHMessageEvent Event representing a message sent to or from a BOSH connection manager.CMSessionParams A BOSH connection manager session instance.ComposableBody Implementation of theAbstractBodyclass which allows for the definition of messages from individual elements of a body.ComposableBody.Builder Class instance builder, after the builder pattern.GZIPCodec Codec methods for compressing and uncompressing using GZIP.HTTPExchange A request and response pair representing a single exchange with a remote content manager.RequestIDSequence Request ID sequence generator.ServiceLib Utility library for use in loading services using the Jar Service Provider Interface (Jar SPI).StaticBody Implementation of theAbstractBodyclass which allows for the definition of messages from pre-existing message content.TerminalBindingCondition Terminal binding conditions and their associated messages.ZLIBCodec Codec methods for compressing and uncompressing using ZLIB. -
Exception Summary Exception Description BOSHException Exception class used by the BOSH API to minimize the number of checked exceptions which must be handled by the user of the API.