com.isti.util

Class LaunchBrowser

java.lang.Object

com.isti.util.LaunchBrowser

All Implemented Interfaces:

ILaunchBrowser, StringConstants

public class LaunchBrowser
extends java.lang.Object
implements ILaunchBrowser

Class LaunchBrowser contains methods for launching a browser.

If the desktop supports the "browse" action then the desktop browse support is used.

Otherwise the following default launch command is used:

   Windows:   cmd /C "start URL" (for non-file URLs)
   Windows:   cmd /C "URL" (for file URLs)
   Macintosh: /usr/bin/open URL
   Other:     xdg-open URL
 

Field Summary

Fields inherited from interface com.isti.util.ILaunchBrowser

NO_ERROR, NON_WINDOWS

Fields inherited from interface com.isti.util.StringConstants

ALPHA_CAP_CHARS, ALPHA_CHARS, ALPHA_LOW_CHARS, ALPHANUM_CHARS_STRING, ALPHANUMERIC_CHARS, BOOLEAN_FALSE_TEXT, BOOLEAN_TRUE_TEXT, DATE_FORMAT_AMPM_STR, DATE_FORMAT_RFC_822_STR, DATE_FORMAT24_STR, DEFAULT_JAVA_VERSION_STRING, DEFAULT_NULL_STR, DEFAULT_SEP_STR, EFLOAT_CHARS, EMPTY_CHARS, EMPTY_STRING, EMPTY_STRINGS, FLOAT_CHARS, HEX_ALPHA_CAP_CHARS, HEX_ALPHA_LOW_CHARS, HEX_CHARS, HEX_PREFIX, INTEGER_CHARS, INVALID_FILENAME_CHARS, MODIFIER_TEXT_ALT, MODIFIER_TEXT_CTRL, MODIFIER_TEXT_META, MODIFIER_TEXT_META_ALT, MODIFIER_TEXT_META_CTRL, NONE, QUOTE_STRING, SIGNED_EFLOAT_CHARS, SIGNED_FLOAT_CHARS, SIGNED_INT_CHARS, SMTP_ENCRYPTION_OPTIONS, SMTP_SERVER_AUTHENTICATION_NAME, SMTP_SERVER_AUTHENTICATION_TEXT, SPACE_STRING, SSL, SSL_KEY_STORE_PROP_KEY, SSL_KEY_STORE_TYPE_PROP_KEY, SSL_TRUST_STORE_PROP_KEY, SSL_TRUST_STORE_TYPE_PROP_KEY, STARTTLS, TLS, TOD_CHARS, UNKNOWN_STRING, US_ASCII, WHITE_SPACE_CHARS, WILDCARD_ALL_CHAR, WILDCARD_CHARS, WILDCARD_SINGLE_CHAR

Method Summary

Modifier and Type	Method and Description
static boolean	checkResponseCodeOK(int codeVal) Determines if the given response code corresponds to the HTTP_OK code.
static boolean	checkResponseCodeOK(java.net.URL urlObj) Determines if the response code fetched for the given URL corresponds to the HTTP_OK code.
static boolean	checkResponseCodeOK(java.net.URLConnection urlConnObj) Determines if the response code fetched for the given URLConnection corresponds to the HTTP_OK code.
void	clearErrorMessage() Clears the error message string.
boolean	getErrorFlag() Returns true if an error was detected.
java.lang.String	getErrorMessage() Returns message string for last error (or 'No error' if none).
static ILaunchBrowser	getInstance() Get the launch browser.
java.lang.String	getLaunchBrowserCommand() Get the launch browser command.
static int	getResponseCode(java.net.URL urlObj) Returns the status code from an HTTP response message.
static int	getResponseCode(java.net.URLConnection urlConnObj) Returns the status code from an HTTP response message.
boolean	isEnabled() Returns an indicator of whether or not the launching of browsers is enabled.
static boolean	isURLAddress(java.lang.String str) Returns true if the contents of the given string qualify as a valid URL address; otherwise returns false.
boolean	launchBrowser(java.lang.String uri) Displays the given URI in a browser.
static java.net.URLConnection	openConnection(java.net.URL urlObj) Opens a connection to the given URL.
void	setEnabled(boolean flgVal) Enables or disables the launching of a browser.
void	setLaunchBrowserCommand(java.lang.String s) Set the launch browser command.
boolean	showURI(java.net.URI uri) Displays the given URI in a browser.
boolean	showURL(java.lang.String uri) Displays the given URI in a browser.
static boolean	waitForURLAvailable(java.net.URL urlObj, int timeOutMs, int checkIntvlMs) Waits for the specified URL to become available.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.isti.util.ILaunchBrowser

getDesktop

Method Detail

checkResponseCodeOK

public static boolean checkResponseCodeOK(int codeVal)

Determines if the given response code corresponds to the HTTP_OK code.

Parameters:

codeVal - response code to check.

Returns:

true if the given response code corresponds to the HTTP_OK code.

checkResponseCodeOK

public static boolean checkResponseCodeOK(java.net.URL urlObj)

Determines if the response code fetched for the given URL corresponds to the HTTP_OK code.

Parameters:

urlObj - URL object to use.

Returns:

true if the response code corresponds to the HTTP_OK code.

checkResponseCodeOK

public static boolean checkResponseCodeOK(java.net.URLConnection urlConnObj)

Determines if the response code fetched for the given URLConnection corresponds to the HTTP_OK code.

Parameters:

urlConnObj - URL-connection object to use.

Returns:

true if the response code corresponds to the HTTP_OK code.

getInstance

public static ILaunchBrowser getInstance()

Get the launch browser.

Returns:

the launch browser.

getResponseCode

public static int getResponseCode(java.net.URL urlObj)

Returns the status code from an HTTP response message.

Parameters:

urlObj - URL object to use.

Returns:

An HTTP Status-Code, or -1 if none available.

getResponseCode

public static int getResponseCode(java.net.URLConnection urlConnObj)

Returns the status code from an HTTP response message.

Parameters:

urlConnObj - URL-connection object to use.

Returns:

An HTTP Status-Code, or -1 if none available.

isURLAddress

public static boolean isURLAddress(java.lang.String str)

Returns true if the contents of the given string qualify as a valid URL address; otherwise returns false. If the string begins with 1 to 10 letters (or digits) followed by "://" then it is considered a valid URL address.

Parameters:

str - the string to check.

Returns:

true if the contents of the given string qualify as a valid URL address; otherwise false.

openConnection

public static java.net.URLConnection openConnection(java.net.URL urlObj)

Opens a connection to the given URL. Returns null if an I/O exception occurs.

Parameters:

urlObj - URL object for the given URL.

Returns:

A new URLConnection object, or null if an exception occurred.

waitForURLAvailable

public static boolean waitForURLAvailable(java.net.URL urlObj,
                                          int timeOutMs,
                                          int checkIntvlMs)

Waits for the specified URL to become available.

Parameters:

urlObj - URL object for URL.

timeOutMs - maximum time to wait (in ms), or 0 for indefinite.

checkIntvlMs - delay time between checks (in ms).

Returns:

true if the URL is available; false if not.

clearErrorMessage

public void clearErrorMessage()

Clears the error message string.

getErrorFlag

public boolean getErrorFlag()

Returns true if an error was detected. The error message may be fetched via the 'getErrorMessage()' method.

Returns:

true if an error was detected.

getErrorMessage

public java.lang.String getErrorMessage()

Description copied from interface: ILaunchBrowser

Returns message string for last error (or 'No error' if none).

Specified by:

getErrorMessage in interface ILaunchBrowser

Returns:

message string for last error (or 'No error' if none).

getLaunchBrowserCommand

public java.lang.String getLaunchBrowserCommand()

Description copied from interface: ILaunchBrowser

Get the launch browser command.

Specified by:

getLaunchBrowserCommand in interface ILaunchBrowser

Returns:

the launch browser command or an empty string if none, not null.

isEnabled

public boolean isEnabled()

Description copied from interface: ILaunchBrowser

Returns an indicator of whether or not the launching of browsers is enabled.

Specified by:

isEnabled in interface ILaunchBrowser

Returns:

true if enabled, false if disabled.

launchBrowser

public boolean launchBrowser(java.lang.String uri)

Description copied from interface: ILaunchBrowser

Displays the given URI in a browser.

Specified by:

launchBrowser in interface ILaunchBrowser

Parameters:

uri - the URI.

Returns:

true if successful; false if error (in which case an error message may be fetched via the 'getErrorMessage()' method).

setEnabled

public void setEnabled(boolean flgVal)

Description copied from interface: ILaunchBrowser

Enables or disables the launching of a browser. The default state is 'enabled'.

Specified by:

setEnabled in interface ILaunchBrowser

Parameters:

flgVal - true to enable, false to disable.

setLaunchBrowserCommand

public void setLaunchBrowserCommand(java.lang.String s)

Description copied from interface: ILaunchBrowser

Set the launch browser command.

Specified by:

setLaunchBrowserCommand in interface ILaunchBrowser

Parameters:

s - the launch browser command or null or empty string if none.

showURI

public boolean showURI(java.net.URI uri)

Description copied from interface: ILaunchBrowser

Displays the given URI in a browser.

Specified by:

showURI in interface ILaunchBrowser

Parameters:

uri - the URI.

Returns:

true if successful; false if error (in which case an error message may be fetched via the 'getErrorMessage()' method).

showURL

public boolean showURL(java.lang.String uri)

Description copied from interface: ILaunchBrowser

Displays the given URI in a browser.

Specified by:

showURL in interface ILaunchBrowser

Parameters:

uri - the URI.

Returns:

true if successful; false if error (in which case an error message may be fetched via the 'getErrorMessage()' method).