com.realtime.xmpp.dom
Class DomComponent

java.lang.Object
  |
  +--com.realtime.xmpp.util.RestartingEndpoint
        |
        +--com.realtime.xmpp.dom.DomComponent

All Implemented Interfaces:

XmppEndpoint

Direct Known Subclasses:

DomAcceptComponent

public class DomComponent

extends RestartingEndpoint

Provide a Jabber component that generates DOM packets on incoming requests.

Provides convenience methods such as send() and reply() for sending XMPP packets.

Version:

1.0

Author:

Mike Prince

Field Summary

protected Xmpp2DomTransformer

m_transformer The XMPP to DOM transformer.

Fields inherited from class com.realtime.xmpp.util.RestartingEndpoint

m_session, m_sessionRestarter, XMPP_REQUEST_TIMEOUT

Constructor Summary

DomComponent(java.lang.String sHost, int nPort, java.lang.String sNamespace)
Create a component that generates DOM packets on incoming messages.

DomComponent(XmlStreamFactory streamFactory, java.lang.String sNamespace)
Create a component that generates DOM packets on incoming messages.

Method Summary

Xmpp2DomTransformer	getDomTransformer() Provide our DOM transformer.
org.dom4j.Element	query(XmppQuery request) Provide a synchronous send() method.
void	send(XmppStanza packet) Send a packet to the Jabber server.

Methods inherited from class com.realtime.xmpp.util.RestartingEndpoint

fastStart, getComponentName, getSession, start, stop

Methods inherited from class java.lang.Object

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

Field Detail

m_transformer

protected Xmpp2DomTransformer m_transformer

The XMPP to DOM transformer.

Constructor Detail

DomComponent

public DomComponent(XmlStreamFactory streamFactory,
                    java.lang.String sNamespace)

Create a component that generates DOM packets on incoming messages. This component does not do authentication.

Parameters:

streamFactory - An XML stream factory.

sNamespace - The namespace to use.

DomComponent

public DomComponent(java.lang.String sHost,
                    int nPort,
                    java.lang.String sNamespace)

Create a component that generates DOM packets on incoming messages. This component does not do authentication.

Parameters:

sHost - The host name to connect to.

nPort - The server port to connect to.

sNamespace - The namespace to use.

Method Detail

getDomTransformer

public Xmpp2DomTransformer getDomTransformer()

Provide our DOM transformer.

Returns:

The DOM packet transformer.

query

public org.dom4j.Element query(XmppQuery request)
                        throws java.io.IOException

Provide a synchronous send() method. Uses the DomPacketSenders default timeout.

Parameters:

request - The XMPP request.

Returns:

The matching XMPP response (based on the packet id), or null if no packet was returned.

Throws:

java.io.IOException - Generated when there are problems with the XMPP session.

send

public void send(XmppStanza packet)
          throws java.io.IOException

Send a packet to the Jabber server. This method does not wait for a response.

Parameters:

packet - The packet to send.

Throws:

java.io.IOException - Generated when there are problems writing to the stream.