|
SMSLib 3.5.3 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.smslib.AGateway
org.smslib.http.ClickatellHTTPGateway
public class ClickatellHTTPGateway
Gateway for Clickatell bulk operator (http://www.clickatell.com) Outbound only - implements HTTP & HTTPS interface.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class org.smslib.AGateway |
---|
AGateway.AsyncEvents, AGateway.GatewayAttributes, AGateway.GatewayStatuses, AGateway.Protocols |
Constructor Summary | |
---|---|
ClickatellHTTPGateway(java.lang.String id,
java.lang.String myApiId,
java.lang.String myUsername,
java.lang.String myPassword)
|
Method Summary | |
---|---|
int |
getQueueSchedulingInterval()
Returns the Gateway Queue sending internal (in milliseconds). |
boolean |
getSecure()
Return the operation mode (HTTP or HTTPS). |
float |
queryBalance()
Queries the gateway for remaining credit. |
boolean |
queryCoverage(OutboundMessage msg)
Queries the gateway to see if a specific message and its recipient are covered. |
StatusReportMessage.DeliveryStatuses |
queryMessage(java.lang.String refNo)
Query the gateway for message delivery status. |
boolean |
sendMessage(OutboundMessage msg)
|
void |
setSecure(boolean mySecure)
Sets whether the gateway works in unsecured (HTTP) or secured (HTTPS) mode. |
void |
startGateway()
|
void |
stopGateway()
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ClickatellHTTPGateway(java.lang.String id, java.lang.String myApiId, java.lang.String myUsername, java.lang.String myPassword)
Method Detail |
---|
public void setSecure(boolean mySecure)
mySecure
- True for HTTPS, false for plain HTTP.public boolean getSecure()
setSecure(boolean)
public void startGateway() throws TimeoutException, GatewayException, java.io.IOException, java.lang.InterruptedException
startGateway
in class AGateway
TimeoutException
GatewayException
java.io.IOException
java.lang.InterruptedException
public void stopGateway() throws TimeoutException, GatewayException, java.io.IOException, java.lang.InterruptedException
stopGateway
in class AGateway
TimeoutException
GatewayException
java.io.IOException
java.lang.InterruptedException
public float queryBalance() throws TimeoutException, GatewayException, java.io.IOException, java.lang.InterruptedException
AGateway
queryBalance
in class AGateway
TimeoutException
- The gateway did not respond in a timely manner.
GatewayException
- A Gateway error occurred.
java.io.IOException
- An IO error occurred.
java.lang.InterruptedException
- The call was interrupted.public boolean queryCoverage(OutboundMessage msg) throws TimeoutException, GatewayException, java.io.IOException, java.lang.InterruptedException
AGateway
queryCoverage
in class AGateway
msg
- The message to test.
TimeoutException
- The gateway did not respond in a timely manner.
GatewayException
- A Gateway error occurred.
java.io.IOException
- An IO error occurred.
java.lang.InterruptedException
- The call was interrupted.public StatusReportMessage.DeliveryStatuses queryMessage(java.lang.String refNo) throws TimeoutException, GatewayException, java.io.IOException, java.lang.InterruptedException
AGateway
queryMessage
in class AGateway
refNo
- The reference number of a previously sent message to be
checked.
TimeoutException
- The gateway did not respond in a timely manner.
GatewayException
- A Gateway error occurred.
java.io.IOException
- An IO error occurred.
java.lang.InterruptedException
- The call was interrupted.StatusReportMessage.DeliveryStatuses
,
AGateway.getDeliveryErrorCode()
public boolean sendMessage(OutboundMessage msg) throws TimeoutException, GatewayException, java.io.IOException, java.lang.InterruptedException
sendMessage
in class AGateway
TimeoutException
GatewayException
java.io.IOException
java.lang.InterruptedException
public int getQueueSchedulingInterval()
AGateway
getQueueSchedulingInterval
in class AGateway
|
SMSLib 3.5.3 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |