com.DeathByCaptcha

Class Client

java.lang.Object

com.DeathByCaptcha.Client

Direct Known Subclasses:

HttpClient, SocketClient

public abstract class Client
extends java.lang.Object

Base Death by Captcha API client.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	API_VERSION
static int	DEFAULT_TIMEOUT
static int	DEFAULT_TOKEN_TIMEOUT
static int	DFLT_POLL_INTERVAL
boolean	isVerbose Client verbosity flag.
static int	LEN_POLLS_INTERVAL
static int[]	POLLS_INTERVAL
static int	SOFTWARE_VENDOR_ID

Constructor Summary

Constructors

Constructor and Description
Client(java.lang.String username, java.lang.String password)

Method Summary

Modifier and Type	Method and Description
abstract void	close() Closes opened connections (if any), cleans up resources.
abstract boolean	connect() Opens API-specific connection if not opened yet.
Captcha	decode(byte[] img)
Captcha	decode(byte[] img, int type)
Captcha	decode(byte[] img, int type, byte[] banner, java.lang.String banner_text)
Captcha	decode(byte[] img, int type, int timeout)
Captcha	decode(byte[] img, java.lang.String challenge)
Captcha	decode(byte[] img, java.lang.String challenge, int timeout)
Captcha	decode(byte[] img, java.lang.String challenge, int type, byte[] banner, java.lang.String banner_text, int timeout)
Captcha	decode(byte[] img, java.lang.String challenge, int type, byte[] banner, java.lang.String banner_text, java.lang.String grid, int timeout) Tries to solve a CAPTCHA by uploading it and polling for its status and text with arbitrary timeout.
Captcha	decode(java.io.File f)
Captcha	decode(java.io.File f, int timeout)
Captcha	decode(java.io.File f, int type, java.io.File banner_f, java.lang.String banner_text)
Captcha	decode(java.io.File f, int type, int timeout)
Captcha	decode(java.io.File f, java.lang.String challenge)
Captcha	decode(java.io.File f, java.lang.String challenge, int timeout)
Captcha	decode(java.io.File f, java.lang.String challenge, int type, java.io.File banner_f, java.lang.String banner_text, int timeout)
Captcha	decode(java.io.InputStream st)
Captcha	decode(java.io.InputStream st, int timeout)
Captcha	decode(java.io.InputStream st, int type, java.io.InputStream banner_st, java.lang.String banner_text)
Captcha	decode(java.io.InputStream st, int type, java.io.InputStream banner_st, java.lang.String banner_text, java.lang.String grid)
Captcha	decode(java.io.InputStream st, int type, int timeout)
Captcha	decode(java.io.InputStream st, java.lang.String challenge)
Captcha	decode(java.io.InputStream st, java.lang.String challenge, int timeout)
Captcha	decode(java.io.InputStream st, java.lang.String challenge, int type, java.io.InputStream banner_st, java.lang.String banner_text, int timeout)
Captcha	decode(java.io.InputStream st, java.lang.String challenge, int type, java.io.InputStream banner_st, java.lang.String banner_text, java.lang.String grid, int timeout)
Captcha	decode(org.json.JSONObject json)
Captcha	decode(org.json.JSONObject json, int timeout)
Captcha	decode(java.lang.String fn)
Captcha	decode(java.lang.String fn, int timeout)
Captcha	decode(java.lang.String fn, int type, int timeout)
Captcha	decode(java.lang.String fn, int type, java.lang.String banner_fn, java.lang.String banner_text)
Captcha	decode(java.lang.String fn, int type, java.lang.String banner_fn, java.lang.String banner_text, int timeout)
Captcha	decode(java.lang.String fn, java.lang.String challenge)
Captcha	decode(java.lang.String fn, java.lang.String challenge, int timeout)
Captcha	decode(java.lang.String fn, java.lang.String challenge, int type, java.lang.String banner_fn, java.lang.String banner_text, int timeout)
Captcha	decode(java.lang.String proxy, java.lang.String proxytype, java.lang.String sitekey, java.lang.String pageurl)
Captcha	decode(java.lang.String proxy, java.lang.String proxytype, java.lang.String sitekey, java.lang.String pageurl, int timeout)
double	getBalance() Fetches user balance (in US cents).
Captcha	getCaptcha(Captcha captcha)
abstract Captcha	getCaptcha(int id) Fetches an uploaded CAPTCHA details.
static int[]	getPollInterval(int idx)
java.lang.String	getText(Captcha captcha)
java.lang.String	getText(int id) Fetches an uploaded CAPTCHA text.
abstract User	getUser() Fetches user details.
byte[]	load(java.lang.String fn)
boolean	report(Captcha captcha)
abstract boolean	report(int id) Reports an incorrectly solved CAPTCHA
abstract Captcha	upload(byte[] img)
abstract Captcha	upload(byte[] img, int type, byte[] banner, java.lang.String banner_text)
abstract Captcha	upload(byte[] img, java.lang.String challenge, int type, byte[] banner, java.lang.String banner_text)
abstract Captcha	upload(byte[] img, java.lang.String challenge, int type, byte[] banner, java.lang.String banner_text, java.lang.String grid) Uploads a CAPTCHA to the service.
Captcha	upload(java.io.File f)
Captcha	upload(java.io.InputStream st)
abstract Captcha	upload(int type, org.json.JSONObject json)
Captcha	upload(int type, java.lang.String proxy, java.lang.String proxytype, java.lang.String sitekey, java.lang.String pageurl)
Captcha	upload(java.lang.String fn)

Methods inherited from class java.lang.Object

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

Field Detail

API_VERSION

public static final java.lang.String API_VERSION

See Also:

Constant Field Values

SOFTWARE_VENDOR_ID

public static final int SOFTWARE_VENDOR_ID

See Also:

Constant Field Values

DEFAULT_TIMEOUT

public static final int DEFAULT_TIMEOUT

See Also:

Constant Field Values

DEFAULT_TOKEN_TIMEOUT

public static final int DEFAULT_TOKEN_TIMEOUT

See Also:

Constant Field Values

POLLS_INTERVAL

public static final int[] POLLS_INTERVAL

DFLT_POLL_INTERVAL

public static final int DFLT_POLL_INTERVAL

See Also:

Constant Field Values

LEN_POLLS_INTERVAL

public static final int LEN_POLLS_INTERVAL

isVerbose

public boolean isVerbose

Client verbosity flag. When it's set to true, the client will dump API calls for debug purpose.

Constructor Detail

Client

public Client(java.lang.String username,
              java.lang.String password)

Parameters:

username - DBC account username

password - DBC account password

Method Detail

load

public byte[] load(java.lang.String fn)
            throws java.io.IOException,
                   java.io.FileNotFoundException

Throws:

java.io.IOException

java.io.FileNotFoundException

close

public abstract void close()

Closes opened connections (if any), cleans up resources.

connect

public abstract boolean connect()
                         throws java.io.IOException

Opens API-specific connection if not opened yet.

Returns:

true on success

Throws:

java.io.IOException

getUser

public abstract User getUser()
                      throws java.io.IOException,
                             Exception

Fetches user details.

Returns:

user details object

Throws:

java.io.IOException

Exception

getBalance

public double getBalance()
                  throws java.io.IOException,
                         Exception

Fetches user balance (in US cents).

Returns:

user balance

Throws:

java.io.IOException

Exception

upload

public abstract Captcha upload(byte[] img,
                               java.lang.String challenge,
                               int type,
                               byte[] banner,
                               java.lang.String banner_text,
                               java.lang.String grid)
                        throws java.io.IOException,
                               Exception

Uploads a CAPTCHA to the service.

Parameters:

img - CAPTCHA image byte vector

Returns:

CAPTCHA object on success, null otherwise

Throws:

java.io.IOException

Exception

upload

public abstract Captcha upload(byte[] img,
                               java.lang.String challenge,
                               int type,
                               byte[] banner,
                               java.lang.String banner_text)
                        throws java.io.IOException,
                               Exception

Throws:

java.io.IOException

Exception

upload

public abstract Captcha upload(byte[] img,
                               int type,
                               byte[] banner,
                               java.lang.String banner_text)
                        throws java.io.IOException,
                               Exception

Throws:

java.io.IOException

Exception

upload

public abstract Captcha upload(byte[] img)
                        throws java.io.IOException,
                               Exception

Throws:

java.io.IOException

Exception

upload

public Captcha upload(java.io.InputStream st)
               throws java.io.IOException,
                      Exception

Parameters:

st - CAPTCHA image stream

Throws:

java.io.IOException

Exception

See Also:

upload(byte[], java.lang.String, int, byte[], java.lang.String, java.lang.String)

upload

public Captcha upload(java.io.File f)
               throws java.io.IOException,
                      java.io.FileNotFoundException,
                      Exception

Parameters:

f - CAPTCHA image file

Throws:

java.io.IOException

java.io.FileNotFoundException

Exception

See Also:

upload(byte[], java.lang.String, int, byte[], java.lang.String, java.lang.String)

upload

public Captcha upload(java.lang.String fn)
               throws java.io.IOException,
                      java.io.FileNotFoundException,
                      Exception

Parameters:

fn - CAPTCHA image file name

Throws:

java.io.IOException

java.io.FileNotFoundException

Exception

See Also:

upload(byte[], java.lang.String, int, byte[], java.lang.String, java.lang.String)

upload

public Captcha upload(int type,
                      java.lang.String proxy,
                      java.lang.String proxytype,
                      java.lang.String sitekey,
                      java.lang.String pageurl)
               throws java.io.IOException,
                      Exception

Parameters:

type - CAPTCHA type

proxy - User proxy

proxytype - User proxy type

sitekey - Site Google Key

pageurl - Site url

Throws:

java.io.IOException

Exception

See Also:

upload(byte[], java.lang.String, int, byte[], java.lang.String, java.lang.String)

upload

public abstract Captcha upload(int type,
                               org.json.JSONObject json)
                        throws java.io.IOException,
                               Exception

Throws:

java.io.IOException

Exception

getCaptcha

public abstract Captcha getCaptcha(int id)
                            throws java.io.IOException,
                                   Exception

Fetches an uploaded CAPTCHA details.

Parameters:

id - CAPTCHA ID

Returns:

CAPTCHA object if found, null otherwise

Throws:

java.io.IOException

Exception

getCaptcha

public Captcha getCaptcha(Captcha captcha)
                   throws java.io.IOException,
                          Exception

Parameters:

captcha - CAPTCHA object

Throws:

java.io.IOException

Exception

See Also:

getCaptcha(int)

getText

public java.lang.String getText(int id)
                         throws java.io.IOException,
                                Exception

Fetches an uploaded CAPTCHA text.

Parameters:

id - CAPTCHA ID

Returns:

CAPTCHA text if solved, null otherwise

Throws:

java.io.IOException

Exception

getText

public java.lang.String getText(Captcha captcha)
                         throws java.io.IOException,
                                Exception

Parameters:

captcha - CAPTCHA object

Throws:

java.io.IOException

Exception

See Also:

getText(int)

report

public abstract boolean report(int id)
                        throws java.io.IOException,
                               Exception

Reports an incorrectly solved CAPTCHA

Parameters:

id - CAPTCHA ID

Returns:

true on success

Throws:

java.io.IOException

Exception

report

public boolean report(Captcha captcha)
               throws java.io.IOException,
                      Exception

Parameters:

captcha - CAPTCHA object

Throws:

java.io.IOException

Exception

See Also:

report(int)

decode

public Captcha decode(byte[] img,
                      java.lang.String challenge,
                      int type,
                      byte[] banner,
                      java.lang.String banner_text,
                      java.lang.String grid,
                      int timeout)
               throws java.io.IOException,
                      Exception,
                      java.lang.InterruptedException

Tries to solve a CAPTCHA by uploading it and polling for its status and text with arbitrary timeout.

Parameters:

img - CAPTCHA image byte vector

timeout - Solving timeout (in seconds)

Returns:

CAPTCHA object if uploaded and correctly solved, null otherwise

Throws:

java.io.IOException

Exception

java.lang.InterruptedException

decode

public Captcha decode(byte[] img,
                      java.lang.String challenge,
                      int type,
                      byte[] banner,
                      java.lang.String banner_text,
                      int timeout)
               throws java.io.IOException,
                      Exception,
                      java.lang.InterruptedException

Throws:

java.io.IOException

Exception

java.lang.InterruptedException

decode

public Captcha decode(byte[] img,
                      int type,
                      byte[] banner,
                      java.lang.String banner_text)
               throws java.io.IOException,
                      Exception,
                      java.lang.InterruptedException

Throws:

java.io.IOException

Exception

java.lang.InterruptedException

decode

public Captcha decode(byte[] img,
                      int type)
               throws java.io.IOException,
                      Exception,
                      java.lang.InterruptedException

Throws:

java.io.IOException

Exception

java.lang.InterruptedException

decode

public Captcha decode(byte[] img,
                      java.lang.String challenge)
               throws java.io.IOException,
                      Exception,
                      java.lang.InterruptedException

Throws:

java.io.IOException

Exception

java.lang.InterruptedException

decode

public Captcha decode(byte[] img,
                      int type,
                      int timeout)
               throws java.io.IOException,
                      Exception,
                      java.lang.InterruptedException

Throws:

java.io.IOException

Exception

java.lang.InterruptedException

decode

public Captcha decode(byte[] img,
                      java.lang.String challenge,
                      int timeout)
               throws java.io.IOException,
                      Exception,
                      java.lang.InterruptedException

Throws:

java.io.IOException

Exception

java.lang.InterruptedException

decode

public Captcha decode(byte[] img)
               throws java.io.IOException,
                      Exception,
                      java.lang.InterruptedException

Throws:

java.io.IOException

Exception

java.lang.InterruptedException

See Also:

decode(byte[], int)

decode

public Captcha decode(java.io.InputStream st,
                      java.lang.String challenge,
                      int type,
                      java.io.InputStream banner_st,
                      java.lang.String banner_text,
                      java.lang.String grid,
                      int timeout)
               throws java.io.IOException,
                      Exception,
                      java.lang.InterruptedException

Parameters:

st - CAPTCHA image stream

timeout - Solving timeout (in seconds)

Throws:

java.io.IOException

Exception

java.lang.InterruptedException

See Also:

decode(byte[], java.lang.String, int, byte[], java.lang.String, java.lang.String, int)

decode

public Captcha decode(java.io.InputStream st,
                      java.lang.String challenge,
                      int type,
                      java.io.InputStream banner_st,
                      java.lang.String banner_text,
                      int timeout)
               throws java.io.IOException,
                      Exception,
                      java.lang.InterruptedException

Throws:

java.io.IOException

Exception

java.lang.InterruptedException

decode

public Captcha decode(java.io.InputStream st,
                      int type,
                      java.io.InputStream banner_st,
                      java.lang.String banner_text,
                      java.lang.String grid)
               throws java.io.IOException,
                      Exception,
                      java.lang.InterruptedException

Throws:

java.io.IOException

Exception

java.lang.InterruptedException

decode

public Captcha decode(java.io.InputStream st,
                      int type,
                      java.io.InputStream banner_st,
                      java.lang.String banner_text)
               throws java.io.IOException,
                      Exception,
                      java.lang.InterruptedException

Throws:

java.io.IOException

Exception

java.lang.InterruptedException

decode

public Captcha decode(java.io.InputStream st,
                      int type,
                      int timeout)
               throws java.io.IOException,
                      Exception,
                      java.lang.InterruptedException

Throws:

java.io.IOException

Exception

java.lang.InterruptedException

decode

public Captcha decode(java.io.InputStream st,
                      java.lang.String challenge)
               throws java.io.IOException,
                      Exception,
                      java.lang.InterruptedException

Throws:

java.io.IOException

Exception

java.lang.InterruptedException

decode

public Captcha decode(java.io.InputStream st,
                      java.lang.String challenge,
                      int timeout)
               throws java.io.IOException,
                      Exception,
                      java.lang.InterruptedException

Throws:

java.io.IOException

Exception

java.lang.InterruptedException

decode

public Captcha decode(java.io.InputStream st,
                      int timeout)
               throws java.io.IOException,
                      Exception,
                      java.lang.InterruptedException

Throws:

java.io.IOException

Exception

java.lang.InterruptedException

decode

public Captcha decode(java.io.InputStream st)
               throws java.io.IOException,
                      Exception,
                      java.lang.InterruptedException

Throws:

java.io.IOException

Exception

java.lang.InterruptedException

See Also:

decode(InputStream, int)

decode

public Captcha decode(java.io.File f,
                      java.lang.String challenge,
                      int type,
                      java.io.File banner_f,
                      java.lang.String banner_text,
                      int timeout)
               throws java.io.IOException,
                      Exception,
                      java.lang.InterruptedException

Parameters:

f - CAPTCHA image file

timeout - Solving timeout (in seconds)

Throws:

java.io.IOException

Exception

java.lang.InterruptedException

See Also:

decode(byte[], java.lang.String, int, byte[], java.lang.String, java.lang.String, int)

decode

public Captcha decode(java.io.File f,
                      int type,
                      java.io.File banner_f,
                      java.lang.String banner_text)
               throws java.io.IOException,
                      Exception,
                      java.lang.InterruptedException

Throws:

java.io.IOException

Exception

java.lang.InterruptedException

decode

public Captcha decode(java.io.File f,
                      int type,
                      int timeout)
               throws java.io.IOException,
                      Exception,
                      java.lang.InterruptedException

Throws:

java.io.IOException

Exception

java.lang.InterruptedException

decode

public Captcha decode(java.io.File f,
                      java.lang.String challenge)
               throws java.io.IOException,
                      Exception,
                      java.lang.InterruptedException

Throws:

java.io.IOException

Exception

java.lang.InterruptedException

decode

public Captcha decode(java.io.File f,
                      java.lang.String challenge,
                      int timeout)
               throws java.io.IOException,
                      Exception,
                      java.lang.InterruptedException

Throws:

java.io.IOException

Exception

java.lang.InterruptedException

decode

public Captcha decode(java.io.File f,
                      int timeout)
               throws java.io.IOException,
                      java.io.FileNotFoundException,
                      Exception,
                      java.lang.InterruptedException

Throws:

java.io.IOException

java.io.FileNotFoundException

Exception

java.lang.InterruptedException

decode

public Captcha decode(java.io.File f)
               throws java.io.IOException,
                      java.io.FileNotFoundException,
                      Exception,
                      java.lang.InterruptedException

Throws:

java.io.IOException

java.io.FileNotFoundException

Exception

java.lang.InterruptedException

See Also:

decode(File, int)

decode

public Captcha decode(java.lang.String fn,
                      java.lang.String challenge,
                      int type,
                      java.lang.String banner_fn,
                      java.lang.String banner_text,
                      int timeout)
               throws java.io.IOException,
                      Exception,
                      java.lang.InterruptedException

Parameters:

fn - CAPTCHA image file name

timeout - Solving timeout (in seconds)

Throws:

java.io.IOException

Exception

java.lang.InterruptedException

See Also:

decode(byte[], java.lang.String, int, byte[], java.lang.String, java.lang.String, int)

decode

public Captcha decode(java.lang.String fn,
                      int type,
                      java.lang.String banner_fn,
                      java.lang.String banner_text)
               throws java.io.IOException,
                      Exception,
                      java.lang.InterruptedException

Throws:

java.io.IOException

Exception

java.lang.InterruptedException

decode

public Captcha decode(java.lang.String fn,
                      int type,
                      java.lang.String banner_fn,
                      java.lang.String banner_text,
                      int timeout)
               throws java.io.IOException,
                      Exception,
                      java.lang.InterruptedException

Throws:

java.io.IOException

Exception

java.lang.InterruptedException

decode

public Captcha decode(java.lang.String fn,
                      int type,
                      int timeout)
               throws java.io.IOException,
                      Exception,
                      java.lang.InterruptedException

Throws:

java.io.IOException

Exception

java.lang.InterruptedException

decode

public Captcha decode(java.lang.String fn,
                      java.lang.String challenge)
               throws java.io.IOException,
                      Exception,
                      java.lang.InterruptedException

Throws:

java.io.IOException

Exception

java.lang.InterruptedException

decode

public Captcha decode(java.lang.String fn,
                      java.lang.String challenge,
                      int timeout)
               throws java.io.IOException,
                      Exception,
                      java.lang.InterruptedException

Throws:

java.io.IOException

Exception

java.lang.InterruptedException

decode

public Captcha decode(java.lang.String fn,
                      int timeout)
               throws java.io.IOException,
                      java.io.FileNotFoundException,
                      Exception,
                      java.lang.InterruptedException

Throws:

java.io.IOException

java.io.FileNotFoundException

Exception

java.lang.InterruptedException

decode

public Captcha decode(java.lang.String fn)
               throws java.io.IOException,
                      java.io.FileNotFoundException,
                      Exception,
                      java.lang.InterruptedException

Throws:

java.io.IOException

java.io.FileNotFoundException

Exception

java.lang.InterruptedException

See Also:

decode(String, int)

decode

public Captcha decode(java.lang.String proxy,
                      java.lang.String proxytype,
                      java.lang.String sitekey,
                      java.lang.String pageurl)
               throws java.io.IOException,
                      java.io.FileNotFoundException,
                      Exception,
                      java.lang.InterruptedException

Throws:

java.io.IOException

java.io.FileNotFoundException

Exception

java.lang.InterruptedException

decode

public Captcha decode(java.lang.String proxy,
                      java.lang.String proxytype,
                      java.lang.String sitekey,
                      java.lang.String pageurl,
                      int timeout)
               throws java.io.IOException,
                      Exception,
                      java.lang.InterruptedException

Throws:

java.io.IOException

Exception

java.lang.InterruptedException

decode

public Captcha decode(org.json.JSONObject json)
               throws java.io.IOException,
                      java.io.FileNotFoundException,
                      Exception,
                      java.lang.InterruptedException

Throws:

java.io.IOException

java.io.FileNotFoundException

Exception

java.lang.InterruptedException

decode

public Captcha decode(org.json.JSONObject json,
                      int timeout)
               throws java.io.IOException,
                      Exception,
                      java.lang.InterruptedException

Throws:

java.io.IOException

Exception

java.lang.InterruptedException

getPollInterval

public static int[] getPollInterval(int idx)

Parameters:

int - index of POLLS_INTERVAL

Returns:

position of POLLS_INTERVAL or default polling time if index out of range