org.apache.servicemix.smpp
Class SmppConsumerEndpoint

java.lang.Object
  org.apache.servicemix.common.endpoints.AbstractEndpoint
      org.apache.servicemix.common.endpoints.SimpleEndpoint
          org.apache.servicemix.common.endpoints.ConsumerEndpoint
              org.apache.servicemix.smpp.SmppConsumerEndpoint

All Implemented Interfaces:

Endpoint, SmppEndpointType

public class SmppConsumerEndpoint
extends ConsumerEndpoint
implements SmppEndpointType

A polling component which bind with jSMPP and receive SMPP messages and sends the SMPPs into the JBI bus as messages.

Author:

jbonofre, lhein

Field Summary

Fields inherited from class org.apache.servicemix.common.endpoints.AbstractEndpoint

definition, description, endpoint, interfaceName, logger, service, serviceUnit

Constructor Summary

SmppConsumerEndpoint()

Method Summary

int	getEnquireLinkTimer()
java.lang.String	getHost()
SmppMarshalerSupport	getMarshaler()
java.lang.String	getPassword()
int	getPort()
java.lang.String	getSystemId()
int	getTransactionTimer()
void	process(javax.jbi.messaging.MessageExchange exchange)
void	setEnquireLinkTimer(int enquireLinkTimer) This attribute specifies the enquire link timer defining the SMSC time interval.
void	setHost(java.lang.String host) This attribute specifies the host name to use for connecting to the server. The default value is null
void	setMarshaler(SmppMarshalerSupport marshaler) With this method you can specify a marshaler class which provides the logic for converting a sms message into a normalized message.
void	setPassword(java.lang.String password) This attribute specifies the password to use for connecting to the server. The default value is null
void	setPort(int port) This attribute specifies the port number to use for connecting to the server. The default value is 2775
void	setSystemId(java.lang.String systemId) This attribute specifies the system id to use for connecting to the server. The default value is null
void	setTransactionTimer(int transactionTimer) This attribute specifies the transaction timer defining the SMSC timeout.
void	start()
void	stop()
void	validate()

Methods inherited from class org.apache.servicemix.common.endpoints.ConsumerEndpoint

activate, configureExchangeTarget, deactivate, getLocationURI, getRole, getTargetEndpoint, getTargetInterface, getTargetOperation, getTargetService, getTargetUri, setTargetEndpoint, setTargetInterface, setTargetOperation, setTargetService, setTargetUri

Methods inherited from class org.apache.servicemix.common.endpoints.SimpleEndpoint

done, fail, getChannel, getContext, getExchangeFactory, send, sendSync

Methods inherited from class org.apache.servicemix.common.endpoints.AbstractEndpoint

getDefinition, getDescription, getEndpoint, getInterfaceName, getKey, getService, getServiceUnit, isExchangeOkay, prepareExchange, setDefinition, setDescription, setEndpoint, setInterfaceName, setService, setServiceUnit, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SmppConsumerEndpoint

public SmppConsumerEndpoint()

Method Detail

start

public void start()
           throws java.lang.Exception

Specified by:

start in interface Endpoint

Overrides:

start in class SimpleEndpoint

Throws:

java.lang.Exception

stop

public void stop()
          throws java.lang.Exception

Specified by:

stop in interface Endpoint

Overrides:

stop in class SimpleEndpoint

Throws:

java.lang.Exception

validate

public void validate()
              throws javax.jbi.management.DeploymentException

Specified by:

validate in interface Endpoint

Overrides:

validate in class ConsumerEndpoint

Throws:

javax.jbi.management.DeploymentException

process

public void process(javax.jbi.messaging.MessageExchange exchange)
             throws java.lang.Exception

Specified by:

process in interface Endpoint

Specified by:

process in class AbstractEndpoint

Throws:

java.lang.Exception

getPort

public int getPort()

setPort

public void setPort(int port)

This attribute specifies the port number to use for connecting to the server.

The default value is 2775

Parameters:

port - a int value representing the port number

getHost

public java.lang.String getHost()

setHost

public void setHost(java.lang.String host)

This attribute specifies the host name to use for connecting to the server.

The default value is null

Parameters:

host - a String value representing the host name

getSystemId

public java.lang.String getSystemId()

setSystemId

public void setSystemId(java.lang.String systemId)

This attribute specifies the system id to use for connecting to the server.

The default value is null

Parameters:

systemId - a String value representing the system id

getPassword

public java.lang.String getPassword()

setPassword

public void setPassword(java.lang.String password)

This attribute specifies the password to use for connecting to the server.

The default value is null

Parameters:

password - a String value representing the password

getMarshaler

public SmppMarshalerSupport getMarshaler()

setMarshaler

public void setMarshaler(SmppMarshalerSupport marshaler)

With this method you can specify a marshaler class which provides the logic for converting a sms message into a normalized message. This class has to implement the interface class SmppMarshaler. If you don't specify a marshaler, the DefaultSmppMarshaler will be used.

Parameters:

marshaler - a SmppMarshaler class representing the marshaler

getEnquireLinkTimer

public int getEnquireLinkTimer()

setEnquireLinkTimer

public void setEnquireLinkTimer(int enquireLinkTimer)

This attribute specifies the enquire link timer defining the SMSC time interval.

The default value is 50000

Parameters:

enquireLinkTimer - a int value representing the enquire link timer

getTransactionTimer

public int getTransactionTimer()

setTransactionTimer

public void setTransactionTimer(int transactionTimer)

This attribute specifies the transaction timer defining the SMSC timeout.

The default value is 100000

Parameters:

transactionTimer - a int value representing the transaction timer (timeout)