com.noelios.restlet
Class Engine

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

public class Engine
extends Engine

Restlet factory supported by the engine.

Author:
Jerome Louvel (contact@noelios.com)

Field Summary
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 discoverConnectors)
          Constructor.
 
Method Summary
 Resource createDirectoryResource(Directory handler, Request request, Response response)
          Creates a directory resource.
 Helper createHelper(Application application, Context parentContext)
          Creates a new helper for a given component.
 Helper createHelper(Client client)
          Creates a new helper for a given client connector.
 Helper createHelper(Component component)
          Creates a new helper for a given component.
 Helper createHelper(Server server)
          Creates a new helper for a given server connector.
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)
          Returns the preferred variant representation for a given resource according the the client preferences.
 List<ConnectorHelper> getRegisteredClients()
          Returns the list of available client connectors.
 List<ConnectorHelper> getRegisteredServers()
          Returns the list of available server connectors.
 void parse(Logger logger, Form form, Representation webForm)
          Parses an URL encoded Web form.
 void parse(Logger logger, Form form, String queryString, CharacterSet characterSet)
          Parses an URL encoded query string into a given form.
static void register()
          Registers a new Noelios Restlet Engine.
 
Methods inherited from class org.restlet.util.Engine
getClassLoader, getInstance, hashCode, setClassLoader, setInstance
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

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 discoverConnectors)
Constructor.

Parameters:
discoverConnectors - True if connectors should be automatically discovered.
Method Detail

register

public static void register()
Registers a new Noelios Restlet Engine.


getRegisteredClients

public List<ConnectorHelper> getRegisteredClients()
Returns the list of available client connectors.

Returns:
The list of available client connectors.

getRegisteredServers

public List<ConnectorHelper> getRegisteredServers()
Returns the list of available server connectors.

Returns:
The list of available server connectors.

createDirectoryResource

public Resource createDirectoryResource(Directory handler,
                                        Request request,
                                        Response response)
                                 throws IOException
Creates a directory resource.

Specified by:
createDirectoryResource in class Engine
Parameters:
handler - The parent directory handler.
request - The request to handle.
response - The response to return.
Returns:
A new directory resource.
Throws:
IOException

createHelper

public Helper createHelper(Application application,
                           Context parentContext)
Creates a new helper for a given component.

Specified by:
createHelper in class Engine
Parameters:
application - The application to help.
parentContext - The parent context, typically the component's context.
Returns:
The new helper.

createHelper

public Helper createHelper(Client client)
Creates a new helper for a given client connector.

Specified by:
createHelper in class Engine
Parameters:
client - The client to help.
Returns:
The new helper.

createHelper

public Helper createHelper(Component component)
Creates a new helper for a given component.

Specified by:
createHelper in class Engine
Parameters:
component - The component to help.
Returns:
The new helper.

createHelper

public Helper createHelper(Server server)
Creates a new helper for a given server connector.

Specified by:
createHelper in class Engine
Parameters:
server - The server to help.
Returns:
The new helper.

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

getPreferredVariant

public Variant getPreferredVariant(ClientInfo client,
                                   List<Variant> variants,
                                   Language defaultLanguage)
Returns the preferred variant representation for a given resource according the the client preferences.

Specified by:
getPreferredVariant in class Engine
Parameters:
client - The client preferences.
variants - The list of variants to compare.
Returns:
The preferred variant.
See Also:
Apache content negotiation algorithm

parse

public void parse(Logger logger,
                  Form form,
                  Representation webForm)
Parses an URL encoded Web form.

Specified by:
parse in class Engine
Parameters:
logger - The logger to use.
form - The target form.
webForm - The posted form.

parse

public void parse(Logger logger,
                  Form form,
                  String queryString,
                  CharacterSet characterSet)
Parses an URL encoded query string into a given form.

Specified by:
parse in class Engine
Parameters:
logger - The logger to use.
form - The target form.
queryString - Query string.
characterSet - The supported character encoding.


Copyright © 2005-2007 Noelios Consulting.