rocks.xmpp.extensions.component.accept

Class ExternalComponent

java.lang.Object

rocks.xmpp.core.session.XmppSession

rocks.xmpp.extensions.component.accept.ExternalComponent

All Implemented Interfaces:

AutoCloseable

public final class ExternalComponent
extends XmppSession

An external component session which connects to an XMPP server using the "Jabber Component Protocol".

See Also:

XEP-0114: Jabber Component Protocol

Nested Class Summary

Nested classes/interfaces inherited from class rocks.xmpp.core.session.XmppSession

XmppSession.Status

Constructor Summary

Constructors

Constructor and Description
ExternalComponent(String componentName, String sharedSecret, String hostname, int port) Deprecated.
ExternalComponent(String componentName, String sharedSecret, XmppSessionConfiguration configuration, String hostname, int port) Deprecated.

Method Summary

Modifier and Type	Method and Description
void	connect(rocks.xmpp.addr.Jid from)
static ExternalComponent	create(String componentName, String sharedSecret, String hostname, int port) Creates a new external component using a default configuration.
static ExternalComponent	create(String componentName, String sharedSecret, XmppSessionConfiguration configuration, String hostname, int port) Creates a new external component.
rocks.xmpp.addr.Jid	getConnectedResource() The connected resource, which is assigned by the server.
boolean	handleElement(Object element) Handles an XMPP element.
void	notifyException(Throwable e) Called if any unhandled exception is thrown during reading or writing.
Future<?>	send(StreamElement element) Sends an XML element to the server, usually a stanza, i.e. a message, presence or IQ.
SendTask<IQ>	sendIQ(IQ iq) Sends an IQ.
SendTask<Message>	sendMessage(Message message) Sends a message.
SendTask<Presence>	sendPresence(Presence presence) Sends a presence.

Methods inherited from class rocks.xmpp.core.session.XmppSession

addConnectionListener, addCreationListener, addInboundIQListener, addInboundMessageListener, addInboundPresenceListener, addIQHandler, addIQHandler, addMessageAcknowledgedListener, addOutboundIQListener, addOutboundMessageListener, addOutboundPresenceListener, addSessionStatusListener, close, connect, createMarshaller, createUnmarshaller, disableFeature, disableFeature, enableFeature, enableFeature, getActiveConnection, getConfiguration, getConnections, getDebugger, getDomain, getEnabledFeatures, getManager, getStatus, getUnacknowledgedStanzas, isAuthenticated, isConnected, markAcknowledged, query, query, query, removeConnectionListener, removeCreationListener, removeInboundIQListener, removeInboundMessageListener, removeInboundPresenceListener, removeIQHandler, removeMessageAcknowledgedListener, removeOutboundIQListener, removeOutboundMessageListener, removeOutboundPresenceListener, removeSessionStatusListener, sendAndAwaitMessage, sendAndAwaitPresence

Methods inherited from class java.lang.Object

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

Constructor Detail

ExternalComponent

@Deprecated
public ExternalComponent(String componentName,
                                     String sharedSecret,
                                     String hostname,
                                     int port)

Deprecated.

ExternalComponent

@Deprecated
public ExternalComponent(String componentName,
                                     String sharedSecret,
                                     XmppSessionConfiguration configuration,
                                     String hostname,
                                     int port)

Deprecated.

Method Detail

create

public static ExternalComponent create(String componentName,
                                       String sharedSecret,
                                       String hostname,
                                       int port)

Creates a new external component using a default configuration. Any registered creation listeners are triggered.

Parameters:

componentName - The component name.

sharedSecret - The shared secret (password).

hostname - The hostname to connect to.

port - The port to connect to.

Returns:

The external component.

create

public static ExternalComponent create(String componentName,
                                       String sharedSecret,
                                       XmppSessionConfiguration configuration,
                                       String hostname,
                                       int port)

Creates a new external component. Any registered creation listeners are triggered.

Parameters:

componentName - The component name.

sharedSecret - The shared secret (password).

configuration - The configuration.

hostname - The hostname to connect to.

port - The port to connect to.

Returns:

The external component.

connect

public final void connect(rocks.xmpp.addr.Jid from)
                   throws XmppException

Specified by:

connect in class XmppSession

Throws:

XmppException

handleElement

public final boolean handleElement(Object element)
                            throws XmppException

Description copied from class: XmppSession

Handles an XMPP element.

This method should be called on the reader thread.

Overrides:

handleElement in class XmppSession

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(Throwable e)

Description copied from class: XmppSession

Called if any unhandled exception is thrown during reading or writing.

This method will close the stream.

Overrides:

notifyException in class XmppSession

Parameters:

e - The exception. If an unrecoverable XMPP stream error occurred, the exception is a StreamError.

getConnectedResource

public final rocks.xmpp.addr.Jid getConnectedResource()

Description copied from class: XmppSession

The connected resource, which is assigned by the server.

Specified by:

getConnectedResource in class XmppSession

Returns:

The connected resource.

send

public final Future<?> send(StreamElement element)

Description copied from class: XmppSession

Sends an XML element to the server, usually a stanza, i.e. a message, presence or IQ.

Overrides:

send in class XmppSession

Parameters:

element - The XML element.

Returns:

The sent stream element, which is usually the same as the parameter, but may differ in case a stanza is sent, e.g. a Message is translated to a ClientMessage.

sendIQ

public final SendTask<IQ> sendIQ(IQ iq)

Description copied from class: XmppSession

Sends an IQ.

Specified by:

sendIQ in class XmppSession

Parameters:

iq - The IQ.

Returns:

The send task, which allows to track the stanza.

sendMessage

public final SendTask<Message> sendMessage(Message message)

Description copied from class: XmppSession

Sends a message.

Specified by:

sendMessage in class XmppSession

Parameters:

message - The message.

Returns:

The send task, which allows to track the stanza.

sendPresence

public final SendTask<Presence> sendPresence(Presence presence)

Description copied from class: XmppSession

Sends a presence.

Specified by:

sendPresence in class XmppSession

Parameters:

presence - The presence.

Returns:

The send task, which allows to track the stanza.