public abstract class AbstractRuntimeService extends Object implements RuntimeService
Implementors are encouraged to extend this class instead of directly implementing the RuntimeService
interface.
Modifier and Type | Class and Description |
---|---|
protected class |
AbstractRuntimeService.LogConfig
Configure the logging system (log4j) at runtime startup and do any cleanup is needed when the runtime is stopped
|
Modifier and Type | Field and Description |
---|---|
protected RuntimeContext |
context |
protected List<String> |
errors
Errors during the deployment.
|
protected boolean |
isShuttingDown |
protected boolean |
isStarted |
static String |
LOG4J_WATCH_DELAY |
static long |
LOG4J_WATCH_DELAY_DEFAULT |
static String |
LOG4J_WATCH_DISABLED |
protected AbstractRuntimeService.LogConfig |
logConfig |
protected ComponentManager |
manager |
protected CryptoProperties |
properties |
static String |
REDIRECT_JUL
Property that controls whether or not to redirect JUL to JCL.
|
static String |
REDIRECT_JUL_THRESHOLD |
protected List<String> |
warnings
Warnings during the deployment.
|
protected File |
workingDir |
Modifier | Constructor and Description |
---|---|
protected |
AbstractRuntimeService(DefaultRuntimeContext context) |
protected |
AbstractRuntimeService(DefaultRuntimeContext context,
Map<String,String> properties) |
Modifier and Type | Method and Description |
---|---|
protected ComponentManager |
createComponentManager() |
protected void |
doStart() |
protected void |
doStop() |
String |
expandVars(String expression)
Replaces any substring in the form
${property.name} with the corresponding runtime property value if
any, otherwise leaves the substring unchanged. |
protected static URL |
getBuiltinFeatureURL() |
org.osgi.framework.Bundle |
getBundle(String symbolicName)
Get an installed bundle given its symbolic name.
|
File |
getBundleFile(org.osgi.framework.Bundle bundle)
OSGi frameworks are using a string
Bundle.getLocation() to identify bundle locations. |
Object |
getComponent(ComponentName name)
Gets a component given its name.
|
Object |
getComponent(String name)
Gets a component given its name as a string.
|
ComponentInstance |
getComponentInstance(ComponentName name)
Gets a component implementation instance given its name.
|
ComponentInstance |
getComponentInstance(String name)
Gets a component implementation instance given its name as a string.
|
ComponentManager |
getComponentManager()
Gets the component manager.
|
RuntimeContext |
getContext()
Gets the context of the runtime bundle.
|
String |
getDescription()
Gets the description of this runtime service.
|
static Thread |
getErrorLoggerThread(String message)
Error logger which does its logging from a separate thread, for thread isolation.
|
List<String> |
getErrors()
Gets a list of startup errors.
|
File |
getHome()
Gets the home directory of the runtime.
|
CryptoProperties |
getProperties()
Gets runtime service properties.
|
String |
getProperty(String name)
Gets a runtime service property given its name.
|
String |
getProperty(String name,
String defValue)
Gets a property value using a default value if the property was not set.
|
<T> T |
getService(Class<T> serviceClass)
Gets the service of type serviceClass if such a service was declared by a resolved runtime component.
|
boolean |
getStatusMessage(StringBuilder msg)
Computes the runtime status, adds it to the given string builder, and return true if some problems have been
detected.
|
List<String> |
getWarnings()
Gets a list of startup warnings.
|
boolean |
isShuttingDown()
Returns true if the runtime is shutting down.
|
boolean |
isStarted()
Returns true if the runtime is started.
|
protected void |
loadConfig() |
void |
setHome(File home) |
void |
setProperty(String name,
Object value) |
void |
start()
Starts the runtime.
|
void |
stop()
Stops the runtime.
|
String |
toString() |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getName, getVersion, reloadProperties
public static final String REDIRECT_JUL
public static final String REDIRECT_JUL_THRESHOLD
public static final String LOG4J_WATCH_DISABLED
public static final String LOG4J_WATCH_DELAY
public static final long LOG4J_WATCH_DELAY_DEFAULT
protected boolean isStarted
protected boolean isShuttingDown
protected File workingDir
protected CryptoProperties properties
protected ComponentManager manager
protected final RuntimeContext context
protected final List<String> warnings
protected AbstractRuntimeService.LogConfig logConfig
protected AbstractRuntimeService(DefaultRuntimeContext context)
protected AbstractRuntimeService(DefaultRuntimeContext context, Map<String,String> properties)
public List<String> getWarnings()
RuntimeService
getWarnings
in interface RuntimeService
public List<String> getErrors()
RuntimeService
getErrors
in interface RuntimeService
protected ComponentManager createComponentManager()
protected static URL getBuiltinFeatureURL()
public void start()
RuntimeService
start
in interface RuntimeService
public void stop()
RuntimeService
stop
in interface RuntimeService
public boolean isStarted()
RuntimeService
isStarted
in interface RuntimeService
public boolean isShuttingDown()
RuntimeService
isShuttingDown
in interface RuntimeService
protected void loadConfig() throws IOException
IOException
protected void doStart()
protected void doStop()
public File getHome()
RuntimeService
getHome
in interface RuntimeService
public String getDescription()
RuntimeService
getDescription
in interface RuntimeService
public CryptoProperties getProperties()
RuntimeService
getProperties
in interface RuntimeService
public String getProperty(String name)
RuntimeService
getProperty
in interface RuntimeService
name
- the property namepublic String getProperty(String name, String defValue)
RuntimeService
getProperty
in interface RuntimeService
name
- the property namedefValue
- the default value to use when the property doesn't existspublic void setProperty(String name, Object value)
setProperty
in interface RuntimeService
public Object getComponent(String name)
RuntimeService
getComponent
in interface RuntimeService
name
- the component name as a stringpublic Object getComponent(ComponentName name)
RuntimeService
getComponent
in interface RuntimeService
name
- the component namepublic ComponentInstance getComponentInstance(String name)
RuntimeService
getComponentInstance
in interface RuntimeService
name
- the component name as a stringpublic ComponentInstance getComponentInstance(ComponentName name)
RuntimeService
getComponentInstance
in interface RuntimeService
name
- the component namepublic ComponentManager getComponentManager()
RuntimeService
getComponentManager
in interface RuntimeService
public RuntimeContext getContext()
RuntimeService
getContext
in interface RuntimeService
public <T> T getService(Class<T> serviceClass)
RuntimeService
If the component is not yet activated, it will be prior to return the service.
getService
in interface RuntimeService
T
- the service typeserviceClass
- the service classpublic String expandVars(String expression)
RuntimeService
${property.name}
with the corresponding runtime property value if
any, otherwise leaves the substring unchanged.expandVars
in interface RuntimeService
expression
- the expression to processpublic File getBundleFile(org.osgi.framework.Bundle bundle)
RuntimeService
Bundle.getLocation()
to identify bundle locations.
This method try to convert the bundle location to real file if possible. If this bundle location cannot be converted to a file (e.g. it may be a remote URL), null is returned.
This method works only for bundles that are installed as files on the host file system.
getBundleFile
in interface RuntimeService
public org.osgi.framework.Bundle getBundle(String symbolicName)
RuntimeService
getBundle
in interface RuntimeService
public boolean getStatusMessage(StringBuilder msg)
RuntimeService
getStatusMessage
in interface RuntimeService
msg
- summary message about all components loading statuspublic static Thread getErrorLoggerThread(String message)
message
- the message to logCopyright © 2017 Nuxeo. All rights reserved.