org.swiftsms.io.net

Class Operator

java.lang.Object

org.swiftsms.io.net.Operator

Direct Known Subclasses:

EMobile, Meteor, NewMeteor, O2, Tesco, Three

public abstract class Operator
extends Object

This class contains all of the generic methods and actions needed for interaction with an operators website.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_CHAR_LIMIT
protected org.apache.commons.codec.net.URLCodec	encoder

Constructor Summary

Constructors

Constructor and Description
Operator(Account account) Create a new Operator using the provided account.

Method Summary

Modifier and Type	Method and Description
Account	getAccount() This method returns the Account used to construct this instance of Operator.
int	getCharacterLimit()
int	getRemainingSMS() This method is used to get the users remaining SMS count from an operators website.
OperationResult	login() This method is used to login to an operators website.
OperationResult	send(List<String> list, String message) This method is responsible for sending an SMS message through the operators website.
protected String	uriDecode(String message)
protected String	uriEncode(String message)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CHAR_LIMIT

public static final int DEFAULT_CHAR_LIMIT

See Also:

Constant Field Values

encoder

protected final org.apache.commons.codec.net.URLCodec encoder

Constructor Detail

Operator

public Operator(Account account)

Create a new Operator using the provided account.

Parameters:

account - The users Account.

Method Detail

login

public final OperationResult login()

This method is used to login to an operators website. This method will perform any non-network-specific login actions. Each sub-class of Operator will implement the specific login algorithm in the doLogin() method.

Returns:

true if the login was successful else false

getRemainingSMS

public final int getRemainingSMS()

This method is used to get the users remaining SMS count from an operators website. This method will perform any non-network-specific actions. Each sub-class of Operator will implement the specific get algorithm in the doGetRemainingSMS() method.

Returns:

the number of remaining SMS messages the user has or -1 if it can't be determined.

send

public final OperationResult send(List<String> list,
                                  String message)

This method is responsible for sending an SMS message through the operators website. This method will perform any non-network-specific send actions. Each sub-class of Operator will implement the specific send algorithm in the doSend(List, String) method.

Parameters:

list - A list of phone numbers the message will be sent to.

message - The message to send.

Returns:

true if the message was sent successfully else false

getCharacterLimit

public final int getCharacterLimit()

getAccount

public Account getAccount()

This method returns the Account used to construct this instance of Operator. It contains the users details.

Returns:

The users Account

uriEncode

protected String uriEncode(String message)

uriDecode

protected String uriDecode(String message)