public class Engine
extends java.lang.Object
Helper
types:
AuthenticatorHelper
, ClientHelper
,
ConverterHelper
and ServerHelper
classes.LoggerFacade
implementation. For
this, just pass a system property named
"org.restlet.engine.loggerFacadeClass" with the qualified class name as a
value.Modifier and Type | Field and Description |
---|---|
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 and Description |
---|
Engine()
Constructor that will automatically attempt to discover connectors.
|
Engine(boolean discoverHelpers)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
static void |
clear()
Clears the current Restlet Engine altogether.
|
static void |
clearThreadLocalVariables()
Clears the thread local variables set by the Restlet API and engine.
|
protected java.lang.ClassLoader |
createClassLoader()
Creates a new class loader.
|
ConnectorHelper<Client> |
createHelper(Client client,
java.lang.String helperClass)
Creates a new helper for a given client connector.
|
ConnectorHelper<Server> |
createHelper(Server server,
java.lang.String helperClass)
Creates a new helper for a given server connector.
|
static java.lang.Thread |
createThreadWithLocalVariables(java.lang.Runnable runnable,
java.lang.String name)
Creates a new standalone thread with local Restlet thread variable
properly set.
|
ConverterHelper |
findHelper()
Finds the converter helper supporting the given conversion.
|
AuthenticatorHelper |
findHelper(ChallengeScheme challengeScheme,
boolean clientSide,
boolean serverSide)
Finds the authenticator helper supporting the given scheme.
|
static java.util.logging.Logger |
getAnonymousLogger()
Returns an anonymous logger.
|
java.lang.ClassLoader |
getClassLoader()
Returns the class loader.
|
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<AuthenticatorHelper> |
getRegisteredAuthenticators()
Returns the list of available authentication helpers.
|
java.util.List<ConnectorHelper<Client>> |
getRegisteredClients()
Returns the list of available client connectors.
|
java.util.List<ConverterHelper> |
getRegisteredConverters()
Returns the list of available converters.
|
java.util.List<ProtocolHelper> |
getRegisteredProtocols()
Returns the list of available protocol connectors.
|
java.util.List<ConnectorHelper<Server>> |
getRegisteredServers()
Returns the list of available server connectors.
|
static java.net.URL |
getResource(java.lang.String name)
Returns the classloader resource for a given name/path.
|
java.lang.ClassLoader |
getUserClassLoader()
Returns the class loader specified by the user and that should be used in
priority.
|
static java.lang.Class<?> |
loadClass(java.lang.String className)
Returns the class object for the given name using the engine classloader.
|
static Engine |
register()
Registers a new Restlet Engine.
|
static Engine |
register(boolean discoverPlugins)
Registers a new Restlet Engine.
|
void |
registerDefaultAuthentications()
Registers the default authentication helpers.
|
void |
registerDefaultConnectors()
Registers the default client and server connectors.
|
void |
registerDefaultConverters()
Registers the default converters.
|
void |
registerDefaultProtocols()
Registers the default protocols.
|
void |
registerHelper(java.lang.ClassLoader classLoader,
java.lang.String provider,
java.util.List helpers,
java.lang.Class constructorClass)
Registers a helper.
|
void |
registerHelpers(java.lang.ClassLoader classLoader,
java.net.URL configUrl,
java.util.List<?> helpers,
java.lang.Class<?> constructorClass)
Registers a helper.
|
void |
registerHelpers(java.lang.String descriptorPath,
java.util.List<?> helpers,
java.lang.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. |
void |
setClassLoader(java.lang.ClassLoader newClassLoader)
Sets the engine class loader.
|
void |
setLoggerFacade(LoggerFacade loggerFacade)
Sets the logger facade to use.
|
void |
setRegisteredAuthenticators(java.util.List<AuthenticatorHelper> registeredAuthenticators)
Sets the list of available authentication helpers.
|
void |
setRegisteredClients(java.util.List<ConnectorHelper<Client>> registeredClients)
Sets the list of available client helpers.
|
void |
setRegisteredConverters(java.util.List<ConverterHelper> registeredConverters)
Sets the list of available converter helpers.
|
void |
setRegisteredProtocols(java.util.List<ProtocolHelper> registeredProtocols)
Sets the list of available protocol helpers.
|
void |
setRegisteredServers(java.util.List<ConnectorHelper<Server>> registeredServers)
Sets the list of available server helpers.
|
void |
setUserClassLoader(java.lang.ClassLoader newClassLoader)
Sets the user class loader that should used in priority.
|
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
public Engine()
public Engine(boolean discoverHelpers)
discoverHelpers
- True if helpers should be automatically discovered.public static void clear()
public static java.lang.Thread createThreadWithLocalVariables(java.lang.Runnable runnable, java.lang.String name)
runnable
- The runnable task to execute.name
- The thread name.public static void clearThreadLocalVariables()
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 java.net.URL getResource(java.lang.String name)
name
- The name/path to lookup.public static java.lang.Class<?> loadClass(java.lang.String className) throws java.lang.ClassNotFoundException
className
- The class name to lookup.java.lang.ClassNotFoundException
getClassLoader()
public static Engine register()
public static Engine register(boolean discoverPlugins)
discoverPlugins
- True if plug-ins should be automatically discovered.protected java.lang.ClassLoader createClassLoader()
EngineClassLoader
.public ConnectorHelper<Client> createHelper(Client client, java.lang.String helperClass)
client
- The client to help.helperClass
- Optional helper class name.public ConnectorHelper<Server> createHelper(Server server, java.lang.String helperClass)
server
- The server to help.helperClass
- Optional helper class name.public ConverterHelper findHelper()
public AuthenticatorHelper findHelper(ChallengeScheme challengeScheme, boolean clientSide, boolean serverSide)
challengeScheme
- The challenge scheme to match.clientSide
- Indicates if client side support is required.serverSide
- Indicates if server side support is required.public java.lang.ClassLoader getClassLoader()
getUserClassLoader()
and finally the
Thread.getContextClassLoader()
.EngineClassLoader
public LoggerFacade getLoggerFacade()
public java.util.List<AuthenticatorHelper> getRegisteredAuthenticators()
public java.util.List<ConnectorHelper<Client>> getRegisteredClients()
public java.util.List<ConverterHelper> getRegisteredConverters()
public java.util.List<ProtocolHelper> getRegisteredProtocols()
public java.util.List<ConnectorHelper<Server>> getRegisteredServers()
public java.lang.ClassLoader getUserClassLoader()
public void registerDefaultAuthentications()
public void registerDefaultConnectors()
public void registerDefaultConverters()
public void registerDefaultProtocols()
public void registerHelper(java.lang.ClassLoader classLoader, java.lang.String provider, java.util.List helpers, java.lang.Class constructorClass)
classLoader
- The classloader to use.provider
- Bynary name of the helper's class.helpers
- The list of helpers to update.constructorClass
- The constructor parameter class to look for.public void registerHelpers(java.lang.ClassLoader classLoader, java.net.URL configUrl, java.util.List<?> helpers, java.lang.Class<?> constructorClass)
classLoader
- The classloader to use.configUrl
- Configuration URL to parsehelpers
- The list of helpers to update.constructorClass
- The constructor parameter class to look for.public void registerHelpers(java.lang.String descriptorPath, java.util.List<?> helpers, java.lang.Class<?> constructorClass) throws java.io.IOException
descriptorPath
- Classpath to the descriptor file.helpers
- The list of helpers to update.constructorClass
- The constructor parameter class to look for.java.io.IOException
public void registerUrlFactory()
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.
public void setClassLoader(java.lang.ClassLoader newClassLoader)
newClassLoader
- The new user class loader to use.public void setLoggerFacade(LoggerFacade loggerFacade)
loggerFacade
- The logger facade to use.public void setRegisteredAuthenticators(java.util.List<AuthenticatorHelper> registeredAuthenticators)
registeredAuthenticators
- The list of available authentication helpers.public void setRegisteredClients(java.util.List<ConnectorHelper<Client>> registeredClients)
registeredClients
- The list of available client helpers.public void setRegisteredConverters(java.util.List<ConverterHelper> registeredConverters)
registeredConverters
- The list of available converter helpers.public void setRegisteredProtocols(java.util.List<ProtocolHelper> registeredProtocols)
registeredProtocols
- The list of available protocol helpers.public void setRegisteredServers(java.util.List<ConnectorHelper<Server>> registeredServers)
registeredServers
- The list of available server helpers.public void setUserClassLoader(java.lang.ClassLoader newClassLoader)
newClassLoader
- The new user class loader to use.Copyright © 2005-2020 Restlet.