com.bytelightning.opensource.pokerface

Interface ScriptHelper

All Known Implementing Classes:

ScriptHelperImpl

public interface ScriptHelper

Exposes a number of useful java based utilities to JavaScript endpoints.

Field Summary

Fields

Modifier and Type	Field and Description
static org.slf4j.Logger	ScriptLogger

Method Summary

Modifier and Type	Method and Description
ByteBuffer	createBuffer() Returns a ByteBuffer that will be automatically cleaned up once the transaction completes.
sun.net.www.MimeEntry	findMimeEntryByExt(String ext) Locate a sun.net.www.MimeEntry by the file extension that has been associated with it.
sun.net.www.MimeEntry	findMimeEntryByType(String mimeType) Locate a sun.net.www.MimeEntry by it's MIMEType
String	formatDate(long millisecondsSinceEpoch) Format millisecond based date into a GMT string compatible with HTTP headers protocol.
String[]	getAcceptableLocales() Return the language Locales accepted by the requesting client in order of preference (best to least).
String	getCharacterEncoding() Returns the charset of the Content-Type header
String	getHOSTName() Returns the host name as seen by the calling client.
int	getHOSTPort() Returns the host port as seen by the calling client.
DateFormat	getHTTPDateFormater() Get a new date formatter compatible with HTTP headers protocol.
InetAddress	getLocalAddress() Return the underlying local InetAddress for this request / response transaction
int	getLocalPort() Return the underlying local socket port for this request / response transaction
InetAddress	getRemoteAddress() Return the underlying remote InetAddress for this request / response transaction
int	getRemotePort() Return the underlying remote socket port for this request / response transaction
String	getScheme() Returns http or https scheme of this transaction
String	makeAbsoluteUrl(String location) Convert (if necessary) and return the absolute URL that represents the resource referenced by this possibly relative URL.

Field Detail

ScriptLogger

static final org.slf4j.Logger ScriptLogger

Method Detail

createBuffer

ByteBuffer createBuffer()

Returns a ByteBuffer that will be automatically cleaned up once the transaction completes.

getScheme

String getScheme()

Returns http or https scheme of this transaction

makeAbsoluteUrl

String makeAbsoluteUrl(String location)

Convert (if necessary) and return the absolute URL that represents the resource referenced by this possibly relative URL. If this URL is already absolute, return it unchanged. This method would typically be used to compute a 302 redirect url.

Parameters:

location - URL to be (possibly) converted and then returned

Throws:

IllegalArgumentException - if a MalformedURLException is thrown when converting the relative URL to an absolute one

getAcceptableLocales

String[] getAcceptableLocales()

Return the language Locales accepted by the requesting client in order of preference (best to least).

findMimeEntryByType

sun.net.www.MimeEntry findMimeEntryByType(String mimeType)

Locate a sun.net.www.MimeEntry by it's MIMEType

findMimeEntryByExt

sun.net.www.MimeEntry findMimeEntryByExt(String ext)

Locate a sun.net.www.MimeEntry by the file extension that has been associated with it.

getLocalAddress

InetAddress getLocalAddress()

Return the underlying local InetAddress for this request / response transaction

getLocalPort

int getLocalPort()

Return the underlying local socket port for this request / response transaction

getRemoteAddress

InetAddress getRemoteAddress()

Return the underlying remote InetAddress for this request / response transaction

getRemotePort

int getRemotePort()

Return the underlying remote socket port for this request / response transaction

getHOSTName

String getHOSTName()

Returns the host name as seen by the calling client. This method examines the HOST header (which is an HTTP required header). If not available for some reason, this method will do a name lookup on the local address of this http connection.

getHOSTPort

int getHOSTPort()

Returns the host port as seen by the calling client. This method examines the HOST header (which is an HTTP required header). Per the standard, if the port is not specified in the header (or the header does not exist), the default 443 or 80 is returned.

getCharacterEncoding

String getCharacterEncoding()

Returns the charset of the Content-Type header

getHTTPDateFormater

DateFormat getHTTPDateFormater()

Get a new date formatter compatible with HTTP headers protocol. SPECIFICALLY... This means: The parser will parse GMT and return local time. The formatter will take a local time and output a GMT string.

formatDate

String formatDate(long millisecondsSinceEpoch)

Format millisecond based date into a GMT string compatible with HTTP headers protocol.

Parameters:

millisecondsSinceEpoch - URL to be (possibly) converted and then returned