Element Summary

ElementDescriptionClass
componentXMPP Componentorg.apache.servicemix.xmpp.XMPPComponent
receiverThis endpoint receives XMPP messages and events and sends them as xml message into the NMR to the defined targetorg.apache.servicemix.xmpp.XMPPReceiverEndpoint
senderThis endpoint sends XMPP messages from the NMR to a specified target (user or room)org.apache.servicemix.xmpp.XMPPSenderEndpoint

Element Detail

Element: component

ElementTypeDescription
endpoints(receiver | sender)*
executorFactory<spring:bean/>The executor factory to use to create the executor. If none is provided, one will be retrieved from the JBI container when the component is deployed into ServiceMix 3.x, or a default implementation will be used.

Element: receiver

AttributeTypeDescription
createAccountxs:boolean

Specify here if you want to create an account for the user if the user is currently not existing on the XMPP server.

endpointxs:string

Get the endpoint implementation.

hostxs:string

With that method you can specify the host name of the XMPP server as hostname or ip address.

interfaceNamexs:QName

Get the qualified name of the endpoint interface.

loginxs:boolean

Here you can specify if the user should login to the server or not. Not logging in means that endpoint itself will be created but it will be inactive.

passwordxs:string

This method sets the password for connecting to the XMPP server.

portxs:integer

This method will set the port number for the XMPP connection. If nothing is defined the default XMPP port number 5222 will be used.

proxyHostxs:string

Here you can specify the hostname or ip address of a proxy to be used to connect to the XMPP server. If you don't define this no proxy is used.

proxyPassxs:string

If your proxy needs authentication you can specify here the user password. Leave this undefined if your proxy does not need authentication.

proxyPortxs:string

Here you can specify the port of the proxy server. If you do not define this the default port (3128) will be used.

proxyTypexs:string

Here you can specify the type of proxy you have. Possible values are: NONE, HTTP, SOCKS4, SOCKS5

proxyUserxs:string

If your proxy needs authentication you can specify here the user name. Leave this undefined if your proxy does not need authentication.

resourcexs:string

Specify here the resource string to submit to the XMPP server. Usually you define the identifier of the XMPP client here.

roomxs:string

Specify here an optional room to join. If set, the user will join that room and listens to messages there.

servicexs:QName

Get the service qualified name of the endpoint.

targetEndpointxs:stringthe name of the endpoint to which requests are sent
targetInterfacexs:QNamethe QName of the interface to which requests are sent
targetOperationxs:QNamethe QName of the operation to which requests are sent
targetServicexs:QNamethe QName of the service to which requests are sent
targetUrixs:string

Gets the target URI of the consumer endpoint.

userxs:string

This method if used to specify the user name to use for connecting to the XMPP server. It is not required that this user already exists but if not then the server should allow registration of new users and this user should not already exist with another password.

ElementTypeDescription
filter<spring:bean/>

Here you can define a PacketFilter to use for filtering XMPP packets.

marshaler<spring:bean/>

With this method you can specify a marshaler class which provides the logic for converting an xmpp message into a normalized message. This class has to implement the interface XMPPMarshalerSupport or another class which implements it. If you don't specify a marshaler, the DefaultXMPPMarshaler will be used.

Element: sender

AttributeTypeDescription
createAccountxs:boolean

Specify here if you want to create an account for the user if the user is currently not existing on the XMPP server.

endpointxs:string

Get the endpoint implementation.

hostxs:string

With that method you can specify the host name of the XMPP server as hostname or ip address.

interfaceNamexs:QName

Get the qualified name of the endpoint interface.

loginxs:boolean

Here you can specify if the user should login to the server or not. Not logging in means that endpoint itself will be created but it will be inactive.

participantxs:string

Specify here an optional participant to send messages to. You have to define a room or participant in order to have send function working.

passwordxs:string

This method sets the password for connecting to the XMPP server.

portxs:integer

This method will set the port number for the XMPP connection. If nothing is defined the default XMPP port number 5222 will be used.

proxyHostxs:string

Here you can specify the hostname or ip address of a proxy to be used to connect to the XMPP server. If you don't define this no proxy is used.

proxyPassxs:string

If your proxy needs authentication you can specify here the user password. Leave this undefined if your proxy does not need authentication.

proxyPortxs:string

Here you can specify the port of the proxy server. If you do not define this the default port (3128) will be used.

proxyTypexs:string

Here you can specify the type of proxy you have. Possible values are: NONE, HTTP, SOCKS4, SOCKS5

proxyUserxs:string

If your proxy needs authentication you can specify here the user name. Leave this undefined if your proxy does not need authentication.

resourcexs:string

Specify here the resource string to submit to the XMPP server. Usually you define the identifier of the XMPP client here.

roomxs:string

Specify here an optional room to join. If set, the user will join that room and listens to messages there.

servicexs:QName

Get the service qualified name of the endpoint.

userxs:string

This method if used to specify the user name to use for connecting to the XMPP server. It is not required that this user already exists but if not then the server should allow registration of new users and this user should not already exist with another password.

ElementTypeDescription
marshaler<spring:bean/>

With this method you can specify a marshaler class which provides the logic for converting an xmpp message into a normalized message. This class has to implement the interface XMPPMarshalerSupport or another class which implements it. If you don't specify a marshaler, the DefaultXMPPMarshaler will be used.