com.noelios.restlet
Class Engine

java.lang.Object
  org.restlet.util.Engine
      com.noelios.restlet.Engine

public class Engine
extends Engine

Restlet factory supported by the engine.

Author:

Jerome Louvel

Field Summary

static String	DESCRIPTOR_AUTHENTICATION
static String	DESCRIPTOR_AUTHENTICATION_PATH
static String	DESCRIPTOR_CLIENT
static String	DESCRIPTOR_CLIENT_PATH
static String	DESCRIPTOR_PATH
static String	DESCRIPTOR_SERVER
static String	DESCRIPTOR_SERVER_PATH
static String	VERSION Complete version.
static String	VERSION_HEADER Complete version header.

Fields inherited from class org.restlet.util.Engine

MAJOR_NUMBER, MINOR_NUMBER, RELEASE_NUMBER

Constructor Summary

Engine()
Constructor that will automatically attempt to discover connectors.

Engine(boolean discoverHelpers)
Constructor.

Method Summary

int	authenticate(Request request, Guard guard)
void	challenge(Response response, boolean stale, Guard guard)
void	copyResponseHeaders(Iterable<Parameter> responseHeaders, Response response) Copies the given header parameters into the given Response.
void	copyResponseHeaders(Response response, Series<Parameter> headers) Copies the headers of the given Response into the given Series.
Resource	createDirectoryResource(Directory directory, Request request, Response response)
ApplicationHelper	createHelper(Application application)
ClientHelper	createHelper(Client client, String helperClass)
ComponentHelper	createHelper(Component component)
ServerHelper	createHelper(Server server, String helperClass)
AuthenticationHelper	findHelper(ChallengeScheme challengeScheme, boolean clientSide, boolean serverSide) Finds the authentication helper supporting the given scheme.
void	fireContextChanged(Restlet restlet, Context context) Indicates that a Restlet's context has changed.
String	formatCookie(Cookie cookie)
String	formatCookieSetting(CookieSetting cookieSetting)
String	formatDimensions(Collection<Dimension> dimensions)
String	formatUserAgent(List<Product> products)
static Engine	getInstance() Returns the registered Noelios Restlet engine.
static int	getJavaMajorVersion() Parses the "java.version" system property and returns the first digit of the version number of the Java Runtime Environment (e.g.
static int	getJavaMinorVersion() Parses the "java.version" system property and returns the second digit of the version number of the Java Runtime Environment (e.g.
static int	getJavaUpdateVersion() Parses the "java.version" system property and returns the update release number of the Java Runtime Environment (e.g.
Variant	getPreferredVariant(ClientInfo client, List<Variant> variants, Language defaultLanguage)
List<AuthenticationHelper>	getRegisteredAuthentications() Returns the list of available authentication helpers.
List<ClientHelper>	getRegisteredClients() Returns the list of available client connectors.
List<ServerHelper>	getRegisteredServers() Returns the list of available server connectors.
void	parse(Form form, Representation webForm)
void	parse(Form form, String queryString, CharacterSet characterSet, boolean decode, char separator)
MediaType	parseContentType(String contentType)
Cookie	parseCookie(String cookie)
CookieSetting	parseCookieSetting(String cookieSetting)
List<Product>	parseUserAgent(String userAgent)
static Engine	register() Registers a new Noelios Restlet Engine.
static Engine	register(boolean discoverConnectors) Registers a new Noelios Restlet Engine.
void	registerDefaultAuthentications() Registers the default authentication helpers.
void	registerDefaultConnectors() Registers the default client and server connectors.
void	registerHelper(ClassLoader classLoader, URL configUrl, List helpers, Class constructorClass) Registers a helper.
void	registerHelpers(ClassLoader classLoader, Enumeration<URL> configUrls, List helpers, Class constructorClass) Registers a list of helpers.
void	registerUrlFactory() Registers a factory that is used by the URL class to create the URLConnection instances when the URL.openConnection() or URL.openStream() methods are invoked.
String	toBase64(byte[] target)
String	toMd5(String target)

Methods inherited from class org.restlet.util.Engine

getClassLoader, hashCode, loadClass, setInstance, setUserClassLoader

Methods inherited from class java.lang.Object

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

Field Detail

DESCRIPTOR_AUTHENTICATION

public static final String DESCRIPTOR_AUTHENTICATION

See Also:

Constant Field Values

DESCRIPTOR_PATH

public static final String DESCRIPTOR_PATH

See Also:

Constant Field Values

DESCRIPTOR_AUTHENTICATION_PATH

public static final String DESCRIPTOR_AUTHENTICATION_PATH

See Also:

Constant Field Values

DESCRIPTOR_CLIENT

public static final String DESCRIPTOR_CLIENT

See Also:

Constant Field Values

DESCRIPTOR_CLIENT_PATH

public static final String DESCRIPTOR_CLIENT_PATH

See Also:

Constant Field Values

DESCRIPTOR_SERVER

public static final String DESCRIPTOR_SERVER

See Also:

Constant Field Values

DESCRIPTOR_SERVER_PATH

public static final String DESCRIPTOR_SERVER_PATH

See Also:

Constant Field Values

VERSION

public static final String VERSION

Complete version.

See Also:

Constant Field Values

VERSION_HEADER

public static final String VERSION_HEADER

Complete version header.

See Also:

Constant Field Values

Constructor Detail

Engine

public Engine()

Constructor that will automatically attempt to discover connectors.

Engine

public Engine(boolean discoverHelpers)

Constructor.

Parameters:

discoverHelpers - True if helpers should be automatically discovered.

Method Detail

getInstance

public static Engine getInstance()

Returns the registered Noelios Restlet engine.

Returns:

The registered Noelios Restlet engine.

getJavaMajorVersion

public static int getJavaMajorVersion()

Parses the "java.version" system property and returns the first digit of the version number of the Java Runtime Environment (e.g. "1" for "1.3.0").

Returns:

The major version number of the Java Runtime Environment.

See Also:

Official Java versioning

getJavaMinorVersion

public static int getJavaMinorVersion()

Parses the "java.version" system property and returns the second digit of the version number of the Java Runtime Environment (e.g. "3" for "1.3.0").

Returns:

The minor version number of the Java Runtime Environment.

See Also:

Official Java versioning

getJavaUpdateVersion

public static int getJavaUpdateVersion()

Parses the "java.version" system property and returns the update release number of the Java Runtime Environment (e.g. "10" for "1.3.0_10").

Returns:

The release number of the Java Runtime Environment or 0 if it does not exist.

See Also:

Official Java versioning

register

public static Engine register()

Registers a new Noelios Restlet Engine.

Returns:

The registered engine.

register

public static Engine register(boolean discoverConnectors)

Registers a new Noelios Restlet Engine.

Parameters:

discoverConnectors - True if connectors should be automatically discovered.

Returns:

The registered engine.

authenticate

public int authenticate(Request request,
                        Guard guard)

Specified by:

authenticate in class Engine

challenge

public void challenge(Response response,
                      boolean stale,
                      Guard guard)

Specified by:

challenge in class Engine

copyResponseHeaders

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

Copies the given header parameters into the given Response.

Specified by:

copyResponseHeaders in class Engine

Parameters:

responseHeaders - The headers to copy.

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

See Also:

Engine.copyResponseHeaders(java.lang.Iterable, org.restlet.data.Response)

copyResponseHeaders

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

Copies the headers of the given Response into the given Series.

Specified by:

copyResponseHeaders in class Engine

Parameters:

response - The response to update. Should contain a Representation to copy the representation headers from it.

headers - The Series to copy the headers in.

See Also:

Engine.copyResponseHeaders(Response, Series)

createDirectoryResource

public Resource createDirectoryResource(Directory directory,
                                        Request request,
                                        Response response)
                                 throws IOException

Specified by:

createDirectoryResource in class Engine

Throws:

IOException

createHelper

public ApplicationHelper createHelper(Application application)

Specified by:

createHelper in class Engine

createHelper

public ClientHelper createHelper(Client client,
                                 String helperClass)

Specified by:

createHelper in class Engine

createHelper

public ComponentHelper createHelper(Component component)

Specified by:

createHelper in class Engine

createHelper

public ServerHelper createHelper(Server server,
                                 String helperClass)

Specified by:

createHelper in class Engine

findHelper

public AuthenticationHelper findHelper(ChallengeScheme challengeScheme,
                                       boolean clientSide,
                                       boolean serverSide)

Finds the authentication helper supporting the given scheme.

Parameters:

challengeScheme - The challenge scheme to match.

clientSide - Indicates if client side support is required.

serverSide - Indicates if server side support is required.

Returns:

The authentication helper or null.

fireContextChanged

public void fireContextChanged(Restlet restlet,
                               Context context)

Indicates that a Restlet's context has changed.

Specified by:

fireContextChanged in class Engine

Parameters:

restlet - The Restlet with a changed context.

context - The new context.

formatCookie

public String formatCookie(Cookie cookie)
                    throws IllegalArgumentException

Specified by:

formatCookie in class Engine

Throws:

IllegalArgumentException

formatCookieSetting

public String formatCookieSetting(CookieSetting cookieSetting)
                           throws IllegalArgumentException

Specified by:

formatCookieSetting in class Engine

Throws:

IllegalArgumentException

formatDimensions

public String formatDimensions(Collection<Dimension> dimensions)

Specified by:

formatDimensions in class Engine

formatUserAgent

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

Specified by:

formatUserAgent in class Engine

Throws:

IllegalArgumentException

getPreferredVariant

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

Specified by:

getPreferredVariant in class Engine

getRegisteredAuthentications

public List<AuthenticationHelper> getRegisteredAuthentications()

Returns the list of available authentication helpers.

Returns:

The list of available authentication helpers.

getRegisteredClients

public List<ClientHelper> getRegisteredClients()

Returns the list of available client connectors.

Returns:

The list of available client connectors.

getRegisteredServers

public List<ServerHelper> getRegisteredServers()

Returns the list of available server connectors.

Returns:

The list of available server connectors.

parse

public void parse(Form form,
                  Representation webForm)

Specified by:

parse in class Engine

parse

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

Specified by:

parse in class Engine

parseContentType

public MediaType parseContentType(String contentType)
                           throws IllegalArgumentException

Specified by:

parseContentType in class Engine

Throws:

IllegalArgumentException

parseCookie

public Cookie parseCookie(String cookie)
                   throws IllegalArgumentException

Specified by:

parseCookie in class Engine

Throws:

IllegalArgumentException

parseCookieSetting

public CookieSetting parseCookieSetting(String cookieSetting)
                                 throws IllegalArgumentException

Specified by:

parseCookieSetting in class Engine

Throws:

IllegalArgumentException

parseUserAgent

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

Specified by:

parseUserAgent in class Engine

Throws:

IllegalArgumentException

registerDefaultAuthentications

public void registerDefaultAuthentications()

Registers the default authentication helpers.

registerDefaultConnectors

public void registerDefaultConnectors()

Registers the default client and server connectors.

registerHelper

public void registerHelper(ClassLoader classLoader,
                           URL configUrl,
                           List helpers,
                           Class constructorClass)

Registers a helper.

Parameters:

classLoader - The classloader to use.

configUrl - Configuration URL to parse

helpers - The list of helpers to update.

constructorClass - The constructor parameter class to look for.

registerHelpers

public void registerHelpers(ClassLoader classLoader,
                            Enumeration<URL> configUrls,
                            List helpers,
                            Class constructorClass)

Registers a list of helpers.

Parameters:

classLoader - The classloader to use.

configUrls - Configuration URLs to parse

helpers - The list of helpers to update.

constructorClass - The constructor parameter class to look for.

registerUrlFactory

public void registerUrlFactory()

Registers a factory that is used by the URL class to create the URLConnection instances when the URL.openConnection() or URL.openStream() methods are invoked.

The implementation is based on the client dispatcher of the current context, as provided by Context.getCurrent() method.

toBase64

public String toBase64(byte[] target)

Specified by:

toBase64 in class Engine

toMd5

public String toMd5(String target)

Specified by:

toMd5 in class Engine