public class Engine extends 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 String |
DESCRIPTOR |
static String |
DESCRIPTOR_AUTHENTICATOR |
static String |
DESCRIPTOR_AUTHENTICATOR_PATH |
static String |
DESCRIPTOR_CLIENT |
static String |
DESCRIPTOR_CLIENT_PATH |
static String |
DESCRIPTOR_CONVERTER |
static String |
DESCRIPTOR_CONVERTER_PATH |
static String |
DESCRIPTOR_PROTOCOL |
static String |
DESCRIPTOR_PROTOCOL_PATH |
static String |
DESCRIPTOR_SERVER |
static String |
DESCRIPTOR_SERVER_PATH |
static String |
MAJOR_NUMBER
Major version number.
|
static String |
MINOR_NUMBER
Minor version number.
|
static String |
RELEASE_NUMBER
Release number.
|
static String |
VERSION
Complete version.
|
static 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 ClassLoader |
createClassLoader()
Creates a new class loader.
|
ConnectorHelper<Client> |
createHelper(Client client,
String helperClass)
Creates a new helper for a given client connector.
|
ConnectorHelper<Server> |
createHelper(Server server,
String helperClass)
Creates a new helper for a given server connector.
|
static Thread |
createThreadWithLocalVariables(Runnable runnable,
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 Logger |
getAnonymousLogger()
Returns an anonymous logger.
|
ClassLoader |
getClassLoader()
Returns the class loader.
|
static Engine |
getInstance()
Returns the registered Restlet engine.
|
static Logger |
getLogger(Class<?> clazz)
Returns a logger based on the class name of the given object.
|
static Logger |
getLogger(Class<?> clazz,
String defaultLoggerName)
Returns a logger based on the class name of the given object.
|
static Logger |
getLogger(Object object,
String defaultLoggerName)
Returns a logger based on the class name of the given object.
|
static Logger |
getLogger(String loggerName)
Returns a logger based on the given logger name.
|
LoggerFacade |
getLoggerFacade()
Returns the logger facade to use.
|
List<AuthenticatorHelper> |
getRegisteredAuthenticators()
Returns the list of available authentication helpers.
|
List<ConnectorHelper<Client>> |
getRegisteredClients()
Returns the list of available client connectors.
|
List<ConverterHelper> |
getRegisteredConverters()
Returns the list of available converters.
|
List<ProtocolHelper> |
getRegisteredProtocols()
Returns the list of available protocol connectors.
|
List<ConnectorHelper<Server>> |
getRegisteredServers()
Returns the list of available server connectors.
|
static URL |
getResource(String name)
Returns the classloader resource for a given name/path.
|
ClassLoader |
getUserClassLoader()
Returns the class loader specified by the user and that should be used in
priority.
|
static Class<?> |
loadClass(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(ClassLoader classLoader,
String provider,
List helpers,
Class constructorClass)
Registers a helper.
|
void |
registerHelpers(ClassLoader classLoader,
URL configUrl,
List<?> helpers,
Class<?> constructorClass)
Registers a helper.
|
void |
registerHelpers(String descriptorPath,
List<?> helpers,
Class<?> constructorClass)
Registers a list of helpers.
|
void |
setClassLoader(ClassLoader newClassLoader)
Sets the engine class loader.
|
void |
setLoggerFacade(LoggerFacade loggerFacade)
Sets the logger facade to use.
|
void |
setRegisteredAuthenticators(List<AuthenticatorHelper> registeredAuthenticators)
Sets the list of available authentication helpers.
|
void |
setRegisteredClients(List<ConnectorHelper<Client>> registeredClients)
Sets the list of available client helpers.
|
void |
setRegisteredConverters(List<ConverterHelper> registeredConverters)
Sets the list of available converter helpers.
|
void |
setRegisteredProtocols(List<ProtocolHelper> registeredProtocols)
Sets the list of available protocol helpers.
|
void |
setRegisteredServers(List<ConnectorHelper<Server>> registeredServers)
Sets the list of available server helpers.
|
void |
setUserClassLoader(ClassLoader newClassLoader)
Sets the user class loader that should used in priority.
|
public static final String DESCRIPTOR
public static final String DESCRIPTOR_AUTHENTICATOR
public static final String DESCRIPTOR_AUTHENTICATOR_PATH
public static final String DESCRIPTOR_CLIENT
public static final String DESCRIPTOR_CLIENT_PATH
public static final String DESCRIPTOR_CONVERTER
public static final String DESCRIPTOR_CONVERTER_PATH
public static final String DESCRIPTOR_PROTOCOL
public static final String DESCRIPTOR_PROTOCOL_PATH
public static final String DESCRIPTOR_SERVER
public static final String DESCRIPTOR_SERVER_PATH
public static final String MAJOR_NUMBER
public static final String MINOR_NUMBER
public static final String RELEASE_NUMBER
public static final String VERSION
public static final String VERSION_HEADER
public Engine()
public Engine(boolean discoverHelpers)
discoverHelpers
- True if helpers should be automatically discovered.public static void clear()
public static Thread createThreadWithLocalVariables(Runnable runnable, String name)
runnable
- The runnable task to execute.name
- The thread name.public static void clearThreadLocalVariables()
public static Logger getAnonymousLogger()
getLogger(String)
with a "" name.public static Engine getInstance()
public static Logger getLogger(Class<?> clazz)
clazz
- The parent class.public static Logger getLogger(Class<?> clazz, String defaultLoggerName)
clazz
- The parent class.defaultLoggerName
- The default logger name to use if no one can be inferred from
the class.public static Logger getLogger(Object object, 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 Logger getLogger(String loggerName)
loggerName
- The logger name.public static URL getResource(String name)
name
- The name/path to lookup.public static Class<?> loadClass(String className) throws ClassNotFoundException
className
- The class name to lookup.ClassNotFoundException
getClassLoader()
public static Engine register()
public static Engine register(boolean discoverPlugins)
discoverPlugins
- True if plug-ins should be automatically discovered.protected ClassLoader createClassLoader()
EngineClassLoader
.public ConnectorHelper<Client> createHelper(Client client, String helperClass)
client
- The client to help.helperClass
- Optional helper class name.public ConnectorHelper<Server> createHelper(Server server, 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 ClassLoader getClassLoader()
getUserClassLoader()
and finally the
Thread.getContextClassLoader()
.EngineClassLoader
public LoggerFacade getLoggerFacade()
public List<AuthenticatorHelper> getRegisteredAuthenticators()
public List<ConnectorHelper<Client>> getRegisteredClients()
public List<ConverterHelper> getRegisteredConverters()
public List<ProtocolHelper> getRegisteredProtocols()
public List<ConnectorHelper<Server>> getRegisteredServers()
public ClassLoader getUserClassLoader()
public void registerDefaultAuthentications()
public void registerDefaultConnectors()
public void registerDefaultConverters()
public void registerDefaultProtocols()
public void registerHelper(ClassLoader classLoader, String provider, List helpers, 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(ClassLoader classLoader, URL configUrl, List<?> helpers, 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(String descriptorPath, List<?> helpers, Class<?> constructorClass) throws IOException
descriptorPath
- Classpath to the descriptor file.helpers
- The list of helpers to update.constructorClass
- The constructor parameter class to look for.IOException
public void setClassLoader(ClassLoader newClassLoader)
newClassLoader
- The new user class loader to use.public void setLoggerFacade(LoggerFacade loggerFacade)
loggerFacade
- The logger facade to use.public void setRegisteredAuthenticators(List<AuthenticatorHelper> registeredAuthenticators)
registeredAuthenticators
- The list of available authentication helpers.public void setRegisteredClients(List<ConnectorHelper<Client>> registeredClients)
registeredClients
- The list of available client helpers.public void setRegisteredConverters(List<ConverterHelper> registeredConverters)
registeredConverters
- The list of available converter helpers.public void setRegisteredProtocols(List<ProtocolHelper> registeredProtocols)
registeredProtocols
- The list of available protocol helpers.public void setRegisteredServers(List<ConnectorHelper<Server>> registeredServers)
registeredServers
- The list of available server helpers.public void setUserClassLoader(ClassLoader newClassLoader)
newClassLoader
- The new user class loader to use.Copyright © 2005-2014 Restlet.