com.screenscraper.util.images

Class DecaptcherDecoder

java.lang.Object

com.screenscraper.util.images.ImageDecoder

com.screenscraper.util.images.DecaptcherDecoder

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class DecaptcherDecoder
extends ImageDecoder

Uses www.de-captcher.com to resolve the image. User: Mike Date: 11/18/11 Time: 10:14 AM

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.List<java.lang.String>	VALID_API_URLS

Fields inherited from class com.screenscraper.util.images.ImageDecoder

session

Constructor Summary

Constructors

Constructor and Description
DecaptcherDecoder(ScrapingSession session, java.lang.String username, java.lang.String password, int port) Create a decoder that uses the de-captcher.com service.
DecaptcherDecoder(ScrapingSession session, java.lang.String username, java.lang.String password, int port, java.lang.String apiURL) Create a decoder that uses the de-captcher.com service.
DecaptcherDecoder(ScrapingSession session, java.lang.String username, java.lang.String password, java.lang.String port) Create a decoder that uses the de-captcher.com service.
DecaptcherDecoder(ScrapingSession session, java.lang.String username, java.lang.String password, java.lang.String port, java.lang.String apiURL) Create a decoder that uses the de-captcher.com service.

Method Summary

Modifier and Type	Method and Description
void	close() Closes any resources associated with the decoder.
DecodedImage	decodeFile(java.io.File file) Converts the image given to a DecodedImage that will handle it.
double	getBalance() Returns the current balance of the account (if it can be accessed via the API).

Methods inherited from class com.screenscraper.util.images.ImageDecoder

decodeFile, decodeURL, setAutoCloseAfterScrapeEnds

Methods inherited from class java.lang.Object

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

Field Detail

VALID_API_URLS

@NotNull
public static final java.util.List<java.lang.String> VALID_API_URLS

Constructor Detail

DecaptcherDecoder

public DecaptcherDecoder(ScrapingSession session,
                         java.lang.String username,
                         java.lang.String password,
                         int port)

Create a decoder that uses the de-captcher.com service.

Parameters:

session - The current scraping session. Used for downloading images with the decodeURL method.

username - The username for the de-captcher account

password - The password for the de-captcher account

port - The port parameter for de-captcher, which can be found for your account by logging into their site

DecaptcherDecoder

public DecaptcherDecoder(ScrapingSession session,
                         java.lang.String username,
                         java.lang.String password,
                         @NotNull
                         java.lang.String port)

Create a decoder that uses the de-captcher.com service.

Parameters:

session - The current scraping session. Used for downloading images with the decodeURL method.

username - The username for the de-captcher account

password - The password for the de-captcher account

port - The port parameter for de-captcher, which can be found for your account by logging into their site

DecaptcherDecoder

public DecaptcherDecoder(ScrapingSession session,
                         java.lang.String username,
                         java.lang.String password,
                         @NotNull
                         java.lang.String port,
                         java.lang.String apiURL)

Create a decoder that uses the de-captcher.com service.

Parameters:

session - The current scraping session. Used for downloading images with the decodeURL method.

username - The username for the de-captcher account

password - The password for the de-captcher account

port - The port parameter for de-captcher, which can be found for your account by logging into their site

apiURL - The api url you wish to connect with, if different than the default

DecaptcherDecoder

public DecaptcherDecoder(ScrapingSession session,
                         java.lang.String username,
                         java.lang.String password,
                         int port,
                         java.lang.String apiURL)

Create a decoder that uses the de-captcher.com service.

Parameters:

session - The current scraping session. Used for downloading images with the decodeURL method.

username - The username for the de-captcher account

password - The password for the de-captcher account

port - The port parameter for de-captcher, which can be found for your account by logging into their site

apiURL - The api url you wish to connect with, if different than the default

Method Detail

close

public void close()

Description copied from class: ImageDecoder

Closes any resources associated with the decoder. This may include logging out. This method should ALWAYS be called when done with the decoder. Some types of decoders may not need this. Note that once this is called, you should no longer use this decoder, including reporting any images it decoded as bad.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in class ImageDecoder

decodeFile

@NotNull
public DecodedImage decodeFile(@NotNull
                                         java.io.File file)

Description copied from class: ImageDecoder

Converts the image given to a DecodedImage that will handle it. Does not delete the file.

Specified by:

decodeFile in class ImageDecoder

Parameters:

file - The image file

Returns:

A DecodedImage used to decode the image

getBalance

public double getBalance()

Description copied from class: ImageDecoder

Returns the current balance of the account (if it can be accessed via the API). Each type of decoder may have it's own interpretation of balance. For example, some may be the amount of images that can still be resolved, others may be a dollar amount

Specified by:

getBalance in class ImageDecoder

Returns:

The current remaining balance in the account, if applicable.