org.restlet.gwt.util
Class Engine

java.lang.Object
  org.restlet.gwt.util.Engine

public abstract class Engine
extends Object

Facade to the engine implementating the Restlet API. Note that this is an SPI class that is not intended for public usage.

Author:

Jerome Louvel

Field Summary

static String	MAJOR_NUMBER Major version number.
static String	MINOR_NUMBER Minor version number.
static String	RELEASE_NUMBER Release number.
static String	VERSION Complete version.

Constructor Summary

Engine()

Method Summary

abstract void	copyResponseHeaders(Iterable<Parameter> headers, Response response) Copies the given header parameters into the given Response.
abstract org.restlet.gwt.engine.Helper<Client>	createHelper(Client client) Creates a new helper for a given client connector.
abstract String	formatCookie(Cookie cookie) Formats the given Cookie to a String
abstract String	formatCookieSetting(CookieSetting cookieSetting) Formats the given CookieSetting to a String
abstract String	formatDimensions(Collection<Dimension> dimensions) Formats the given Set of Dimensions to a String for the HTTP Vary header.
abstract String	formatUserAgent(List<Product> products) Formats the given List of Products to a String.
static Engine	getInstance() Returns the registered Restlet engine.
abstract Variant	getPreferredVariant(ClientInfo client, List<Variant> variants, Language defaultLanguage) Returns the best variant representation for a given resource according the the client preferences. A default language is provided in case the variants don't match the client preferences.
static int	hashCode(Object... objects) Computes the hash code of a set of objects.
abstract void	parse(Form form, Representation representation) Parses a representation into a form.
abstract void	parse(Form form, String parametersString, CharacterSet characterSet, boolean decode, char separator) Parses a parameters string to parse into a given form.
abstract MediaType	parseContentType(String contentType) Parses the given Content Type.
abstract Cookie	parseCookie(String cookie) Parses the given String to a Cookie
abstract CookieSetting	parseCookieSetting(String cookieSetting) Parses the given String to a CookieSetting
abstract List<Product>	parseUserAgent(String userAgent) Parses the given user agent String to a list of Product instances.
static void	setInstance(Engine engine) Sets the registered Restlet engine.

Methods inherited from class java.lang.Object

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

Field Detail

MAJOR_NUMBER

public static final String MAJOR_NUMBER

Major version number.

See Also:

Constant Field Values

MINOR_NUMBER

public static final String MINOR_NUMBER

Minor version number.

See Also:

Constant Field Values

RELEASE_NUMBER

public static final String RELEASE_NUMBER

Release number.

See Also:

Constant Field Values

VERSION

public static final String VERSION

Complete version.

See Also:

Constant Field Values

Constructor Detail

Engine

public Engine()

Method Detail

getInstance

public static Engine getInstance()

Returns the registered Restlet engine.

Returns:

The registered Restlet engine.

hashCode

public static int hashCode(Object... objects)

Computes the hash code of a set of objects. Follows the algorithm specified in List.hasCode().

Parameters:

objects - the objects to compute the hashCode

Returns:

The hash code of a set of objects.

setInstance

public static void setInstance(Engine engine)

Sets the registered Restlet engine.

Parameters:

engine - The registered Restlet engine.

copyResponseHeaders

public abstract void copyResponseHeaders(Iterable<Parameter> headers,
                                         Response response)

Copies the given header parameters into the given Response.

Parameters:

headers - The headers to copy.

response - The response to update. Must contain a Representation to copy the representation headers in it.

createHelper

public abstract org.restlet.gwt.engine.Helper<Client> createHelper(Client client)

Creates a new helper for a given client connector.

Parameters:

client - The client to help.

Returns:

The new helper.

formatCookie

public abstract String formatCookie(Cookie cookie)
                             throws IllegalArgumentException

Formats the given Cookie to a String

Parameters:

cookie -

Returns:

the Cookie as String

Throws:

IllegalArgumentException - Thrown if the Cookie contains illegal values

formatCookieSetting

public abstract String formatCookieSetting(CookieSetting cookieSetting)
                                    throws IllegalArgumentException

Formats the given CookieSetting to a String

Parameters:

cookieSetting -

Returns:

the CookieSetting as String

Throws:

IllegalArgumentException - Thrown if the CookieSetting contains illegal values

formatDimensions

public abstract String formatDimensions(Collection<Dimension> dimensions)

Formats the given Set of Dimensions to a String for the HTTP Vary header.

Parameters:

dimensions - the dimensions to format.

Returns:

the Vary header or null, if dimensions is null or empty.

formatUserAgent

public abstract String formatUserAgent(List<Product> products)
                                throws IllegalArgumentException

Formats the given List of Products to a String.

Parameters:

products - The list of products to format.

Returns:

the List of Products as String.

Throws:

IllegalArgumentException - Thrown if the List of Products contains illegal values

getPreferredVariant

public abstract Variant getPreferredVariant(ClientInfo client,
                                            List<Variant> variants,
                                            Language defaultLanguage)

Returns the best variant representation for a given resource according the the client preferences.
A default language is provided in case the variants don't match the client preferences.

Parameters:

client - The client preferences.

variants - The list of variants to compare.

defaultLanguage - The default language.

Returns:

The preferred variant.

See Also:

Apache content negotiation algorithm

parse

public abstract void parse(Form form,
                           Representation representation)

Parses a representation into a form.

Parameters:

form - The target form.

representation - The representation to parse.

parse

public abstract void parse(Form form,
                           String parametersString,
                           CharacterSet characterSet,
                           boolean decode,
                           char separator)

Parses a parameters string to parse into a given form.

Parameters:

form - The target form.

parametersString - The parameters string to parse.

characterSet - The supported character encoding.

decode - Indicates if the parameters should be decoded using the given character set.

separator - The separator character to append between parameters.

parseContentType

public abstract MediaType parseContentType(String contentType)
                                    throws IllegalArgumentException

Parses the given Content Type.

Parameters:

contentType - the Content Type as String

Returns:

the ContentType as MediaType; charset etc. are parameters.

Throws:

IllegalArgumentException - if the String can not be parsed.

parseCookie

public abstract Cookie parseCookie(String cookie)
                            throws IllegalArgumentException

Parses the given String to a Cookie

Parameters:

cookie -

Returns:

the Cookie parsed from the String

Throws:

IllegalArgumentException - Thrown if the String can not be parsed as Cookie.

parseCookieSetting

public abstract CookieSetting parseCookieSetting(String cookieSetting)
                                          throws IllegalArgumentException

Parses the given String to a CookieSetting

Parameters:

cookieSetting -

Returns:

the CookieSetting parsed from the String

Throws:

IllegalArgumentException - Thrown if the String can not be parsed as CookieSetting.

parseUserAgent

public abstract List<Product> parseUserAgent(String userAgent)
                                      throws IllegalArgumentException

Parses the given user agent String to a list of Product instances.

Parameters:

userAgent -

Returns:

the List of Product objects parsed from the String

Throws:

IllegalArgumentException - Thrown if the String can not be parsed as a list of Product instances.