|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.restlet.client.engine.Engine
public class Engine
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.
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 |
---|
public static final java.lang.String DESCRIPTOR
public static final java.lang.String DESCRIPTOR_AUTHENTICATOR
public static final java.lang.String DESCRIPTOR_AUTHENTICATOR_PATH
public static final java.lang.String DESCRIPTOR_CLIENT
public static final java.lang.String DESCRIPTOR_CLIENT_PATH
public static final java.lang.String DESCRIPTOR_CONVERTER
public static final java.lang.String DESCRIPTOR_CONVERTER_PATH
public static final java.lang.String DESCRIPTOR_PROTOCOL
public static final java.lang.String DESCRIPTOR_PROTOCOL_PATH
public static final java.lang.String DESCRIPTOR_SERVER
public static final java.lang.String DESCRIPTOR_SERVER_PATH
public static final java.lang.String MAJOR_NUMBER
public static final java.lang.String MINOR_NUMBER
public static final java.lang.String RELEASE_NUMBER
public static final java.lang.String VERSION
public static final java.lang.String VERSION_HEADER
Constructor Detail |
---|
public Engine()
public Engine(boolean discoverHelpers)
discoverHelpers
- True if helpers should be automatically discovered.Method Detail |
---|
public static java.util.logging.Logger getAnonymousLogger()
getLogger(String)
with a "" name.
public static Engine getInstance()
public static java.util.logging.Logger getLogger(java.lang.Class<?> clazz)
clazz
- The parent class.
public static java.util.logging.Logger getLogger(java.lang.Class<?> clazz, java.lang.String defaultLoggerName)
clazz
- The parent class.defaultLoggerName
- The default logger name to use if no one can be inferred from
the class.
public static java.util.logging.Logger getLogger(java.lang.Object object, java.lang.String defaultLoggerName)
object
- The parent object.defaultLoggerName
- The default logger name to use if no one can be inferred from
the object class.
public static java.util.logging.Logger getLogger(java.lang.String loggerName)
loggerName
- The logger name.
public static Engine register()
public static Engine register(boolean discoverPlugins)
discoverPlugins
- True if plug-ins should be automatically discovered.
public static void setInstance(Engine engine)
engine
- The registered Restlet engine.public ConnectorHelper<Client> createHelper(Client client, java.lang.String helperClass)
client
- The client to help.helperClass
- Optional helper class name.
public LoggerFacade getLoggerFacade()
public java.util.List<ConnectorHelper<Client>> getRegisteredClients()
public java.util.List<ProtocolHelper> getRegisteredProtocols()
public void registerDefaultConnectors()
public void registerDefaultProtocols()
public void setLoggerFacade(LoggerFacade loggerFacade)
loggerFacade
- The logger facade to use.public void setRegisteredClients(java.util.List<ConnectorHelper<Client>> registeredClients)
registeredClients
- The list of available client helpers.public void setRegisteredProtocols(java.util.List<ProtocolHelper> registeredProtocols)
registeredProtocols
- The list of available protocol helpers.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |