org.opennms.sms.reflector.smsservice

Interface SmsService

All Known Implementing Classes:

SmsServiceImpl

public interface SmsService

SmsService interface.

Version:

$Id: $

Author:

ranger

Method Summary

Methods

Modifier and Type	Method and Description
void	addGateway(org.smslib.AGateway gateway) addGateway
boolean	addToGroup(String groupName, String number) addToGroup
boolean	createGroup(String groupName) createGroup
boolean	deleteMessage(org.smslib.InboundMessage msg) deleteMessage
ArrayList<String>	expandGroup(String groupName) expandGroup
org.smslib.AGateway	findGateway(String gatewayId) findGateway
org.smslib.ICallNotification	getCallNotification() getCallNotification
Collection<org.smslib.AGateway>	getGateways() getGateways
org.smslib.AGateway[]	getGatewaysNET() getGatewaysNET
org.smslib.IGatewayStatusNotification	getGatewayStatusNotification() getGatewayStatusNotification
int	getInboundMessageCount() getInboundMessageCount
int	getInboundMessageCount(org.smslib.AGateway gateway) getInboundMessageCount
int	getInboundMessageCount(String gatewayId) getInboundMessageCount
OnmsInboundMessageNotification	getInboundNotification() getInboundNotification
org.smslib.crypto.KeyManager	getKeyManager() getKeyManager
org.smslib.balancing.LoadBalancer	getLoadBalancer() getLoadBalancer
int	getOutboundMessageCount() getOutboundMessageCount
int	getOutboundMessageCount(org.smslib.AGateway gateway) getOutboundMessageCount
int	getOutboundMessageCount(String gatewayId) getOutboundMessageCount
org.smslib.IOutboundMessageNotification	getOutboundNotification() getOutboundNotification
org.smslib.queues.QueueManager	getQueueManager() getQueueManager
org.smslib.IQueueSendingNotification	getQueueSendingNotification() getQueueSendingNotification
org.smslib.routing.Router	getRouter() getRouter
org.smslib.Service.ServiceStatus	getServiceStatus() getServiceStatus
org.smslib.Settings	getSettings() getSettings
long	getStartMillis() getStartMillis
org.smslib.IUSSDNotification	getUSSDNotification() getUSSDNotification
boolean	queueMessage(org.smslib.OutboundMessage msg) queueMessage
boolean	queueMessage(org.smslib.OutboundMessage msg, String gatewayId) queueMessage
int	queueMessages(Collection<org.smslib.OutboundMessage> msgList) queueMessages
int	queueMessages(Collection<org.smslib.OutboundMessage> msgList, String gatewayId) queueMessages
int	queueMessages(org.smslib.OutboundMessage[] msgArray) queueMessages
int	queueMessages(org.smslib.OutboundMessage[] msgArray, String gatewayId) queueMessages
org.smslib.InboundMessage	readMessage(String gatewayId, String memLoc, int memIndex) readMessage
int	readMessages(Collection<org.smslib.InboundMessage> msgList, org.smslib.InboundMessage.MessageClasses msgClass) readMessages
int	readMessages(Collection<org.smslib.InboundMessage> msgList, org.smslib.InboundMessage.MessageClasses msgClass, org.smslib.AGateway gateway) readMessages
int	readMessages(Collection<org.smslib.InboundMessage> msgList, org.smslib.InboundMessage.MessageClasses msgClass, String gatewayId) readMessages
org.smslib.InboundMessage[]	readMessages(org.smslib.InboundMessage.MessageClasses msgClass) readMessages
org.smslib.InboundMessage[]	readMessages(org.smslib.InboundMessage.MessageClasses msgClass, org.smslib.AGateway gateway) readMessages
org.smslib.InboundMessage[]	readMessages(org.smslib.InboundMessage.MessageClasses msgClass, String gatewayId) readMessages
int	readPhonebook(org.smslib.Phonebook phonebook, String gatewayId) readPhonebook
boolean	removeFromGroup(String groupName, String number) removeFromGroup
boolean	removeGateway(org.smslib.AGateway gateway) removeGateway
boolean	removeGroup(String groupName) removeGroup
boolean	removeMessage(org.smslib.OutboundMessage msg) removeMessage
boolean	sendMessage(org.smslib.OutboundMessage msg) sendMessage
boolean	sendMessage(org.smslib.OutboundMessage msg, String gatewayId) sendMessage
int	sendMessages(Collection<org.smslib.OutboundMessage> msgList) sendMessages
int	sendMessages(Collection<org.smslib.OutboundMessage> msgList, String gatewayId) sendMessages
int	sendMessages(org.smslib.OutboundMessage[] msgArray) sendMessages
int	sendMessages(org.smslib.OutboundMessage[] msgArray, String gatewayId) sendMessages
boolean	sendUSSDRequest(org.smslib.USSDRequest req, String gatewayId) sendUSSDRequest
void	setCallNotification(org.smslib.ICallNotification callNotification) setCallNotification
void	setGatewayStatusNotification(org.smslib.IGatewayStatusNotification gatewayStatusNotification) setGatewayStatusNotification
void	setInboundNotification(OnmsInboundMessageNotification inboundNotification) setInboundNotification
void	setLoadBalancer(org.smslib.balancing.LoadBalancer loadBalancer) setLoadBalancer
void	setOutboundNotification(org.smslib.IOutboundMessageNotification outboundNotification) setOutboundNotification
void	setQueueSendingNotification(org.smslib.IQueueSendingNotification queueSendingNotification) setQueueSendingNotification
void	setRouter(org.smslib.routing.Router router) setRouter
void	setUSSDNotification(org.smslib.IUSSDNotification notif) setUSSDNotification
void	startService() startService
void	stopService() stopService

Method Detail

addGateway

void addGateway(org.smslib.AGateway gateway)
                throws org.smslib.GatewayException

addGateway

Parameters:

gateway - a AGateway object.

Throws:

org.smslib.GatewayException - if any.

removeGateway

boolean removeGateway(org.smslib.AGateway gateway)
                      throws org.smslib.GatewayException

removeGateway

Parameters:

gateway - a AGateway object.

Returns:

a boolean.

Throws:

org.smslib.GatewayException - if any.

startService

void startService()
                  throws org.smslib.SMSLibException,
                         org.smslib.TimeoutException,
                         org.smslib.GatewayException,
                         IOException,
                         InterruptedException

startService

Throws:

org.smslib.SMSLibException - if any.

org.smslib.TimeoutException - if any.

org.smslib.GatewayException - if any.

IOException - if any.

InterruptedException - if any.

stopService

void stopService()
                 throws org.smslib.TimeoutException,
                        org.smslib.GatewayException,
                        IOException,
                        InterruptedException

stopService

Throws:

org.smslib.TimeoutException - if any.

org.smslib.GatewayException - if any.

IOException - if any.

InterruptedException - if any.

readMessages

int readMessages(Collection<org.smslib.InboundMessage> msgList,
               org.smslib.InboundMessage.MessageClasses msgClass)
                 throws org.smslib.TimeoutException,
                        org.smslib.GatewayException,
                        IOException,
                        InterruptedException

readMessages

Parameters:

msgList - a Collection object.

msgClass - a InboundMessage.MessageClasses object.

Returns:

a int.

Throws:

org.smslib.TimeoutException - if any.

org.smslib.GatewayException - if any.

IOException - if any.

InterruptedException - if any.

readMessages

org.smslib.InboundMessage[] readMessages(org.smslib.InboundMessage.MessageClasses msgClass)
                                         throws org.smslib.TimeoutException,
                                                org.smslib.GatewayException,
                                                IOException,
                                                InterruptedException

readMessages

Parameters:

msgClass - a InboundMessage.MessageClasses object.

Returns:

an array of InboundMessage objects.

Throws:

org.smslib.TimeoutException - if any.

org.smslib.GatewayException - if any.

IOException - if any.

InterruptedException - if any.

readMessages

int readMessages(Collection<org.smslib.InboundMessage> msgList,
               org.smslib.InboundMessage.MessageClasses msgClass,
               String gatewayId)
                 throws org.smslib.TimeoutException,
                        org.smslib.GatewayException,
                        IOException,
                        InterruptedException

readMessages

Parameters:

msgList - a Collection object.

msgClass - a InboundMessage.MessageClasses object.

gatewayId - a String object.

Returns:

a int.

Throws:

org.smslib.TimeoutException - if any.

org.smslib.GatewayException - if any.

IOException - if any.

InterruptedException - if any.

readMessages

org.smslib.InboundMessage[] readMessages(org.smslib.InboundMessage.MessageClasses msgClass,
                                       String gatewayId)
                                         throws org.smslib.TimeoutException,
                                                org.smslib.GatewayException,
                                                IOException,
                                                InterruptedException

readMessages

Parameters:

msgClass - a InboundMessage.MessageClasses object.

gatewayId - a String object.

Returns:

an array of InboundMessage objects.

Throws:

org.smslib.TimeoutException - if any.

org.smslib.GatewayException - if any.

IOException - if any.

InterruptedException - if any.

readMessages

int readMessages(Collection<org.smslib.InboundMessage> msgList,
               org.smslib.InboundMessage.MessageClasses msgClass,
               org.smslib.AGateway gateway)
                 throws org.smslib.TimeoutException,
                        org.smslib.GatewayException,
                        IOException,
                        InterruptedException

readMessages

Parameters:

msgList - a Collection object.

msgClass - a InboundMessage.MessageClasses object.

gateway - a AGateway object.

Returns:

a int.

Throws:

org.smslib.TimeoutException - if any.

org.smslib.GatewayException - if any.

IOException - if any.

InterruptedException - if any.

readMessages

org.smslib.InboundMessage[] readMessages(org.smslib.InboundMessage.MessageClasses msgClass,
                                       org.smslib.AGateway gateway)
                                         throws org.smslib.TimeoutException,
                                                org.smslib.GatewayException,
                                                IOException,
                                                InterruptedException

readMessages

Parameters:

msgClass - a InboundMessage.MessageClasses object.

gateway - a AGateway object.

Returns:

an array of InboundMessage objects.

Throws:

org.smslib.TimeoutException - if any.

org.smslib.GatewayException - if any.

IOException - if any.

InterruptedException - if any.

readMessage

org.smslib.InboundMessage readMessage(String gatewayId,
                                    String memLoc,
                                    int memIndex)
                                      throws org.smslib.TimeoutException,
                                             org.smslib.GatewayException,
                                             IOException,
                                             InterruptedException

readMessage

Parameters:

gatewayId - a String object.

memLoc - a String object.

memIndex - a int.

Returns:

a InboundMessage object.

Throws:

org.smslib.TimeoutException - if any.

org.smslib.GatewayException - if any.

IOException - if any.

InterruptedException - if any.

sendMessage

boolean sendMessage(org.smslib.OutboundMessage msg)
                    throws org.smslib.TimeoutException,
                           org.smslib.GatewayException,
                           IOException,
                           InterruptedException

sendMessage

Parameters:

msg - a OutboundMessage object.

Returns:

a boolean.

Throws:

org.smslib.TimeoutException - if any.

org.smslib.GatewayException - if any.

IOException - if any.

InterruptedException - if any.

sendMessage

boolean sendMessage(org.smslib.OutboundMessage msg,
                  String gatewayId)
                    throws org.smslib.TimeoutException,
                           org.smslib.GatewayException,
                           IOException,
                           InterruptedException

sendMessage

Parameters:

msg - a OutboundMessage object.

gatewayId - a String object.

Returns:

a boolean.

Throws:

org.smslib.TimeoutException - if any.

org.smslib.GatewayException - if any.

IOException - if any.

InterruptedException - if any.

sendMessages

int sendMessages(Collection<org.smslib.OutboundMessage> msgList)
                 throws org.smslib.TimeoutException,
                        org.smslib.GatewayException,
                        IOException,
                        InterruptedException

sendMessages

Parameters:

msgList - a Collection object.

Returns:

a int.

Throws:

org.smslib.TimeoutException - if any.

org.smslib.GatewayException - if any.

IOException - if any.

InterruptedException - if any.

sendMessages

int sendMessages(org.smslib.OutboundMessage[] msgArray)
                 throws org.smslib.TimeoutException,
                        org.smslib.GatewayException,
                        IOException,
                        InterruptedException

sendMessages

Parameters:

msgArray - an array of OutboundMessage objects.

Returns:

a int.

Throws:

org.smslib.TimeoutException - if any.

org.smslib.GatewayException - if any.

IOException - if any.

InterruptedException - if any.

sendMessages

int sendMessages(Collection<org.smslib.OutboundMessage> msgList,
               String gatewayId)
                 throws org.smslib.TimeoutException,
                        org.smslib.GatewayException,
                        IOException,
                        InterruptedException

sendMessages

Parameters:

msgList - a Collection object.

gatewayId - a String object.

Returns:

a int.

Throws:

org.smslib.TimeoutException - if any.

org.smslib.GatewayException - if any.

IOException - if any.

InterruptedException - if any.

sendMessages

int sendMessages(org.smslib.OutboundMessage[] msgArray,
               String gatewayId)
                 throws org.smslib.TimeoutException,
                        org.smslib.GatewayException,
                        IOException,
                        InterruptedException

sendMessages

Parameters:

msgArray - an array of OutboundMessage objects.

gatewayId - a String object.

Returns:

a int.

Throws:

org.smslib.TimeoutException - if any.

org.smslib.GatewayException - if any.

IOException - if any.

InterruptedException - if any.

queueMessage

boolean queueMessage(org.smslib.OutboundMessage msg)

queueMessage

Parameters:

msg - a OutboundMessage object.

Returns:

a boolean.

queueMessage

boolean queueMessage(org.smslib.OutboundMessage msg,
                   String gatewayId)

queueMessage

Parameters:

msg - a OutboundMessage object.

gatewayId - a String object.

Returns:

a boolean.

queueMessages

int queueMessages(Collection<org.smslib.OutboundMessage> msgList)

queueMessages

Parameters:

msgList - a Collection object.

Returns:

a int.

queueMessages

int queueMessages(org.smslib.OutboundMessage[] msgArray)

queueMessages

Parameters:

msgArray - an array of OutboundMessage objects.

Returns:

a int.

queueMessages

int queueMessages(Collection<org.smslib.OutboundMessage> msgList,
                String gatewayId)

queueMessages

Parameters:

msgList - a Collection object.

gatewayId - a String object.

Returns:

a int.

queueMessages

int queueMessages(org.smslib.OutboundMessage[] msgArray,
                String gatewayId)

queueMessages

Parameters:

msgArray - an array of OutboundMessage objects.

gatewayId - a String object.

Returns:

a int.

removeMessage

boolean removeMessage(org.smslib.OutboundMessage msg)

removeMessage

Parameters:

msg - a OutboundMessage object.

Returns:

a boolean.

deleteMessage

boolean deleteMessage(org.smslib.InboundMessage msg)
                      throws org.smslib.TimeoutException,
                             org.smslib.GatewayException,
                             IOException,
                             InterruptedException

deleteMessage

Parameters:

msg - a InboundMessage object.

Returns:

a boolean.

Throws:

org.smslib.TimeoutException - if any.

org.smslib.GatewayException - if any.

IOException - if any.

InterruptedException - if any.

readPhonebook

int readPhonebook(org.smslib.Phonebook phonebook,
                String gatewayId)
                  throws org.smslib.TimeoutException,
                         org.smslib.GatewayException,
                         IOException,
                         InterruptedException

readPhonebook

Parameters:

phonebook - a Phonebook object.

gatewayId - a String object.

Returns:

a int.

Throws:

org.smslib.TimeoutException - if any.

org.smslib.GatewayException - if any.

IOException - if any.

InterruptedException - if any.

getInboundMessageCount

int getInboundMessageCount(String gatewayId)

getInboundMessageCount

Parameters:

gatewayId - a String object.

Returns:

a int.

getInboundMessageCount

int getInboundMessageCount(org.smslib.AGateway gateway)

getInboundMessageCount

Parameters:

gateway - a AGateway object.

Returns:

a int.

getOutboundMessageCount

int getOutboundMessageCount(String gatewayId)

getOutboundMessageCount

Parameters:

gatewayId - a String object.

Returns:

a int.

getOutboundMessageCount

int getOutboundMessageCount(org.smslib.AGateway gateway)

getOutboundMessageCount

Parameters:

gateway - a AGateway object.

Returns:

a int.

getInboundMessageCount

int getInboundMessageCount()

getInboundMessageCount

Returns:

a int.

getOutboundMessageCount

int getOutboundMessageCount()

getOutboundMessageCount

Returns:

a int.

findGateway

org.smslib.AGateway findGateway(String gatewayId)

findGateway

Parameters:

gatewayId - a String object.

Returns:

a AGateway object.

getGateways

Collection<org.smslib.AGateway> getGateways()

getGateways

Returns:

a Collection object.

getGatewaysNET

org.smslib.AGateway[] getGatewaysNET()

getGatewaysNET

Returns:

an array of AGateway objects.

getLoadBalancer

org.smslib.balancing.LoadBalancer getLoadBalancer()

getLoadBalancer

Returns:

a LoadBalancer object.

setLoadBalancer

void setLoadBalancer(org.smslib.balancing.LoadBalancer loadBalancer)

setLoadBalancer

Parameters:

loadBalancer - a LoadBalancer object.

getRouter

org.smslib.routing.Router getRouter()

getRouter

Returns:

a Router object.

setRouter

void setRouter(org.smslib.routing.Router router)

setRouter

Parameters:

router - a Router object.

getInboundNotification

OnmsInboundMessageNotification getInboundNotification()

getInboundNotification

Returns:

a OnmsInboundMessageNotification object.

setInboundNotification

void setInboundNotification(OnmsInboundMessageNotification inboundNotification)

setInboundNotification

Parameters:

inboundNotification - a OnmsInboundMessageNotification object.

getOutboundNotification

org.smslib.IOutboundMessageNotification getOutboundNotification()

getOutboundNotification

Returns:

a IOutboundMessageNotification object.

setOutboundNotification

void setOutboundNotification(org.smslib.IOutboundMessageNotification outboundNotification)

setOutboundNotification

Parameters:

outboundNotification - a IOutboundMessageNotification object.

getCallNotification

org.smslib.ICallNotification getCallNotification()

getCallNotification

Returns:

a ICallNotification object.

setCallNotification

void setCallNotification(org.smslib.ICallNotification callNotification)

setCallNotification

Parameters:

callNotification - a ICallNotification object.

getGatewayStatusNotification

org.smslib.IGatewayStatusNotification getGatewayStatusNotification()

getGatewayStatusNotification

Returns:

a IGatewayStatusNotification object.

setGatewayStatusNotification

void setGatewayStatusNotification(org.smslib.IGatewayStatusNotification gatewayStatusNotification)

setGatewayStatusNotification

Parameters:

gatewayStatusNotification - a IGatewayStatusNotification object.

getQueueSendingNotification

org.smslib.IQueueSendingNotification getQueueSendingNotification()

getQueueSendingNotification

Returns:

a IQueueSendingNotification object.

setQueueSendingNotification

void setQueueSendingNotification(org.smslib.IQueueSendingNotification queueSendingNotification)

setQueueSendingNotification

Parameters:

queueSendingNotification - a IQueueSendingNotification object.

getStartMillis

long getStartMillis()

getStartMillis

Returns:

a long.

getServiceStatus

org.smslib.Service.ServiceStatus getServiceStatus()

getServiceStatus

Returns:

a Service.ServiceStatus object.

getSettings

org.smslib.Settings getSettings()

getSettings

Returns:

a Settings object.

createGroup

boolean createGroup(String groupName)

createGroup

Parameters:

groupName - a String object.

Returns:

a boolean.

removeGroup

boolean removeGroup(String groupName)

removeGroup

Parameters:

groupName - a String object.

Returns:

a boolean.

expandGroup

ArrayList<String> expandGroup(String groupName)

expandGroup

Parameters:

groupName - a String object.

Returns:

a ArrayList object.

addToGroup

boolean addToGroup(String groupName,
                 String number)

addToGroup

Parameters:

groupName - a String object.

number - a String object.

Returns:

a boolean.

removeFromGroup

boolean removeFromGroup(String groupName,
                      String number)

removeFromGroup

Parameters:

groupName - a String object.

number - a String object.

Returns:

a boolean.

getQueueManager

org.smslib.queues.QueueManager getQueueManager()

getQueueManager

Returns:

a QueueManager object.

getKeyManager

org.smslib.crypto.KeyManager getKeyManager()

getKeyManager

Returns:

a KeyManager object.

sendUSSDRequest

boolean sendUSSDRequest(org.smslib.USSDRequest req,
                      String gatewayId)
                        throws org.smslib.GatewayException,
                               org.smslib.TimeoutException,
                               IOException,
                               InterruptedException

sendUSSDRequest

Parameters:

req - a USSDRequest object.

gatewayId - a String object.

Returns:

a boolean.

Throws:

org.smslib.GatewayException - if any.

org.smslib.TimeoutException - if any.

IOException - if any.

InterruptedException - if any.

setUSSDNotification

void setUSSDNotification(org.smslib.IUSSDNotification notif)

setUSSDNotification

Parameters:

notif - a IUSSDNotification object.

getUSSDNotification

org.smslib.IUSSDNotification getUSSDNotification()

getUSSDNotification

Returns:

a IUSSDNotification object.