com.bytelightning.opensource.pokerface

Class ScriptHelperImpl

java.lang.Object

com.bytelightning.opensource.pokerface.ScriptHelperImpl

All Implemented Interfaces:

ScriptHelper, Closeable, AutoCloseable

public class ScriptHelperImpl
extends Object
implements ScriptHelper, Closeable

Implementation of ScriptHelper

Field Summary

Fields

Modifier and Type	Field and Description
protected static HashMap<String,sun.net.www.MimeEntry>	MimeExtensionsMap
protected static HashMap<String,sun.net.www.MimeEntry>	MimeTypeMap

Fields inherited from interface com.bytelightning.opensource.pokerface.ScriptHelper

ScriptLogger

Constructor Summary

Constructors

Constructor and Description
ScriptHelperImpl(org.apache.http.HttpRequest request, org.apache.http.protocol.HttpContext context, org.apache.commons.pool2.ObjectPool<ByteBuffer> bufferPool) Primary constructor

Method Summary

Modifier and Type	Method and Description
protected static void	AddMimeEntry(String type, String extensions) Add a mime entry to the table.
void	close() Close out any resources that are owned by this object.
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
static String	GetCharsetFromContentType(String contentType) Parse the character encoding from the specified 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
static boolean	HasScheme(String uri) Determine if a URI string has a scheme component.
String	makeAbsoluteUrl(String location) Convert (if necessary) and return the absolute URL that represents the resource referenced by this possibly relative URL.
static String	NormalizeURL(String taintedURL) Normalization code courtesy of 'Mike Houston' http://stackoverflow.com/questions/2993649/how-to-normalize-a-url-in-java
static String	PercentEncodeRfc3986(String string) Percent-encode values according the RFC 3986.

Methods inherited from class java.lang.Object

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

Field Detail

MimeTypeMap

protected static final HashMap<String,sun.net.www.MimeEntry> MimeTypeMap

MimeExtensionsMap

protected static final HashMap<String,sun.net.www.MimeEntry> MimeExtensionsMap

Constructor Detail

ScriptHelperImpl

public ScriptHelperImpl(org.apache.http.HttpRequest request,
                        org.apache.http.protocol.HttpContext context,
                        org.apache.commons.pool2.ObjectPool<ByteBuffer> bufferPool)

Primary constructor

Parameters:

request - Request as it was received from the client

context - The context of this http transaction

bufferPool - A pool from which ByteBuffers can be obtained.

Method Detail

close

public void close()

Close out any resources that are owned by this object.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

createBuffer

public ByteBuffer createBuffer()

Description copied from interface: ScriptHelper

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

Specified by:

createBuffer in interface ScriptHelper

getScheme

public String getScheme()

Description copied from interface: ScriptHelper

Returns http or https scheme of this transaction

Specified by:

getScheme in interface ScriptHelper

makeAbsoluteUrl

public String makeAbsoluteUrl(String location)

Description copied from interface: ScriptHelper

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.

Specified by:

makeAbsoluteUrl in interface ScriptHelper

Parameters:

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

getAcceptableLocales

public String[] getAcceptableLocales()

Description copied from interface: ScriptHelper

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

Specified by:

getAcceptableLocales in interface ScriptHelper

findMimeEntryByType

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

Description copied from interface: ScriptHelper

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

Specified by:

findMimeEntryByType in interface ScriptHelper

findMimeEntryByExt

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

Description copied from interface: ScriptHelper

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

Specified by:

findMimeEntryByExt in interface ScriptHelper

AddMimeEntry

protected static void AddMimeEntry(String type,
                                   String extensions)

Add a mime entry to the table. If the type already exists, the 'extensions' will be added, otherwise a new type will be added with the specified extensions.

Parameters:

type - Mime formatted type

extensions - Comma separated list of dot (.) prefixed extensions.

Throws:

RuntimeException - If the extensions string is not properly formatted (see parameters).

getLocalAddress

public InetAddress getLocalAddress()

Description copied from interface: ScriptHelper

Return the underlying local InetAddress for this request / response transaction

Specified by:

getLocalAddress in interface ScriptHelper

getLocalPort

public int getLocalPort()

Description copied from interface: ScriptHelper

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

Specified by:

getLocalPort in interface ScriptHelper

getRemoteAddress

public InetAddress getRemoteAddress()

Description copied from interface: ScriptHelper

Return the underlying remote InetAddress for this request / response transaction

Specified by:

getRemoteAddress in interface ScriptHelper

getRemotePort

public int getRemotePort()

Description copied from interface: ScriptHelper

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

Specified by:

getRemotePort in interface ScriptHelper

getHOSTName

public String getHOSTName()

Description copied from interface: ScriptHelper

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.

Specified by:

getHOSTName in interface ScriptHelper

getHOSTPort

public int getHOSTPort()

Description copied from interface: ScriptHelper

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.

Specified by:

getHOSTPort in interface ScriptHelper

getCharacterEncoding

public String getCharacterEncoding()

Description copied from interface: ScriptHelper

Returns the charset of the Content-Type header

Specified by:

getCharacterEncoding in interface ScriptHelper

getHTTPDateFormater

public DateFormat getHTTPDateFormater()

Description copied from interface: ScriptHelper

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.

Specified by:

getHTTPDateFormater in interface ScriptHelper

formatDate

public String formatDate(long millisecondsSinceEpoch)

Description copied from interface: ScriptHelper

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

Specified by:

formatDate in interface ScriptHelper

Parameters:

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

HasScheme

public static boolean HasScheme(String uri)

Determine if a URI string has a scheme component.

PercentEncodeRfc3986

public static String PercentEncodeRfc3986(String string)

Percent-encode values according the RFC 3986. The built-in Java URLEncoder does not encode according to the RFC, so we make the extra replacements.

Parameters:

string - Decoded string.

Returns:

Encoded string per RFC 3986.

NormalizeURL

public static String NormalizeURL(String taintedURL)
                           throws MalformedURLException

Normalization code courtesy of 'Mike Houston' http://stackoverflow.com/questions/2993649/how-to-normalize-a-url-in-java

Throws:

MalformedURLException

GetCharsetFromContentType

public static String GetCharsetFromContentType(String contentType)

Parse the character encoding from the specified content type header. If the content type is null, or there is no explicit character encoding, null is returned.

Parameters:

contentType - a content type header