JBI Support deprecated in Apache ServiceMix 4
JBI 1.0 support is available in Apache ServiceMix 4 to allow existing users to migrate more easily to this latest version - if you're a new user, you should consider JBI deprecated and not use it for your project. Take a look at our technology selection guidelines for more information.
servicemix-xmpp
Overview
The ServiceMix XMPP component is used to communicate with XMPP (Jabber) servers through the JBI bus.
xmpp:receiver
Endpoint properties
| Property Name | Type | Description |
|---|---|---|
| createAccount | boolean | <p>Specify here if you want to create an account for the user if the user is currently not existing on the XMPP server.</p> |
| endpoint | java.lang.String | The name of the endpoint. |
| filter | org.jivesoftware.smack.filter.PacketFilter | <p>Here you can define a <code>PacketFilter</code> to use for filtering XMPP packets. |
| host | java.lang.String | <p>With that method you can specify the host name of the XMPP server as hostname or ip address.</p> |
| interfaceName | javax.xml.namespace.QName | The qualified name of the interface exposed by the endpoint. |
| login | boolean | <p>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.</p> |
| marshaler | org.apache.servicemix.xmpp.marshaler.XMPPMarshalerSupport | <p>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 <code>XMPPMarshalerSupport</code> or another class which implements it. If you don't specify a marshaler, the <code>DefaultXMPPMarshaler</code> will be used.</p> |
| password | java.lang.String | <p>This method sets the password for connecting to the XMPP server.</p> |
| port | int | <p>This method will set the port number for the XMPP connection. If nothing is defined the default XMPP port number 5222 will be used.</p> |
| proxyHost | java.lang.String | <p>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.</p> |
| proxyPass | java.lang.String | <p>If your proxy needs authentication you can specify here the user password. Leave this undefined if your proxy does not need authentication.</p> |
| proxyPort | java.lang.String | <p>Here you can specify the port of the proxy server. If you do not define this the default port (3128) will be used. |
| proxyType | java.lang.String | <p>Here you can specify the type of proxy you have. Possible values are: <code>NONE</code>, <code>HTTP</code>, <code>SOCKS4</code>, <code>SOCKS5</code> |
| proxyUser | java.lang.String | <p>If your proxy needs authentication you can specify here the user name. Leave this undefined if your proxy does not need authentication.</p> |
| resource | java.lang.String | <p>Specify here the resource string to submit to the XMPP server. Usually you define the identifier of the XMPP client here.</p> |
| room | java.lang.String | <p>Specify here an optional room to join. If set, the user will join that room and listens to messages there.</p> |
| service | javax.xml.namespace.QName | The qualified name of the service the endpoint exposes. |
| targetEndpoint | java.lang.String | the name of the endpoint to which requests are sent |
| targetInterface | javax.xml.namespace.QName | the QName of the interface to which requests are sent |
| targetOperation | javax.xml.namespace.QName | the QName of the operation to which requests are sent |
| targetService | javax.xml.namespace.QName | the QName of the service to which requests are sent |
| targetUri | java.lang.String | Set the target service/endpoint/interface using a URI. |
| user | java.lang.String | <p>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.</p> |
xmpp:sender
Endpoint properties
| Property Name | Type | Description |
|---|---|---|
| createAccount | boolean | <p>Specify here if you want to create an account for the user if the user is currently not existing on the XMPP server.</p> |
| endpoint | java.lang.String | The name of the endpoint. |
| host | java.lang.String | <p>With that method you can specify the host name of the XMPP server as hostname or ip address.</p> |
| interfaceName | javax.xml.namespace.QName | The qualified name of the interface exposed by the endpoint. |
| login | boolean | <p>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.</p> |
| marshaler | org.apache.servicemix.xmpp.marshaler.XMPPMarshalerSupport | <p>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 <code>XMPPMarshalerSupport</code> or another class which implements it. If you don't specify a marshaler, the <code>DefaultXMPPMarshaler</code> will be used.</p> |
| participant | java.lang.String | <p>Specify here an optional participant to send messages to. You have to define a room or participant in order to have send function working.</p> |
| password | java.lang.String | <p>This method sets the password for connecting to the XMPP server.</p> |
| port | int | <p>This method will set the port number for the XMPP connection. If nothing is defined the default XMPP port number 5222 will be used.</p> |
| proxyHost | java.lang.String | <p>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.</p> |
| proxyPass | java.lang.String | <p>If your proxy needs authentication you can specify here the user password. Leave this undefined if your proxy does not need authentication.</p> |
| proxyPort | java.lang.String | <p>Here you can specify the port of the proxy server. If you do not define this the default port (3128) will be used. |
| proxyType | java.lang.String | <p>Here you can specify the type of proxy you have. Possible values are: <code>NONE</code>, <code>HTTP</code>, <code>SOCKS4</code>, <code>SOCKS5</code> |
| proxyUser | java.lang.String | <p>If your proxy needs authentication you can specify here the user name. Leave this undefined if your proxy does not need authentication.</p> |
| resource | java.lang.String | <p>Specify here the resource string to submit to the XMPP server. Usually you define the identifier of the XMPP client here.</p> |
| room | java.lang.String | <p>Specify here an optional room to join. If set, the user will join that room and listens to messages there.</p> |
| service | javax.xml.namespace.QName | The qualified name of the service the endpoint exposes. |
| user | java.lang.String | <p>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.</p> |