public class GatewayExecutor
extends java.lang.Object
Modifier and Type | Class and Description |
---|---|
static class |
GatewayExecutor.Problem |
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
INFO_CREDIT_REMAINING
Message saying how much credit is remaining.
|
static java.lang.String |
INFO_FREE_SMS_REMAINING
Message saying how many free SMS are remaining.
|
static java.lang.String |
INFO_STATUS_NOT_PROVIDED
Message used when gateway provides no info whether message was successfully sent or not.
|
Constructor and Description |
---|
GatewayExecutor(SMS sms) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
extractCountryPrefix(java.lang.String phoneNumber)
Extract country prefix from phone number.
|
void |
forgetCookie(java.lang.String name,
java.lang.String domain,
java.lang.String path)
|
java.lang.Object |
getURL(java.lang.String url,
java.lang.String[] params)
Make a GET request to a provided URL
|
java.lang.Object |
postURL(java.lang.String url,
java.lang.String[] params,
java.lang.String[] postData)
Make a POST request with specified data to a provided URL.
|
java.lang.String |
recognizeImage(byte[] imageBytes,
java.lang.String hint)
Ask user to recognize provided image code
|
void |
setProblem(java.lang.Object problem)
Same as calling setProblem(problem, null).
|
void |
setProblem(java.lang.Object problem,
java.lang.String param)
Problem displayed when sending was unsuccessful.
|
void |
setReferer(java.lang.String referer)
Referer (HTTP 'Referer' header) used for all following requests.
|
void |
setSupplementalMessage(java.lang.String supplMessage)
Optional supplemental message from gateway that is shown after message sending.
|
void |
sleep(long milliseconds)
Pauses the execution for specified amount of time.
|
public static final java.lang.String INFO_FREE_SMS_REMAINING
public static final java.lang.String INFO_CREDIT_REMAINING
public static final java.lang.String INFO_STATUS_NOT_PROVIDED
public GatewayExecutor(SMS sms)
public void forgetCookie(java.lang.String name, java.lang.String domain, java.lang.String path)
public java.lang.Object getURL(java.lang.String url, java.lang.String[] params) throws java.io.IOException
url
- base url where to connect, without any parameters or "?" at the end.
In special cases when you don't use params, you can use url as a full url.
But don't forget that parameters values must be url-encoded, which you can't
do properly in JavaScript.params
- array of url params in form [key1,value1,key2,value2,...]java.io.IOException
- when there is some problem in connectingpublic java.lang.Object postURL(java.lang.String url, java.lang.String[] params, java.lang.String[] postData) throws java.io.IOException
url
- base url where to connect, without any parameters or "?" at the end.
In special cases when you don't use params, you can use url as a full url.
But don't forget that parameters values must be url-encoded, which you can't
do properly in JavaScript.params
- array of url params in form [key1,value1,key2,value2,...]postData
- array of data to be sent in the request in form [key1,value1,key2,value2,...].
This data will be properly url-encoded before sending.java.io.IOException
- when there is some problem in connectingpublic java.lang.String recognizeImage(byte[] imageBytes, java.lang.String hint) throws java.lang.InterruptedException, java.lang.reflect.InvocationTargetException, java.util.concurrent.ExecutionException
imageBytes
- image bytearray. Java must be able to display this image
(PNG, GIF, JPEG, maybe something else).hint
- optional hint that can gateway say to user.java.lang.InterruptedException
java.lang.reflect.InvocationTargetException
java.util.concurrent.ExecutionException
public void setProblem(java.lang.Object problem)
public void setProblem(java.lang.Object problem, java.lang.String param)
problem
- problem from Problem enumparam
- some problems require additional string parameter, see their descriptionpublic void setSupplementalMessage(java.lang.String supplMessage)
public void setReferer(java.lang.String referer)
public void sleep(long milliseconds) throws java.lang.InterruptedException
java.lang.InterruptedException
public java.lang.String extractCountryPrefix(java.lang.String phoneNumber)
phoneNumber
- Phone number in fully international format. May be null or
incomplete.