se.entra.phantom.server.extra

Class SMSSender

java.lang.Object

se.entra.phantom.server.sms.Client

se.entra.phantom.server.extra.SMSSender

All Implemented Interfaces:

Serializable

public class SMSSender
extends Client

A class that provides an example of an implemented SMS service.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SMSSender(String appId, String server, int port, String keyFileName) Constructor for stand alone.
SMSSender(String appId, String server, int port, String keyFileName, EventMessengerInterface messenger, String signatureAlgorithm, String signatureProvider) Constructor for NetPhantom integration.

Method Summary

Modifier and Type	Method and Description
RequestHandler	connect() Connects to the SMS server.
void	disconnectMe() Method used to disconnect from the SMS server.
static SMSSender	getInstance() Method to access this single instance.
void	log(int eventId, String msg) If we are stand-alone.
String	sendAMessage(Message message) Method to send a message.
String	sendAMessage(Message message, boolean queue) Method to send a message.
String	sendAMessage(String phoneNumber, String msg) Method to send a message.

Methods inherited from class se.entra.phantom.server.sms.Client

disconnect, getNextMessage, isConnected, numberOfWaitingMessages, send

Methods inherited from class java.lang.Object

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

Constructor Detail

SMSSender

public SMSSender(String appId,
                 String server,
                 int port,
                 String keyFileName,
                 EventMessengerInterface messenger,
                 String signatureAlgorithm,
                 String signatureProvider)
          throws ConnectionException

Constructor for NetPhantom integration.

Parameters:

appId - application identification

server -

port -

keyFileName -

messenger -

signatureAlgorithm -

signatureProvider -

Throws:

ConnectionException - for set-up errors.

SMSSender

public SMSSender(String appId,
                 String server,
                 int port,
                 String keyFileName)
          throws ConnectionException

Constructor for stand alone.

Parameters:

appId - application identification

server -

port -

keyFileName -

Throws:

ConnectionException - for set-up errors.

Method Detail

connect

public RequestHandler connect()

Connects to the SMS server.

Overrides:

connect in class Client

Returns:

true for success, false for failure.

sendAMessage

public String sendAMessage(String phoneNumber,
                           String msg)

Method to send a message.

Parameters:

phoneNumber -

msg - message string to send.

Returns:

null for success, otherwise the error text.

sendAMessage

public String sendAMessage(Message message)

Method to send a message.

Parameters:

message - to send.

Returns:

null for success, otherwise the error text.

sendAMessage

public String sendAMessage(Message message,
                           boolean queue)

Method to send a message.

Parameters:

message - to send.

queue - true for putting the message in the send queue.

Returns:

null for success, otherwise the error text.

disconnectMe

public void disconnectMe()

Method used to disconnect from the SMS server.

getInstance

public static SMSSender getInstance()

Method to access this single instance.

Returns:

null if the sender is not started.

log

public void log(int eventId,
                String msg)

If we are stand-alone. Do not log to SMSEventMessenger

Parameters:

eventId - The event ID.

msg - Message to log.