XmppConnector (Mule ESB 2.2.1 API)
Keywords: org.mule.transport.xmpp.XmppConnector class

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.mule.transport.xmpp
Class XmppConnector

    java.lang.Object
      org.mule.transport.AbstractConnector
          org.mule.transport.xmpp.XmppConnector

All Implemented Interfaces:
  ExceptionListener, EventListener, javax.resource.spi.work.WorkListener, MuleContextAware, Disposable, Initialisable, Lifecycle, Startable, Stoppable, NamedObject, Connectable, Connector

Direct Known Subclasses:
  XmppsConnector

    public class XmppConnector

extends AbstractConnector

`XmppConnector` TODO

Field Summary
`static String` | `XMPP`
`static String` | `XMPP_FROM`
`static String` | `XMPP_GROUP_CHAT`
`static String` | `XMPP_NICKNAME`
`static String` | `XMPP_PROPERTY_PREFIX`
`static String` | `XMPP_RESOURCE`
`static String` | `XMPP_SUBJECT`
`static String` | `XMPP_THREAD`
`static String` | `XMPP_TO`

Fields inherited from class org.mule.transport.AbstractConnector
`connected, createMultipleTransactedReceivers, DEFAULT_NUM_CONCURRENT_TX_RECEIVERS, dispatcherFactory, dispatchers, disposed, exceptionListener, initialised, logger, muleContext, name, numberOfConcurrentTransactedReceivers, receivers, requesterFactory, requesters, serviceDescriptor, serviceOverrides, sessionHandler, started, startOnConnect`

Fields inherited from interface org.mule.api.transport.Connector
`INT_VALUE_NOT_SET`

Fields inherited from interface org.mule.api.lifecycle.Initialisable
`PHASE_NAME`

Fields inherited from interface org.mule.api.lifecycle.Startable
`PHASE_NAME`

Fields inherited from interface org.mule.api.lifecycle.Stoppable
`PHASE_NAME`

Fields inherited from interface org.mule.api.lifecycle.Disposable
`PHASE_NAME`

Constructor Summary
`XmppConnector()`

Method Summary
`org.jivesoftware.smack.XMPPConnection` | `createXmppConnection(EndpointURI endpointURI)`
`protected void` | `doConnect()` Template method where any connections should be made for the connector
`protected org.jivesoftware.smack.XMPPConnection` | `doCreateXmppConnection(EndpointURI endpointURI)` This method creates and returns the `XMPPConnection` object that's uses to talk to the Jabber server.
`protected void` | `doDisconnect()` Template method where any connected resources used by the connector should be disconnected
`protected void` | `doDispose()` Template method to perform any work when destroying the connectoe
`protected void` | `doInitialise()`
`protected void` | `doStart()` Template method to perform any work when starting the connectoe
`protected void` | `doStop()` Template method to perform any work when stopping the connectoe
`String` | `getProtocol()`
`boolean` | `isResponseEnabled()`

Methods inherited from class org.mule.transport.AbstractConnector
`checkDisposed, connect, createReceiver, destroyReceiver, disconnect, dispatch, dispose, disposeDispatchers, disposeReceivers, disposeRequesters, disposeWorkManagers, exceptionThrown, fireNotification, getConnectEventId, getConnectionDescription, getDefaultInboundTransformers, getDefaultOutboundTransformers, getDefaultResponseTransformers, getDispatcherFactory, getDispatcherThreadingProfile, getDispatcherWorkManager, getExceptionListener, getMaxDispatchersActive, getMaxRequestersActive, getMessageAdapter, getMuleContext, getName, getNumberOfConcurrentTransactedReceivers, getOutputStream, getReceiver, getReceiverKey, getReceivers, getReceivers, getReceiverThreadingProfile, getReceiverWorkManager, getReplyToHandler, getRequesterFactory, getRequesterThreadingProfile, getRequesterWorkManager, getRetryPolicyTemplate, getScheduler, getServiceDescriptor, getServiceOverrides, getSessionHandler, getSupportedProtocols, handleException, handleException, handleWorkException, initFromServiceDescriptor, initialise, initialiseFromUrl, initWorkManagers, isConnected, isCreateMultipleTransactedReceivers, isDisposed, isEnableMessageEvents, isStarted, isSyncEnabled, isValidateConnections, lookupReceiver, registerListener, registerSupportedProtocol, registerSupportedProtocolWithoutPrefix, request, request, send, setConnected, setCreateMultipleTransactedReceivers, setDispatcherFactory, setDispatcherThreadingProfile, setDynamicNotification, setExceptionListener, setMaxDispatchersActive, setMaxRequestersActive, setMuleContext, setName, setNumberOfConcurrentTransactedReceivers, setReceiverThreadingProfile, setRequesterFactory, setRequesterThreadingProfile, setRetryPolicyTemplate, setServiceOverrides, setSessionHandler, setSupportedProtocols, setupDispatchReturn, setupRequestReturn, setValidateConnections, start, stop, supportsProtocol, toString, unregisterListener, unregisterSupportedProtocol, updateCachedNotificationHandler, validateConnection, workAccepted, workCompleted, workRejected, workStarted`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Field Detail

### XMPP

    public static final String XMPP

See Also:
  Constant Field Values

### XMPP_PROPERTY_PREFIX

    public static final String XMPP_PROPERTY_PREFIX

See Also:
  Constant Field Values

### XMPP_RESOURCE

    public static final String XMPP_RESOURCE

See Also:
  Constant Field Values

### XMPP_SUBJECT

    public static final String XMPP_SUBJECT

See Also:
  Constant Field Values

### XMPP_THREAD

    public static final String XMPP_THREAD

See Also:
  Constant Field Values

### XMPP_TO

    public static final String XMPP_TO

See Also:
  Constant Field Values

### XMPP_FROM

    public static final String XMPP_FROM

See Also:
  Constant Field Values

### XMPP_GROUP_CHAT

    public static final String XMPP_GROUP_CHAT

See Also:
  Constant Field Values

### XMPP_NICKNAME

    public static final String XMPP_NICKNAME

See Also:
  Constant Field Values

Constructor Detail

### XmppConnector

    public XmppConnector()

Method Detail

### doInitialise

    protected void doInitialise()
                         throws InitialisationException

  Specified by:
    `doInitialise` in class `AbstractConnector`
  Throws:
    `InitialisationException`

### doDispose

    protected void doDispose()

  Description copied from class: `AbstractConnector`
  Template method to perform any work when destroying the connectoe

  Specified by:
    `doDispose` in class `AbstractConnector`

### doConnect

    protected void doConnect()
                      throws Exception

  Description copied from class: `AbstractConnector`
  Template method where any connections should be made for the connector

  Specified by:
    `doConnect` in class `AbstractConnector`
  Throws:
    `Exception`

### doDisconnect

    protected void doDisconnect()
                         throws Exception

  Description copied from class: `AbstractConnector`
  Template method where any connected resources used by the connector should be disconnected

  Specified by:
    `doDisconnect` in class `AbstractConnector`
  Throws:
    `Exception`

### doStart

    protected void doStart()
                    throws MuleException

  Description copied from class: `AbstractConnector`
  Template method to perform any work when starting the connectoe

  Specified by:
    `doStart` in class `AbstractConnector`
  Throws:
    `MuleException` - if the method fails

### doStop

    protected void doStop()
                   throws MuleException

  Description copied from class: `AbstractConnector`
  Template method to perform any work when stopping the connectoe

  Specified by:
    `doStop` in class `AbstractConnector`
  Throws:
    `MuleException` - if the method fails

### getProtocol

    public String getProtocol()

  Returns:
    the primary protocol name for endpoints of this connector

### createXmppConnection

    public org.jivesoftware.smack.XMPPConnection createXmppConnection(EndpointURI endpointURI)
                                                               throws org.jivesoftware.smack.XMPPException

  Throws:
    `org.jivesoftware.smack.XMPPException`

### doCreateXmppConnection

    protected org.jivesoftware.smack.XMPPConnection doCreateXmppConnection(EndpointURI endpointURI)
                                                                    throws org.jivesoftware.smack.XMPPException

  This method creates and returns the `XMPPConnection` object that's uses to talk to the Jabber server.

  Subclasses can override this method to create a more specialized `XMPPConnection`.

  Parameters:
    `endpointURI` -
  Returns:
  Throws:
    `org.jivesoftware.smack.XMPPException`

### isResponseEnabled

    public boolean isResponseEnabled()

  Specified by:
    `isResponseEnabled` in interface `Connector`
  Overrides:
    `isResponseEnabled` in class `AbstractConnector`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2003-2009 MuleSource, Inc.. All Rights Reserved.