com.screenscraper.ie

Class InternetExplorer

java.lang.Object

com.screenscraper.ie.InternetExplorer

public class InternetExplorer
extends java.lang.Object

Interfaces with an Internet Explorer instance and allows you to communicate with it. This class is thread-safe: you can call any of its methods from any thread without negative effects. However, you must remember to call destroy to free the native memory associated with this object when you are done with it. In addition, when passing POST data to loadURL, make sure the following header is specified:

Content-Type: application/x-www-form-urlencoded

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.log4j.Logger	log Used for logging.
static int	NUM_REQUESTS

Constructor Summary

Constructors

Constructor and Description
InternetExplorer() Constructs a new (invisible) Internet Explorer instance.

Method Summary

Modifier and Type	Method and Description
boolean	create() Creates an embedded Internet Explorer on the apartment thread.
void	destroy() Destroys this InternetExplorer instance.
static void	dispatchRunnable() Removes a Runnable from the queue and runs its.
static byte[]	getCookieData(java.lang.String url) Returns the current cookie data for the specified URL.
java.lang.String	getHTML() Retrieves the HTML for the current page.
java.lang.String	getPostData()
java.lang.String	getURL()
static boolean	init() Initializes Internet Explorer support.
boolean	loadURL(java.lang.String url, byte[] post_data, java.lang.String headers, int timeout) Loads the specified URL.
boolean	makeRequest()
static void	postQuit() Tells the apartment thread to quit.
void	resetPostData() Resets the POST data to null.
static boolean	setCookieData(java.lang.String url, byte[] data) Sets the current cookie data for the specified URL.
void	setPostData(java.lang.String postData)
void	setReferer(java.lang.String referer)
void	setTimeout(int timeout) Sets the timeout.
void	setURL(java.lang.String url)
static void	shutdown() Terminates Internet Explorer support.
boolean	waitForLoad(int timeout) Waits for the page to load completely.

Methods inherited from class java.lang.Object

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

Field Detail

NUM_REQUESTS

public static int NUM_REQUESTS

log

public static org.apache.log4j.Logger log

Used for logging.

Constructor Detail

InternetExplorer

public InternetExplorer()

Constructs a new (invisible) Internet Explorer instance.

Method Detail

init

public static boolean init()

Initializes Internet Explorer support.

Returns:

true if successful.

shutdown

public static void shutdown()

Terminates Internet Explorer support.

postQuit

public static void postQuit()

Tells the apartment thread to quit.

getCookieData

public static byte[] getCookieData(java.lang.String url)

Returns the current cookie data for the specified URL.

Parameters:

url - URL to get cookie data for.

Returns:

Cookie data, or null if there is no data.

setCookieData

public static boolean setCookieData(java.lang.String url,
                                    byte[] data)

Sets the current cookie data for the specified URL.

Parameters:

url - URL to set cookie data for.

data - Cookie data.

Returns:

true if successful.

dispatchRunnable

public static void dispatchRunnable()

Removes a Runnable from the queue and runs its. This method is called by the Win32 message pump to perform Java code on the apartment thread.

getURL

public java.lang.String getURL()

setURL

public void setURL(java.lang.String url)

setReferer

public void setReferer(java.lang.String referer)

getPostData

public java.lang.String getPostData()

setPostData

public void setPostData(java.lang.String postData)

resetPostData

public void resetPostData()

Resets the POST data to null.

setTimeout

public void setTimeout(int timeout)

Sets the timeout.

Parameters:

timeout - The timeout in milliseconds.

create

public boolean create()

Creates an embedded Internet Explorer on the apartment thread.

Returns:

true if creation was successful.

destroy

public void destroy()

Destroys this InternetExplorer instance.

waitForLoad

public boolean waitForLoad(int timeout)

Waits for the page to load completely.

Parameters:

timeout - Number of milliseconds to wait before timing out.

Returns:

A boolean

makeRequest

public boolean makeRequest()

loadURL

public boolean loadURL(java.lang.String url,
                       byte[] post_data,
                       java.lang.String headers,
                       int timeout)

Loads the specified URL.

Parameters:

url - The URL to load.

post_data - byte[] of POST data.

headers - String of headers. Each header entry should be separated by a \r\n. You must specify the correct Content-Type header for POST data!!

timeout - Milliseconds to wait for page load before timing out.

Returns:

true if the load was successful.

getHTML

public java.lang.String getHTML()

Retrieves the HTML for the current page.

Returns:

HTML for the current page.