ie.ncl.sms.smpp
Class Smpp

java.lang.Object
  ie.ncl.sms.smpp.Smpp

All Implemented Interfaces:

Errors

Deprecated. Use the ie.ncl.msg.Factory object

public class Smpp
extends java.lang.Object
implements Errors

This class is used to establish a connection with a Short Message Service Center (SMSC) and provides an implementation of the SMPP protocol version 3.3 and the SMPPP (provisioning) protocol version 1.1.

Version:

1.0, 1 Nov 1997

Author:

James Noctor

Field Summary

static boolean	encryption Deprecated.
int	RECONNECT_RETRY_ATTEMPTS Deprecated.
long	RECONNECT_TIMER Deprecated.

Fields inherited from interface ie.ncl.sms.smpp.Errors

SMPP_ACK_SEQUENCE, SMPP_CONNECTION_CLOSED, SMPP_GENERIC_NACK, SMPP_INTERNAL, SMPP_INTERRUPTED, SMPP_INVALID_FIELD, SMPP_INVALID_SEQUENCE, SMPP_LINK_QUERY_LENGTH, SMPP_LOCAL_CLOSE, SMPP_MISSING_ARGUMENT, SMPP_MUST_BIND_AS_RECEIVER, SMPP_MUST_BIND_AS_TRANSMITTER, SMPP_NO_DEFAULT_SMSC, SMPP_NOT_BOUND, SMPP_RALYBND, SMPP_RBINDFAIL, SMPP_RCNTADDCUST, SMPP_RCNTADDDL, SMPP_RCNTADDMEMBER, SMPP_RCNTCANMSG, SMPP_RCNTDELCUST, SMPP_RCNTDELDL, SMPP_RCNTDELMEMBER, SMPP_RCNTLISTDL, SMPP_RCNTMODCUST, SMPP_RCNTMODDL, SMPP_RCNTQRYCUST, SMPP_RCNTREPMSG, SMPP_RCNTRETRPARAM, SMPP_RCNTSUBDL, SMPP_RCNTVIEWDL, SMPP_RCUSTEXIST, SMPP_RCUSTNOTEXIST, SMPP_RDELIVERYFAILURE, SMPP_REMOTE_CLOSE, SMPP_RESPONSE_MISSING, SMPP_RINVADRLEN, SMPP_RINVBNDSTS, SMPP_RINVCAPCODELEN, SMPP_RINVCHANNELLEN, SMPP_RINVCITYLEN, SMPP_RINVCMDID, SMPP_RINVCMDLEN, SMPP_RINVCOVREGIONLEN, SMPP_RINVCUSTADRLEN, SMPP_RINVCUSTID, SMPP_RINVCUSTIDLEN, SMPP_RINVCUSTNAMLEN, SMPP_RINVDATFMT, SMPP_RINVDESCMEMBLEN, SMPP_RINVDESTFLAG, SMPP_RINVDLNAME, SMPP_RINVDSTADDRLEN, SMPP_RINVDSTADR, SMPP_RINVDSTNPI, SMPP_RINVDSTTON, SMPP_RINVESMCLASS, SMPP_RINVESMTYPE, SMPP_RINVEXPIRY, SMPP_RINVMDT, SMPP_RINVMDTLEN, SMPP_RINVMEMBERTYPE, SMPP_RINVMIDSER, SMPP_RINVMIN, SMPP_RINVMINLEN, SMPP_RINVMODOPT, SMPP_RINVMSGDIST, SMPP_RINVMSGDISTLEN, SMPP_RINVMSGID, SMPP_RINVMSGLEN, SMPP_RINVNUMDESTS, SMPP_RINVNUMMSGS, SMPP_RINVOPTPARAMVAL, SMPP_RINVOPTPARSTREAM, SMPP_RINVPAR, SMPP_RINVPARAMLEN, SMPP_RINVPARLEN, SMPP_RINVPASWD, SMPP_RINVPERMSG, SMPP_RINVPERMSGLEN, SMPP_RINVPGALERT, SMPP_RINVPGALERTLEN, SMPP_RINVPGCUSTID, SMPP_RINVPGCUSTIDLEN, SMPP_RINVPINLEN, SMPP_RINVPRIORMSG, SMPP_RINVPRIORMSGLEN, SMPP_RINVPRTFLG, SMPP_RINVREGDEL, SMPP_RINVREGDELLEN, SMPP_RINVREGDLVFLG, SMPP_RINVREPADDR, SMPP_RINVREPFLAG, SMPP_RINVRTDB, SMPP_RINVRTDBLEN, SMPP_RINVSCHED, SMPP_RINVSERTYP, SMPP_RINVSMUSER, SMPP_RINVSMUSERLEN, SMPP_RINVSRCADDRLEN, SMPP_RINVSRCADR, SMPP_RINVSRCNPI, SMPP_RINVSRCTON, SMPP_RINVSTATELEN, SMPP_RINVSUBREP, SMPP_RINVSYSIDSRV, SMPP_RINVSYSTYP, SMPP_RINVTERMCODELEN, SMPP_RINVZIPPOSTFIXLEN, SMPP_RINVZIPPREFIXLEN, SMPP_RLIMITEXCEED, SMPP_RMISSINGOPTPARAM, SMPP_RMSGQFUL, SMPP_ROK, SMPP_ROPTPARNOTALLWD, SMPP_RPREDEFMSGNOTFND, SMPP_RPROVNOTALLWD, SMPP_RQUERYFAIL, SMPP_RSERNOTSUP, SMPP_RSUBMITFAIL, SMPP_RSYSERR, SMPP_RTHROTTLEXCD, SMPP_RTXEXCEED, SMPP_RTXNOTALLOWD, SMPP_RUNKNOWNERR, SMPP_RX_P_APPN, SMPP_RX_R_APPN, SMPP_RX_T_APPN, SMPP_SMSC_NOT_RESPONDING, SMPP_UNKNOWN_ACK

Constructor Summary

Smpp()
Deprecated. This constructor sets up the SMPP protocol and connects to the SMSC.

Smpp(int port)
Deprecated. This constructor sets up the SMPP protocol and waits for a connect from the SMSC.

Smpp(java.lang.String host, int port)
Deprecated. This constructor sets up the SMPP protocol and connects to the SMSC.

Method Summary

void	acknowledge(Message m, boolean success) Deprecated. Send a acknowledgement (negative or positive) to a received message.
void	add(AddCustomerResponse target, Customer c) Deprecated. This method is used to asynchronously add a new Customer to the SMSC.
void	add(AddDLResponse target, Address source, java.lang.String dlname) Deprecated. These method asynchronously adds a new (empty) Distribution list to the SMSC.
void	add(AddMemberResponse target, Address source, java.lang.String dlname, Member member) Deprecated. These method asynchronously adds a new member to distribution list on the SMSC.
void	add(Address source, java.lang.String dlname) Deprecated. This method is a synchronous version of the one above.
void	add(Address source, java.lang.String dlname, Member member) Deprecated. This method is a synchronous version of the one above.
void	add(Customer c) Deprecated. This method is used to synchronously add a new Customer to the SMSC.
void	add(ie.ncl.sms.smpp.SmppRequest request) Deprecated. Add a request to the outgoing queue.
void	add(ie.ncl.sms.smpp.SmppRequest request, boolean expedite) Deprecated. Add a request to the outgoing queue.
void	add(ie.ncl.sms.smpp.SmppResponse response) Deprecated. Add a request to the outgoing queue.
void	addOverTheLimit(ie.ncl.sms.smpp.SmppRequest request) Deprecated.
void	alerts(AlertNotification target) Deprecated. This method sets up a callback target which will be called when alert notifications are received.
boolean	areAnyQueuesFull() Deprecated.
void	bind(Binding b) Deprecated. This method performs an synchronous bind with the SMSC.
void	bind(BindResponse target, Binding b) Deprecated. This method is used to perform an asynchronous bind with the SMSC.
void	cancel(CancelResponse target, Message m) Deprecated. This method is used to asynchronously cancel a short message sent to the SMSC for further delivery to an SME or SMEs.
void	cancel(Message m) Deprecated.
void	checkForTimedOutRequests() Deprecated.
void	checkLink() Deprecated. This method performs a up-link check on the SMPP connection.
void	checkLink(CheckLinkResponse target) Deprecated. This method performs a up-link check on the SMPP connection.
void	close() Deprecated.
void	closeServer() Deprecated. For outbinds only.
boolean	connected() Deprecated. Is the SMPP object still connected to the SMSC.
void	debug(boolean ind, boolean outd) Deprecated. Debug is now turned on in a configuration file
void	del(Address source, java.lang.String dlname) Deprecated. This method is a synchronous version of the one above.
void	del(Address source, java.lang.String dlname, Member member) Deprecated. This method is a synchronous version of the one above.
void	del(Customer c) Deprecated. This method is used to synchronously delete an existing customer on the SMSC.
void	del(DelCustomerResponse target, Customer c) Deprecated. This method is used to asynchronously delete an existing customer on the SMSC.
void	del(DelDLResponse target, Address source, java.lang.String dlname) Deprecated. These method asynchronously deletes an existing Distribution List on the SMSC.
void	del(DelMemberResponse target, Address source, java.lang.String dlname, Member member) Deprecated. These method asynchronously adds a deletes an existing member of distribution list on the SMSC.
void	details(DetailsResponse target, Message m) Deprecated. This method is used to asynchronously query all of the details of a short message sent to the SMSC for further delivery to an SME.
void	details(Message m) Deprecated. This method is used to synchronously query all of the details of a short message sent to See the asynchronous version of this method above for more detail.
java.lang.String[]	get(Address source) Deprecated. This method is a synchronous version of the one above.
Member[]	get(Address source, java.lang.String dlname) Deprecated. This method is a synchronous version of the one above.
void	get(Customer c) Deprecated. This method is used to synchronously retrieve an existing customer's attributes See the asynchronous version of this method above for more detail.
void	get(GetCustomerResponse target, Customer c) Deprecated. This method is used to asynchronously retrieve an existing customer's attributes on the SMSC.
void	get(GetDLResponse target, Address source) Deprecated. These method asynchronously retrieves a list of distribution list names on the SMSC.
void	get(GetMemberResponse target, Address source, java.lang.String dlname) Deprecated. These method asynchronously retrieves the members of distribution list on the SMSC.
java.lang.String	getAlphanumericAddressCharacterEncoding() Deprecated.
boolean	getAutoAcknowledge() Deprecated. Acknowledge received messages automatically.
int	getAutomaticLinkCheck() Deprecated. Gets the automatic link check.
long	getBindResponseTimeout() Deprecated.
int	getFlowControlTimer() Deprecated.
int	getInputStreamTimer() Deprecated.
boolean	getLinkAliveIfAnyDataReceived() Deprecated. Get the Link Alive functionality.
LinkTimers	getLinkTimers() Deprecated.
int	getMaximumNumberOfRetries() Deprecated.
int	getMaxLengthPdu() Deprecated.
boolean	getNotifyApplicationOfTempErrors() Deprecated.
int	getOutputQueueSize() Deprecated. Get the size of the output queue.
ie.ncl.util.ClosableFiniteFifo	getPendingRequests() Deprecated.
boolean	getReconnectOnDisconnect() Deprecated. Reconnect if there is a disconnection.
int	getRequestTimeout() Deprecated.
boolean	getRetryMessagesOnQueueFull() Deprecated.
boolean	getSequentialAcks() Deprecated.
ie.ncl.sms.smpp.prot.SmppDecoder	getSmppDecoder(byte[] bytes) Deprecated.
ie.ncl.sms.smpp.prot.SmppEncoder	getSmppEncoder() Deprecated.
int	getSmscResponseTimeout() Deprecated. The response time out for an SMSC (30 seconds).
int	getSocketConnectTimeout() Deprecated.
int	getSocketSoTimeout() Deprecated.
int	getStatusForReceiveException() Deprecated.
int	getThrottling() Deprecated.
long	getTimeBetweenRetries() Deprecated.
int	getUnackedQueueSize() Deprecated.
int	getUnackedQueueSizePause() Deprecated.
boolean	isDeliverUnknownPDUs() Deprecated.
boolean	isMaxLengthPduExceeded(int length) Deprecated.
boolean	isMessageIdReturned() Deprecated.
boolean	isNotifyApplicationOfDecodingErrors() Deprecated.
boolean	isThreadDaemon() Deprecated.
boolean	isThrottleOnMsgQueueFullError() Deprecated.
java.lang.String[]	list(Address source, int count) Deprecated. This method is used to synchronously query a list of short messages sent to the SMSC for further delivery to an SME.
void	list(ListResponse target, Address source, int count) Deprecated. This method is used to asynchronously query a list of short messages sent to the SMSC for further delivery to an SME.
static void	main(java.lang.String[] args) Deprecated. Print version information.
void	mod(Customer c) Deprecated. This method is used to synchronously modify an existing Customer at the SMSC.
void	mod(ModCustomerResponse target, Customer c) Deprecated. This method is used to asynchronously modify an existing Customer at the SMSC.
void	parameter(ParameterResponse target, java.lang.String name) Deprecated. This method is used to retrieve a (per ESME & system wide) configurable parameter at the SMSC.
java.lang.String	parameter(java.lang.String name) Deprecated. This method is used to retrieve a (per ESME & system wide) configurable parameter at the SMSC.
void	receive(ExtendedReceiver target) Deprecated. This method sets up a callback target which will be called when messages are received.
void	receive(Receiver target) Deprecated. This method sets up a callback target which will be called when messages are received.
void	recordDataReceived() Deprecated.
void	replace(Message m) Deprecated. This method is used to synchronously replace a short message sent to the SMSC for further delivery to an SME.
void	replace(ReplaceResponse target, Message m) Deprecated. This method is used to asynchronously replace a short message sent to the SMSC for further delivery to an SME.
void	retry(ie.ncl.sms.smpp.SmppRequest request) Deprecated. Add a request to the outgoing queue but expedite it.
void	send(ExtendedSendResponse target, Message m, MessageSettings settings) Deprecated. This method is used to asynchronously send a short message to the SMSC for further delivery to an SME or SMEs.
void	send(Message m) Deprecated.
void	send(Message m, MessageSettings ms) Deprecated.
void	send(SendResponse target, Message m) Deprecated. This method is used to asynchronously send a short message to the SMSC for further delivery to an SME or SMEs.
void	send(SendResponse target, Message m, MessageSettings ms) Deprecated.
void	service(java.net.Socket socket) Deprecated.
void	setAlphanumericAddressCharacterEncoding(java.lang.String alphanumericAddressCharacterEncoding) Deprecated.
void	setAutoAcknowledge(boolean yesno) Deprecated. Acknowledge received messages automatically.
void	setAutomaticLinkCheck(int usec) Deprecated. Sets the automatic link check.
void	setBindResponseTimeout(long bindResponseTimeout) Deprecated.
void	setConnectionErrorTarget(ConnectionError ce) Deprecated. Used to specify a callback when the connection is closed.
void	setDeliverUnknownPDUs(boolean deliverUnknownPDUs) Deprecated.
void	setFlowControlTimer(int usec) Deprecated. The default FLOW CONTROL timer is how long to wait before starting to send messages again (10 seconds) after receiving a throttling error.
void	setInputStreamTimer(int timer) Deprecated.
void	setLinkAliveIfAnyDataReceived(boolean newVal) Deprecated. Set the Link Alive functionality.
void	setMaximumNumberOfRetries(int val) Deprecated.
void	setMaxLengthPdu(int maxLengthPdu) Deprecated.
void	setMessageIdReturned(boolean messageIdReturned) Deprecated.
void	setNotifyApplicationOfDecodingErrors(boolean notifyApplicationOfDecodingErrors) Deprecated.
void	setNotifyApplicationOfTempErrors(boolean val) Deprecated.
void	setOutputQueueSize(int size) Deprecated. Set the size of the output queue.
void	setReconnectOnDisconnect(boolean yesOrNo) Deprecated. Reconnect if there is a disconnection.
void	setRequestTimeout(int requestTimeout) Deprecated.
void	setRetryMessagesOnQueueFull(boolean val) Deprecated.
void	setSequentialAcks(boolean yesOrNo) Deprecated.
static void	setSMSC(java.lang.String host, int port) Deprecated. This static method sets the default TCP/IP address of the SMSC.
void	setSmscResponseTimeout(int usec) Deprecated. The response time out for an SMSC (30 seconds).
void	setSocketConnectTimeout(int socketConnectTimeout) Deprecated.
void	setSocketSoTimeout(int socketSoTimeout) Deprecated.
void	setStatusForReceiveException(int statusForReceiveException) Deprecated.
void	setThreadDaemon(boolean threadDaemon) Deprecated.
void	setThrottleOnMsgQueueFullError(boolean throttleOnMsgQueueFullError) Deprecated.
void	setThrottling(int throttleUsecond) Deprecated.
void	setTimeBetweenRetries(long msec) Deprecated.
void	setUnackedQueueSize(int size) Deprecated.
void	setUnackedQueueSizePause(int pause) Deprecated.
void	shutdown() Deprecated. This method is used to abort the smpp connection.
void	status(Message m) Deprecated. This method is used to synchronously query the status of a short message sent to See the asynchronous version of this method above for more detail.
void	status(StatusResponse target, Message m) Deprecated. This method is used to asynchronously query the status of a short message sent to the SMSC for further delivery to an SME.
static java.lang.String	version() Deprecated.

Methods inherited from class java.lang.Object

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

Field Detail

encryption

public static boolean encryption

Deprecated.

RECONNECT_RETRY_ATTEMPTS

public int RECONNECT_RETRY_ATTEMPTS

Deprecated.

RECONNECT_TIMER

public long RECONNECT_TIMER

Deprecated.

Constructor Detail

Smpp

public Smpp(java.lang.String host,
            int port)
     throws java.net.UnknownHostException,
            java.io.IOException,
            ie.ncl.net.socks.SocksException

Deprecated.

This constructor sets up the SMPP protocol and connects to the SMSC.

Parameters:

host - The host name or IP address of the SMSC

port - The port number of the SMPP server on the SMSC

Throws:

java.net.UnknownHostException - If the host name look up failed

java.io.IOException - If a socket could not be created

ie.ncl.net.socks.SocksException - If communication with the SOCKS V4 proxy failed

Smpp

public Smpp(int port)
     throws java.net.UnknownHostException,
            java.io.IOException,
            ie.ncl.net.socks.SocksException

Deprecated.

This constructor sets up the SMPP protocol and waits for a connect from the SMSC.

Parameters:

port - The port number that an incomming SMPP connection will arrive

Throws:

java.net.UnknownHostException - If the host name look up failed

java.io.IOException - If a socket could not be created

ie.ncl.net.socks.SocksException - If communication with the SOCKS V4 proxy failed

Smpp

public Smpp()
     throws java.net.UnknownHostException,
            java.io.IOException,
            ie.ncl.net.socks.SocksException,
            SMSException

Deprecated.

This constructor sets up the SMPP protocol and connects to the SMSC. It uses the default SMSC TCP/IP address.

Throws:

java.net.UnknownHostException - If the host name look up failed

java.io.IOException - If a socket could not be created

ie.ncl.net.socks.SocksException - If communication with the SOCKS V4 proxy failed

SMSException - If there is no default SMSC address

See Also:

setSMSC(java.lang.String, int)

Method Detail

getLinkTimers

public LinkTimers getLinkTimers()

Deprecated.

recordDataReceived

public void recordDataReceived()

Deprecated.

getBindResponseTimeout

public long getBindResponseTimeout()

Deprecated.

setBindResponseTimeout

public void setBindResponseTimeout(long bindResponseTimeout)

Deprecated.

isThrottleOnMsgQueueFullError

public boolean isThrottleOnMsgQueueFullError()

Deprecated.

setThrottleOnMsgQueueFullError

public void setThrottleOnMsgQueueFullError(boolean throttleOnMsgQueueFullError)

Deprecated.

getSocketConnectTimeout

public int getSocketConnectTimeout()

Deprecated.

setSocketConnectTimeout

public void setSocketConnectTimeout(int socketConnectTimeout)

Deprecated.

getMaxLengthPdu

public int getMaxLengthPdu()

Deprecated.

setMaxLengthPdu

public void setMaxLengthPdu(int maxLengthPdu)

Deprecated.

isDeliverUnknownPDUs

public boolean isDeliverUnknownPDUs()

Deprecated.

setDeliverUnknownPDUs

public void setDeliverUnknownPDUs(boolean deliverUnknownPDUs)

Deprecated.

isMaxLengthPduExceeded

public boolean isMaxLengthPduExceeded(int length)

Deprecated.

isNotifyApplicationOfDecodingErrors

public boolean isNotifyApplicationOfDecodingErrors()

Deprecated.

setNotifyApplicationOfDecodingErrors

public void setNotifyApplicationOfDecodingErrors(boolean notifyApplicationOfDecodingErrors)

Deprecated.

isThreadDaemon

public boolean isThreadDaemon()

Deprecated.

setThreadDaemon

public void setThreadDaemon(boolean threadDaemon)

Deprecated.

isMessageIdReturned

public boolean isMessageIdReturned()

Deprecated.

setMessageIdReturned

public void setMessageIdReturned(boolean messageIdReturned)

Deprecated.

main

public static void main(java.lang.String[] args)

Deprecated.

Print version information.

version

public static java.lang.String version()

Deprecated.

getStatusForReceiveException

public int getStatusForReceiveException()

Deprecated.

setStatusForReceiveException

public void setStatusForReceiveException(int statusForReceiveException)

Deprecated.

setThrottling

public void setThrottling(int throttleUsecond)

Deprecated.

getThrottling

public int getThrottling()

Deprecated.

getInputStreamTimer

public int getInputStreamTimer()

Deprecated.

setInputStreamTimer

public void setInputStreamTimer(int timer)

Deprecated.

setRetryMessagesOnQueueFull

public void setRetryMessagesOnQueueFull(boolean val)

Deprecated.

getRetryMessagesOnQueueFull

public boolean getRetryMessagesOnQueueFull()

Deprecated.

getNotifyApplicationOfTempErrors

public boolean getNotifyApplicationOfTempErrors()

Deprecated.

setNotifyApplicationOfTempErrors

public void setNotifyApplicationOfTempErrors(boolean val)

Deprecated.

getMaximumNumberOfRetries

public int getMaximumNumberOfRetries()

Deprecated.

setMaximumNumberOfRetries

public void setMaximumNumberOfRetries(int val)

Deprecated.

getSocketSoTimeout

public int getSocketSoTimeout()

Deprecated.

setSocketSoTimeout

public void setSocketSoTimeout(int socketSoTimeout)

Deprecated.

setConnectionErrorTarget

public void setConnectionErrorTarget(ConnectionError ce)

Deprecated.

Used to specify a callback when the connection is closed.

getLinkAliveIfAnyDataReceived

public boolean getLinkAliveIfAnyDataReceived()

Deprecated.

Get the Link Alive functionality. If this is true, then the link is up and running if ANY data has been received within the response time of a query link request. If this is false, then the link is alive IF AND ONLY IF a query link response is received within the response time (set getSmscResonseTimeout) of a query link request. Applications sending a high through put of messages asynchronously may have a large number of out standing messages which take time to process. As such, the SMSC may be responding properly but may not have processed all message requests before sending a query link response back to the application.

setLinkAliveIfAnyDataReceived

public void setLinkAliveIfAnyDataReceived(boolean newVal)

Deprecated.

Set the Link Alive functionality.

See Also:

getLinkAliveIfAnyDataReceived()

setAutoAcknowledge

public void setAutoAcknowledge(boolean yesno)

Deprecated.

Acknowledge received messages automatically.

getAutoAcknowledge

public boolean getAutoAcknowledge()

Deprecated.

Acknowledge received messages automatically.

getSequentialAcks

public boolean getSequentialAcks()

Deprecated.

setSequentialAcks

public void setSequentialAcks(boolean yesOrNo)

Deprecated.

getReconnectOnDisconnect

public boolean getReconnectOnDisconnect()

Deprecated.

Reconnect if there is a disconnection.

setReconnectOnDisconnect

public void setReconnectOnDisconnect(boolean yesOrNo)

Deprecated.

Reconnect if there is a disconnection.

getOutputQueueSize

public int getOutputQueueSize()

Deprecated.

Get the size of the output queue. This is the number of pending requests. When this limit is received all operations except query links will block.

setOutputQueueSize

public void setOutputQueueSize(int size)

Deprecated.

Set the size of the output queue. This is the number of pending requests. When this limit is received all operations except query links will block.

setUnackedQueueSize

public void setUnackedQueueSize(int size)

Deprecated.

getUnackedQueueSize

public int getUnackedQueueSize()

Deprecated.

setUnackedQueueSizePause

public void setUnackedQueueSizePause(int pause)

Deprecated.

getUnackedQueueSizePause

public int getUnackedQueueSizePause()

Deprecated.

getPendingRequests

public ie.ncl.util.ClosableFiniteFifo getPendingRequests()

Deprecated.

setSmscResponseTimeout

public void setSmscResponseTimeout(int usec)

Deprecated.

The response time out for an SMSC (30 seconds).

getSmscResponseTimeout

public int getSmscResponseTimeout()

Deprecated.

The response time out for an SMSC (30 seconds).

setFlowControlTimer

public void setFlowControlTimer(int usec)

Deprecated.

The default FLOW CONTROL timer is how long to wait before starting to send messages again (10 seconds) after receiving a throttling error. The Smpp object WILL retry sending messages for which it gets a throttling error.

getFlowControlTimer

public int getFlowControlTimer()

Deprecated.

See Also:

setFlowControlTimer(int)

setAutomaticLinkCheck

public void setAutomaticLinkCheck(int usec)

Deprecated.

Sets the automatic link check. This is used to configure the sending of a link alive or ping every 'usec' microseconds.

getAutomaticLinkCheck

public int getAutomaticLinkCheck()

Deprecated.

Gets the automatic link check. This is used to configure the sending of a link alive or ping every 'usec' microseconds.

setSMSC

public static void setSMSC(java.lang.String host,
                           int port)

Deprecated.

This static method sets the default TCP/IP address of the SMSC.

service

public void service(java.net.Socket socket)
             throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

retry

public void retry(ie.ncl.sms.smpp.SmppRequest request)
           throws ie.ncl.util.QueueClosedException

Deprecated.

Add a request to the outgoing queue but expedite it.

Throws:

ie.ncl.util.QueueClosedException

receive

public void receive(Receiver target)
             throws SMSException

Deprecated.

This method sets up a callback target which will be called when messages are received. The callback target must implement the Receiver interface. The connection must be bound as a receiver before this can be called.

Throws:

SMSException - If not bound as a receiver

See Also:

bind(ie.ncl.sms.smpp.BindResponse, ie.ncl.sms.smpp.Binding), Receiver

receive

public void receive(ExtendedReceiver target)
             throws SMSException

Deprecated.

This method sets up a callback target which will be called when messages are received. The callback target must implement the Receiver interface. The connection must be bound as a receiver before this can be called.

Throws:

SMSException - If not bound as a receiver

See Also:

bind(ie.ncl.sms.smpp.BindResponse, ie.ncl.sms.smpp.Binding), ExtendedReceiver

alerts

public void alerts(AlertNotification target)
            throws SMSException

Deprecated.

This method sets up a callback target which will be called when alert notifications are received. The callback target must implement the AlertNotification interface.

Throws:

SMSException

See Also:

AlertNotification

add

public void add(ie.ncl.sms.smpp.SmppRequest request,
                boolean expedite)
         throws ie.ncl.util.QueueClosedException

Deprecated.

Add a request to the outgoing queue.

Throws:

ie.ncl.util.QueueClosedException

add

public void add(ie.ncl.sms.smpp.SmppRequest request)
         throws ie.ncl.util.QueueClosedException

Deprecated.

Add a request to the outgoing queue.

Throws:

ie.ncl.util.QueueClosedException

addOverTheLimit

public void addOverTheLimit(ie.ncl.sms.smpp.SmppRequest request)
                     throws ie.ncl.util.QueueClosedException

Deprecated.

Throws:

ie.ncl.util.QueueClosedException

areAnyQueuesFull

public boolean areAnyQueuesFull()

Deprecated.

add

public void add(ie.ncl.sms.smpp.SmppResponse response)
         throws ie.ncl.util.QueueClosedException

Deprecated.

Add a request to the outgoing queue.

Throws:

ie.ncl.util.QueueClosedException

connected

public boolean connected()

Deprecated.

Is the SMPP object still connected to the SMSC.

bind

public void bind(BindResponse target,
                 Binding b)
          throws SMSException,
                 java.io.IOException

Deprecated.

This method is used to perform an asynchronous bind with the SMSC. The bind is in effect a login but it also specifies the type of session established between the application and the SMSC which can be either a receiver session or a transmitter session. In the case of a receiver, an address range should be specified when constructing the Binding object.

Parameters:

target - The object to be called when the bind is complete

b - The bind information

Throws:

java.io.IOException - If communication with the SMSC breaks down

SMSException - If the SMSC returns an error

See Also:

BindResponse

bind

public void bind(Binding b)
          throws SMSException,
                 java.io.IOException

Deprecated.

This method performs an synchronous bind with the SMSC. See the asynchronous version of this method above for more detail.

Throws:

java.io.IOException - If communication with the SMSC breaks down

SMSException - If the SMSC returns an error

send

public void send(SendResponse target,
                 Message m)
          throws SMSException,
                 java.io.IOException

Deprecated.

This method is used to asynchronously send a short message to the SMSC for further delivery to an SME or SMEs. The target should implement a SendResponse to receive the response of this action. The response places in the message object a unique idenifier which can be used as a handle to peform other operations on the message (such as cancel,replace) at a later stage.

Parameters:

m - The short message to be sent.

target - The object to be called when the response has been received

Throws:

java.io.IOException - If communication with the SMSC breaks down

SMSException - If the SMSC returns an error

See Also:

Message.getId(), SendResponse

send

public void send(SendResponse target,
                 Message m,
                 MessageSettings ms)
          throws SMSException,
                 java.io.IOException

Deprecated.

Throws:

SMSException

java.io.IOException

send

public void send(ExtendedSendResponse target,
                 Message m,
                 MessageSettings settings)
          throws SMSException,
                 java.io.IOException

Deprecated.

This method is used to asynchronously send a short message to the SMSC for further delivery to an SME or SMEs. The target should implement ExtendedSendResponse to receive the response of this action. The response places in the message object a unique idenifier which can be used as a handle to peform other operations on the message (such as cancel,replace) at a later stage.

Parameters:

m - The short message to be sent.

target - The object to be called when the response has been received.

settings - Extended message settings for SMPP 3.4

Throws:

java.io.IOException - If communication with the SMSC breaks down

SMSException - If the SMSC returns an error

See Also:

Message.getId(), SendResponse

send

public void send(Message m)
          throws SMSException,
                 java.io.IOException

Deprecated.

Throws:

SMSException

java.io.IOException

send

public void send(Message m,
                 MessageSettings ms)
          throws SMSException,
                 java.io.IOException

Deprecated.

Throws:

SMSException

java.io.IOException

cancel

public void cancel(CancelResponse target,
                   Message m)
            throws SMSException,
                   java.io.IOException

Deprecated.

This method is used to asynchronously cancel a short message sent to the SMSC for further delivery to an SME or SMEs. The target should implement a CancelResponse to receive the response of this action. The response does not modify the message object, but the message object should contain unique identifier which was returned when the message was previously sumbitted. Verification is also performed on the source of the message (from field) if one is present in the message object.

Parameters:

m - The short message to be cancelled.

target - The object to be called when the response has been received

Throws:

java.io.IOException - If communication with the SMSC breaks down

SMSException - If the SMSC returns an error

See Also:

Message, Message.setFrom(ie.ncl.sms.smpp.prot.Address), CancelResponse

cancel

public void cancel(Message m)
            throws java.io.IOException,
                   SMSException

Deprecated.

Throws:

java.io.IOException

SMSException

replace

public void replace(ReplaceResponse target,
                    Message m)
             throws SMSException,
                    java.io.IOException

Deprecated.

This method is used to asynchronously replace a short message sent to the SMSC for further delivery to an SME. The target should implement a ReplaceResponse to receive the response of this action. The response does not modify the message object, but the message object should contain the unique identifier (ID) which was returned when the message was previously sumbitted. Verification is also performed on the source of the message ('from' field) if one is present in the message object.

Parameters:

m - The replacement short message.

target - The object to be called when the response has been received

Throws:

java.io.IOException - If communication with the SMSC breaks down

SMSException - If the SMSC returns an error

See Also:

Message, Message.setFrom(ie.ncl.sms.smpp.prot.Address), ReplaceResponse

replace

public void replace(Message m)
             throws SMSException,
                    java.io.IOException

Deprecated.

This method is used to synchronously replace a short message sent to the SMSC for further delivery to an SME. See the asynchronous version of this method above for more detail.

Parameters:

m - The replacement short message.

Throws:

java.io.IOException - If communication with the SMSC breaks down

SMSException - If the SMSC returns an error

status

public void status(StatusResponse target,
                   Message m)
            throws SMSException,
                   java.io.IOException

Deprecated.

This method is used to asynchronously query the status of a short message sent to the SMSC for further delivery to an SME. The target should implement a StatusResponse to receive the response of this action. The response modifies the message's Status and GSMerror if there is one. The TimeStamp will be modified also if the message has entered a final state (e.g. delivered). The message object should contain the unique identifier (ID) which was returned when the message was previously sumbitted. Verification is also performed on the source of the message ('from' field) if one is present in the message object.

Parameters:

m - The replacement short message.

target - The object to be called when the response has been received

Throws:

java.io.IOException - If communication with the SMSC breaks down

SMSException - If the SMSC returns an error

See Also:

Message, Message.setFrom(ie.ncl.sms.smpp.prot.Address), Message.getTimeStamp(), Message.getGsmError(), Message.getStatus(), StatusResponse

status

public void status(Message m)
            throws SMSException,
                   java.io.IOException

Deprecated.

This method is used to synchronously query the status of a short message sent to See the asynchronous version of this method above for more detail.

Parameters:

m - The replacement short message.

Throws:

java.io.IOException - If communication with the SMSC breaks down

SMSException - If the SMSC returns an error

details

public void details(DetailsResponse target,
                    Message m)
             throws SMSException,
                    java.io.IOException

Deprecated.

This method is used to asynchronously query all of the details of a short message sent to the SMSC for further delivery to an SME. The target should implement a DetailsResponse to receive the response of this action. The response returns all the message's attributes. The message object should contain the unique identifier (ID) which was returned when the message was previously sumbitted. Verification is also performed on the source of the message ('from' field) if one is present in the message object.

Parameters:

m - The message in which the details will be returned.

target - The object to be called when the response has been received

Throws:

java.io.IOException - If communication with the SMSC breaks down

SMSException - If the SMSC returns an error

See Also:

Message, Message.setFrom(ie.ncl.sms.smpp.prot.Address), DetailsResponse

details

public void details(Message m)
             throws SMSException,
                    java.io.IOException

Deprecated.

This method is used to synchronously query all of the details of a short message sent to See the asynchronous version of this method above for more detail.

Parameters:

m - The message in which the details will be returned.

Throws:

java.io.IOException - If communication with the SMSC breaks down

SMSException - If the SMSC returns an error

list

public void list(ListResponse target,
                 Address source,
                 int count)
          throws SMSException,
                 java.io.IOException

Deprecated.

This method is used to asynchronously query a list of short messages sent to the SMSC for further delivery to an SME. The target should implement a ListResponse to receive the response of this action. The response responds with the message IDs of the previously sumbitted short messages from the specified source ('from') upto and limited to 'count' messages. The resulting IDs can be queried using either the Status or Details function.

Parameters:

target - The object to be called when the response has been received

source - The short messages' original source address.

count - Indicates the maximum number of IDs to be returned.

Throws:

java.io.IOException - If communication with the SMSC breaks down

SMSException - If the SMSC returns an error

See Also:

Message, status(ie.ncl.sms.smpp.StatusResponse, ie.ncl.sms.smpp.Message), details(ie.ncl.sms.smpp.DetailsResponse, ie.ncl.sms.smpp.Message), ListResponse

list

public java.lang.String[] list(Address source,
                               int count)
                        throws SMSException,
                               java.io.IOException

Deprecated.

This method is used to synchronously query a list of short messages sent to the SMSC for further delivery to an SME. See the asynchronous version of this method above for more detail.

Parameters:

source - The short messages' original source address.

count - Indicates the maximum number of IDs to be returned.

Returns:

String[] the list of message IDs of previously sent messages.

Throws:

java.io.IOException - If communication with the SMSC breaks down

SMSException - If the SMSC returns an error

parameter

public void parameter(ParameterResponse target,
                      java.lang.String name)
               throws SMSException,
                      java.io.IOException

Deprecated.

This method is used to retrieve a (per ESME & system wide) configurable parameter at the SMSC. The target should implement a ParameterResponse to receive the response of this action. A parameter name is specified and a value is returned in the response. The SMSC has a number of parameters which are Service Provider specific. Check with the Service Provider for more information regarding these parameters.

Parameters:

target - The object to be called when the response has been received

name - The name of the parameter

Throws:

java.io.IOException - If communication with the SMSC breaks down

SMSException - If the SMSC returns an error

See Also:

ParameterResponse

parameter

public java.lang.String parameter(java.lang.String name)
                           throws SMSException,
                                  java.io.IOException

Deprecated.

This method is used to retrieve a (per ESME & system wide) configurable parameter at the SMSC. See the asynchronous version of this method above for more detail.

Parameters:

name - The name of the parameter

Returns:

String the value of the parameter

Throws:

java.io.IOException - If communication with the SMSC breaks down

SMSException - If the SMSC returns an error

checkLink

public void checkLink()
               throws SMSException,
                      java.io.IOException

Deprecated.

This method performs a up-link check on the SMPP connection. An exception is thrown if a promblem is detected.

Throws:

java.io.IOException - If communication with the SMSC breaks down

SMSException - If the SMSC returns an error

checkLink

public void checkLink(CheckLinkResponse target)
               throws SMSException,
                      java.io.IOException

Deprecated.

This method performs a up-link check on the SMPP connection. An exception is thrown if a promblem is detected.

Throws:

java.io.IOException - If communication with the SMSC breaks down

SMSException - If the SMSC returns an error

add

public void add(AddCustomerResponse target,
                Customer c)
         throws SMSException,
                java.io.IOException

Deprecated.

This method is used to asynchronously add a new Customer to the SMSC. The target should implement a AddCustomerResponse to receive the response of this action.

Parameters:

target - The callback target.

c - The new customer.

Throws:

java.io.IOException - If communication with the SMSC breaks down

SMSException - If the SMSC returns an error

See Also:

AddCustomerResponse, Customer

add

public void add(Customer c)
         throws SMSException,
                java.io.IOException

Deprecated.

This method is used to synchronously add a new Customer to the SMSC. See the asynchronous version of this method above for more detail.

Parameters:

c - The new customer.

Throws:

java.io.IOException - If communication with the SMSC breaks down

SMSException - If the SMSC returns an error

mod

public void mod(ModCustomerResponse target,
                Customer c)
         throws SMSException,
                java.io.IOException

Deprecated.

This method is used to asynchronously modify an existing Customer at the SMSC. The target should implement a ModCustomerResponse to receive the response of this action. The customer ID should match that of an existing customer. The remaining customers attributes will be updated at the SMSC.

Parameters:

target - The callback target

c - The replacement customer's attributes

Throws:

java.io.IOException - If communication with the SMSC breaks down

SMSException - If the SMSC returns an error

See Also:

ModCustomerResponse, Customer

mod

public void mod(Customer c)
         throws SMSException,
                java.io.IOException

Deprecated.

This method is used to synchronously modify an existing Customer at the SMSC. See the asynchronous version of this method above for more detail.

Parameters:

c - The replacement customer's attributes

Throws:

java.io.IOException - If communication with the SMSC breaks down

SMSException - If the SMSC returns an error

get

public void get(GetCustomerResponse target,
                Customer c)
         throws SMSException,
                java.io.IOException

Deprecated.

This method is used to asynchronously retrieve an existing customer's attributes on the SMSC. The target should implement a GetCustomerResponse to receive the response of this action. The customer ID should match that of an existing customer.

Parameters:

target - The callback target

c - The customer object in which the retrieved attributes will be placed

Throws:

java.io.IOException - If communication with the SMSC breaks down

SMSException - If the SMSC returns an error

See Also:

GetCustomerResponse, Customer

get

public void get(Customer c)
         throws SMSException,
                java.io.IOException

Deprecated.

This method is used to synchronously retrieve an existing customer's attributes See the asynchronous version of this method above for more detail.

Parameters:

c - The customer object in which the retrieved attributes will be placed

Throws:

java.io.IOException - If communication with the SMSC breaks down

SMSException - If the SMSC returns an error

del

public void del(DelCustomerResponse target,
                Customer c)
         throws SMSException,
                java.io.IOException

Deprecated.

This method is used to asynchronously delete an existing customer on the SMSC. The target should implement a DelCustomerResponse to receive the response of this action. The customer ID should match that of an existing customer.

Parameters:

target - The callback target

c - The customer to be deleted.

Throws:

java.io.IOException - If communication with the SMSC breaks down

SMSException - If the SMSC returns an error

See Also:

DelCustomerResponse, Customer

del

public void del(Customer c)
         throws SMSException,
                java.io.IOException

Deprecated.

This method is used to synchronously delete an existing customer on the SMSC. See the asynchronous version of this method above for more detail.

Parameters:

c - The customer to be deleted.

Throws:

java.io.IOException - If communication with the SMSC breaks down

SMSException - If the SMSC returns an error

add

public void add(AddDLResponse target,
                Address source,
                java.lang.String dlname)
         throws SMSException,
                java.io.IOException

Deprecated.

These method asynchronously adds a new (empty) Distribution list to the SMSC. The target should implement a AddDLResponse to receive the response of this action. The distribution list is 'owned' by the SME specified by the source address

Parameters:

target - The callback target

dlname - The name of the distribution list to be added

source - The SME owner of the distrbution list

Throws:

java.io.IOException - If communication with the SMSC breaks down

SMSException - If the SMSC returns an error

add

public void add(Address source,
                java.lang.String dlname)
         throws SMSException,
                java.io.IOException

Deprecated.

This method is a synchronous version of the one above.

Parameters:

dlname - The name of the distribution list to be added

source - The SME owner of the distrbution list

Throws:

java.io.IOException - If communication with the SMSC breaks down

SMSException - If the SMSC returns an error

del

public void del(DelDLResponse target,
                Address source,
                java.lang.String dlname)
         throws SMSException,
                java.io.IOException

Deprecated.

These method asynchronously deletes an existing Distribution List on the SMSC. The target should implement a DelDLResponse to receive the response of this action. The distribution list is 'owned' by the SME specified by the source address

Parameters:

target - The callback target

dlname - The name of the distribution list to be deleted

source - The SME owner of the distrbution list

Throws:

java.io.IOException - If communication with the SMSC breaks down

SMSException - If the SMSC returns an error

del

public void del(Address source,
                java.lang.String dlname)
         throws SMSException,
                java.io.IOException

Deprecated.

This method is a synchronous version of the one above.

Parameters:

dlname - The name of the distribution list to be deleted

source - The SME owner of the distrbution list

Throws:

java.io.IOException - If communication with the SMSC breaks down

SMSException - If the SMSC returns an error

get

public void get(GetDLResponse target,
                Address source)
         throws SMSException,
                java.io.IOException

Deprecated.

These method asynchronously retrieves a list of distribution list names on the SMSC. The target should implement a GetDLResponse to receive the response of this action. The distribution list returned are those 'owned' by the SME specified by the source address

Parameters:

target - The callback target

source - The SME owner of the distrbution lists

Throws:

java.io.IOException - If communication with the SMSC breaks down

SMSException - If the SMSC returns an error

get

public java.lang.String[] get(Address source)
                       throws SMSException,
                              java.io.IOException

Deprecated.

This method is a synchronous version of the one above.

Parameters:

source - The SME owner of the distrbution lists

Returns:

String[] a list of distribution list names

Throws:

java.io.IOException - If communication with the SMSC breaks down

SMSException - If the SMSC returns an error

add

public void add(AddMemberResponse target,
                Address source,
                java.lang.String dlname,
                Member member)
         throws SMSException,
                java.io.IOException

Deprecated.

These method asynchronously adds a new member to distribution list on the SMSC. The target should implement a AddMemberResponse to receive the response of this action. The distribution list (specified by dlname) is one 'owned' by the SME specified by the source address

Parameters:

target - The callback target

source - The SME owner of the distrbution list

dlname - The name of the distribution list to be modified

member - The new distribution list member

Throws:

java.io.IOException - If communication with the SMSC breaks down

SMSException - If the SMSC returns an error

add

public void add(Address source,
                java.lang.String dlname,
                Member member)
         throws SMSException,
                java.io.IOException

Deprecated.

This method is a synchronous version of the one above.

Parameters:

source - The SME owner of the distrbution list

dlname - The name of the distribution list to be modified

member - The new distribution list member

Throws:

java.io.IOException - If communication with the SMSC breaks down

SMSException - If the SMSC returns an error

del

public void del(DelMemberResponse target,
                Address source,
                java.lang.String dlname,
                Member member)
         throws SMSException,
                java.io.IOException

Deprecated.

These method asynchronously adds a deletes an existing member of distribution list on the SMSC. The target should implement a DelMemberResponse to receive the response of this action. The distribution list (specified by dlname) is one 'owned' by the SME specified by the source address. (Only the member description is of the member object is referenced in this action as it should uniquely identify a member in a distribution list.)

Parameters:

target - The callback target

source - The SME owner of the distrbution list

dlname - The name of the distribution list to be modified

member - The distribution list member to be deleted.

Throws:

java.io.IOException - If communication with the SMSC breaks down

SMSException - If the SMSC returns an error

del

public void del(Address source,
                java.lang.String dlname,
                Member member)
         throws SMSException,
                java.io.IOException

Deprecated.

This method is a synchronous version of the one above.

Parameters:

source - The SME owner of the distrbution list

dlname - The name of the distribution list to be modified

member - The distribution list member to be deleted.

Throws:

java.io.IOException - If communication with the SMSC breaks down

SMSException - If the SMSC returns an error

get

public void get(GetMemberResponse target,
                Address source,
                java.lang.String dlname)
         throws SMSException,
                java.io.IOException

Deprecated.

These method asynchronously retrieves the members of distribution list on the SMSC. The target should implement a GetMemberResponse to receive the response of this action. The distribution list (specified by dlname) is one 'owned' by the SME specified by the source address.

Parameters:

target - The callback target

source - The SME owner of the distrbution list

dlname - The name of the distribution list to be retrieved

Throws:

java.io.IOException - If communication with the SMSC breaks down

SMSException - If the SMSC returns an error

get

public Member[] get(Address source,
                    java.lang.String dlname)
             throws SMSException,
                    java.io.IOException

Deprecated.

This method is a synchronous version of the one above.

Parameters:

source - The SME owner of the distrbution list

dlname - The name of the distribution list to be retrieved

Returns:

member[] A list of members in the specified distribution list

Throws:

java.io.IOException - If communication with the SMSC breaks down

SMSException - If the SMSC returns an error

closeServer

public void closeServer()

Deprecated.

For outbinds only. This closes the listening socket that listens for incomming requests.

close

public void close()

Deprecated.

debug

public void debug(boolean ind,
                  boolean outd)

Deprecated. Debug is now turned on in a configuration file

This method turns on/off debugging for both the input and output stream of the SMPP connection.

Parameters:

ind - Turns debugging on for the input stream if this is true.

outd - Turns debugging on for the output stream if this is true.

shutdown

public void shutdown()

Deprecated.

This method is used to abort the smpp connection. This should only be used in extreme circumstances where the SMSC is not responding.

acknowledge

public void acknowledge(Message m,
                        boolean success)
                 throws java.io.IOException,
                        SMSException

Deprecated.

Send a acknowledgement (negative or positive) to a received message. Messages that need no acknowledgement will be ignored.

Throws:

java.io.IOException

SMSException

getTimeBetweenRetries

public long getTimeBetweenRetries()

Deprecated.

setTimeBetweenRetries

public void setTimeBetweenRetries(long msec)

Deprecated.

setRequestTimeout

public void setRequestTimeout(int requestTimeout)

Deprecated.

getRequestTimeout

public int getRequestTimeout()

Deprecated.

checkForTimedOutRequests

public void checkForTimedOutRequests()

Deprecated.

getAlphanumericAddressCharacterEncoding

public java.lang.String getAlphanumericAddressCharacterEncoding()

Deprecated.

setAlphanumericAddressCharacterEncoding

public void setAlphanumericAddressCharacterEncoding(java.lang.String alphanumericAddressCharacterEncoding)

Deprecated.

getSmppDecoder

public ie.ncl.sms.smpp.prot.SmppDecoder getSmppDecoder(byte[] bytes)

Deprecated.

getSmppEncoder

public ie.ncl.sms.smpp.prot.SmppEncoder getSmppEncoder()

Deprecated.