org.restlet.client.engine
Class Engine

java.lang.Object
  extended by org.restlet.client.engine.Engine

public class Engine
extends java.lang.Object

Engine supporting the Restlet API. The engine acts as a registry of various Helper types: engine.security.AuthenticatorHelper , ClientHelper, engine.converter.ConverterHelper and ServerHelper classes.

Note that by default the JULI logging mechanism is used but it is possible to replace it by providing an alternate LoggerFacade implementation. For this, just pass a system property named "org.restlet.client.engine.loggerFacadeClass" with the qualified class name as a value.

Author:
Jerome Louvel

Field Summary
static java.lang.String DESCRIPTOR
           
static java.lang.String DESCRIPTOR_AUTHENTICATOR
           
static java.lang.String DESCRIPTOR_AUTHENTICATOR_PATH
           
static java.lang.String DESCRIPTOR_CLIENT
           
static java.lang.String DESCRIPTOR_CLIENT_PATH
           
static java.lang.String DESCRIPTOR_CONVERTER
           
static java.lang.String DESCRIPTOR_CONVERTER_PATH
           
static java.lang.String DESCRIPTOR_PROTOCOL
           
static java.lang.String DESCRIPTOR_PROTOCOL_PATH
           
static java.lang.String DESCRIPTOR_SERVER
           
static java.lang.String DESCRIPTOR_SERVER_PATH
           
static java.lang.String MAJOR_NUMBER
          Major version number.
static java.lang.String MINOR_NUMBER
          Minor version number.
static java.lang.String RELEASE_NUMBER
          Release number.
static java.lang.String VERSION
          Complete version.
static java.lang.String VERSION_HEADER
          Complete version header.
 
Constructor Summary
Engine()
          Constructor that will automatically attempt to discover connectors.
Engine(boolean discoverHelpers)
          Constructor.
 
Method Summary
 ConnectorHelper<Client> createHelper(Client client, java.lang.String helperClass)
          Creates a new helper for a given client connector.
static java.util.logging.Logger getAnonymousLogger()
          Returns an anonymous logger.
static Engine getInstance()
          Returns the registered Restlet engine.
static java.util.logging.Logger getLogger(java.lang.Class<?> clazz)
          Returns a logger based on the class name of the given object.
static java.util.logging.Logger getLogger(java.lang.Class<?> clazz, java.lang.String defaultLoggerName)
          Returns a logger based on the class name of the given object.
static java.util.logging.Logger getLogger(java.lang.Object object, java.lang.String defaultLoggerName)
          Returns a logger based on the class name of the given object.
static java.util.logging.Logger getLogger(java.lang.String loggerName)
          Returns a logger based on the given logger name.
 LoggerFacade getLoggerFacade()
          Returns the logger facade to use.
 java.util.List<ConnectorHelper<Client>> getRegisteredClients()
          Returns the list of available client connectors.
 java.util.List<ProtocolHelper> getRegisteredProtocols()
          Returns the list of available protocol connectors.
static Engine register()
          Registers a new Restlet Engine.
static Engine register(boolean discoverPlugins)
          Registers a new Restlet Engine.
 void registerDefaultConnectors()
          Registers the default client and server connectors.
 void registerDefaultProtocols()
          Registers the default protocols.
static void setInstance(Engine engine)
          Sets the registered Restlet engine.
 void setLoggerFacade(LoggerFacade loggerFacade)
          Sets the logger facade to use.
 void setRegisteredClients(java.util.List<ConnectorHelper<Client>> registeredClients)
          Sets the list of available client helpers.
 void setRegisteredProtocols(java.util.List<ProtocolHelper> registeredProtocols)
          Sets the list of available protocol helpers.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DESCRIPTOR

public static final java.lang.String DESCRIPTOR
See Also:
Constant Field Values

DESCRIPTOR_AUTHENTICATOR

public static final java.lang.String DESCRIPTOR_AUTHENTICATOR
See Also:
Constant Field Values

DESCRIPTOR_AUTHENTICATOR_PATH

public static final java.lang.String DESCRIPTOR_AUTHENTICATOR_PATH
See Also:
Constant Field Values

DESCRIPTOR_CLIENT

public static final java.lang.String DESCRIPTOR_CLIENT
See Also:
Constant Field Values

DESCRIPTOR_CLIENT_PATH

public static final java.lang.String DESCRIPTOR_CLIENT_PATH
See Also:
Constant Field Values

DESCRIPTOR_CONVERTER

public static final java.lang.String DESCRIPTOR_CONVERTER
See Also:
Constant Field Values

DESCRIPTOR_CONVERTER_PATH

public static final java.lang.String DESCRIPTOR_CONVERTER_PATH
See Also:
Constant Field Values

DESCRIPTOR_PROTOCOL

public static final java.lang.String DESCRIPTOR_PROTOCOL
See Also:
Constant Field Values

DESCRIPTOR_PROTOCOL_PATH

public static final java.lang.String DESCRIPTOR_PROTOCOL_PATH
See Also:
Constant Field Values

DESCRIPTOR_SERVER

public static final java.lang.String DESCRIPTOR_SERVER
See Also:
Constant Field Values

DESCRIPTOR_SERVER_PATH

public static final java.lang.String DESCRIPTOR_SERVER_PATH
See Also:
Constant Field Values

MAJOR_NUMBER

public static final java.lang.String MAJOR_NUMBER
Major version number.

See Also:
Constant Field Values

MINOR_NUMBER

public static final java.lang.String MINOR_NUMBER
Minor version number.

See Also:
Constant Field Values

RELEASE_NUMBER

public static final java.lang.String RELEASE_NUMBER
Release number.

See Also:
Constant Field Values

VERSION

public static final java.lang.String VERSION
Complete version.

See Also:
Constant Field Values

VERSION_HEADER

public static final java.lang.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

getAnonymousLogger

public static java.util.logging.Logger getAnonymousLogger()
Returns an anonymous logger. By default it calls getLogger(String) with a "" name.

Returns:
The logger.

getInstance

public static Engine getInstance()
Returns the registered Restlet engine.

Returns:
The registered Restlet engine.

getLogger

public static java.util.logging.Logger getLogger(java.lang.Class<?> clazz)
Returns a logger based on the class name of the given object.

Parameters:
clazz - The parent class.
Returns:
The logger.

getLogger

public static java.util.logging.Logger getLogger(java.lang.Class<?> clazz,
                                                 java.lang.String defaultLoggerName)
Returns a logger based on the class name of the given object.

Parameters:
clazz - The parent class.
defaultLoggerName - The default logger name to use if no one can be inferred from the class.
Returns:
The logger.

getLogger

public static java.util.logging.Logger getLogger(java.lang.Object object,
                                                 java.lang.String defaultLoggerName)
Returns a logger based on the class name of the given object.

Parameters:
object - The parent object.
defaultLoggerName - The default logger name to use if no one can be inferred from the object class.
Returns:
The logger.

getLogger

public static java.util.logging.Logger getLogger(java.lang.String loggerName)
Returns a logger based on the given logger name.

Parameters:
loggerName - The logger name.
Returns:
The logger.

register

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

Returns:
The registered engine.

register

public static Engine register(boolean discoverPlugins)
Registers a new Restlet Engine.

Parameters:
discoverPlugins - True if plug-ins should be automatically discovered.
Returns:
The registered engine.

setInstance

public static void setInstance(Engine engine)
Sets the registered Restlet engine.

Parameters:
engine - The registered Restlet engine.

createHelper

public ConnectorHelper<Client> createHelper(Client client,
                                            java.lang.String helperClass)
Creates a new helper for a given client connector.

Parameters:
client - The client to help.
helperClass - Optional helper class name.
Returns:
The new helper.

getLoggerFacade

public LoggerFacade getLoggerFacade()
Returns the logger facade to use.

Returns:
The logger facade to use.

getRegisteredClients

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

Returns:
The list of available client connectors.

getRegisteredProtocols

public java.util.List<ProtocolHelper> getRegisteredProtocols()
Returns the list of available protocol connectors.

Returns:
The list of available protocol connectors.

registerDefaultConnectors

public void registerDefaultConnectors()
Registers the default client and server connectors.


registerDefaultProtocols

public void registerDefaultProtocols()
Registers the default protocols.


setLoggerFacade

public void setLoggerFacade(LoggerFacade loggerFacade)
Sets the logger facade to use.

Parameters:
loggerFacade - The logger facade to use.

setRegisteredClients

public void setRegisteredClients(java.util.List<ConnectorHelper<Client>> registeredClients)
Sets the list of available client helpers.

Parameters:
registeredClients - The list of available client helpers.

setRegisteredProtocols

public void setRegisteredProtocols(java.util.List<ProtocolHelper> registeredProtocols)
Sets the list of available protocol helpers.

Parameters:
registeredProtocols - The list of available protocol helpers.


Copyright © 2005-2011 Noelios Technologies.