Framework (Nuxeo ECM Projects 5.8-SNAPSHOT API Documentation)

java.lang.Object
- org.nuxeo.runtime.api.Framework

```
public final class Framework
extends Object
```
This class is the main entry point to a Nuxeo runtime application.
It offers an easy way to create new sessions, to access system services and other resources.
There are two type of services:
- Global Services - these services are uniquely defined by a service class, and there is an unique instance of the service in the system per class.
- Local Services - these services are defined by a class and an URI. This type of service allows multiple service instances for the same class of services. Each instance is uniquely defined in the system by an URI.
Author:

Bogdan Stefanescu

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`NUXEO_DEV_SYSTEM_PROP` Global dev property
`static String`	`NUXEO_STRICT_RUNTIME_SYSTEM_PROP` Property to control strict runtime mode
`static String`	`NUXEO_TESTING_SYSTEM_PROP` Global testing property

Method Summary

Methods
Modifier and Type	Method and Description
`static void`	`addListener(RuntimeServiceListener listener)` Registers a listener to be notified about runtime events.
`static String`	`expandVars(String expression)` Expands any variable found in the given expression with the value of the corresponding framework property.
`static <T> T`	`getLocalService(Class<T> serviceClass)` Gets a nuxeo-runtime local service.
`static Properties`	`getProperties()` Gets all the framework properties.
`static String`	`getProperty(String key)` Gets the given property value if any, otherwise null.
`static String`	`getProperty(String key, String defValue)` Gets the given property value if any, otherwise returns the given default value.
`static SharedResourceLoader`	`getResourceLoader()`
`static RuntimeService`	`getRuntime()` Gets the runtime service instance.
`static <T> T`	`getService(Class<T> serviceClass)` Gets a service given its class.
`static <T> T`	`getService(Class<T> serviceClass, String name)` Gets a service given its class and an identifier.
`static void`	`handleDevError(Throwable t)` Since 5.6, this method stops the application if property `NUXEO_STRICT_RUNTIME_SYSTEM_PROP` is set to true, and one of the following errors occurred during startup.
`static void`	`initialize(RuntimeService runtimeService)`
`static boolean`	`isBooleanPropertyFalse(String propName)` Returns true if given property is false when compared to a boolean value.
`static boolean`	`isBooleanPropertyTrue(String propName)` Returns true if given property is true when compared to a boolean value.
`static boolean`	`isDevModeSet()` Returns true if dev mode is set.
`static boolean`	`isInitialized()` Tests whether or not the runtime was initialized.
`static boolean`	`isOSGiServiceSupported()`
`static boolean`	`isTestModeSet()` Returns true if test mode is set.
`static LoginContext`	`login()` Login in the system as the system user (a pseudo-user having all privileges).
`static LoginContext`	`login(CallbackHandler cbHandler)` Login in the system using the given callback handler for login info resolution.
`static LoginContext`	`login(String username, Object password)` Login in the system as the given user using the given password.
`static LoginContext`	`loginAs(String username)` Login in the system as the system user (a pseudo-user having all privileges).
`static LoginContext`	`loginAsUser(String username)` Login in the system as the given user without checking the password.
`static Object`	`lookup(String key)` Lookup a registered object given its key.
`static void`	`main(String[] args)`
`static void`	`reloadResourceLoader()`
`static void`	`reloadResourceLoader(List<URL> urlsToAdd, List<URL> urlsToRemove)` Reload the resources loader, keeping URLs already tracked, and adding possibility to add or remove some URLs.
`static void`	`removeListener(RuntimeServiceListener listener)` Removes the given listener.
`static void`	`sendEvent(RuntimeServiceEvent event)`
`static void`	`shutdown()`
`static void`	`trackFile(File file, Object marker)` Deletes the given file when the marker object is collected by GC.
`static void`	`trackFile(File file, Object marker, FileDeleteStrategy fileDeleteStrategy)` Deletes the given file when the marker object is collected by GC.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NUXEO_DEV_SYSTEM_PROP
```
public static final String NUXEO_DEV_SYSTEM_PROP
```
    Global dev property
    
    Since:
    
    5.6
    
    See Also:
    isDevModeSet(), Constant Field Values
  - NUXEO_TESTING_SYSTEM_PROP
```
public static final String NUXEO_TESTING_SYSTEM_PROP
```
    Global testing property
    
    Since:
    
    5.6
    
    See Also:
    isTestModeSet(), Constant Field Values
  - NUXEO_STRICT_RUNTIME_SYSTEM_PROP
```
public static final String NUXEO_STRICT_RUNTIME_SYSTEM_PROP
```
    Property to control strict runtime mode
    
    Since:
    
    5.6
    
    See Also:
    handleDevError(Throwable), Constant Field Values
- Method Detail
  - initialize
```
public static void initialize(RuntimeService runtimeService)
                       throws Exception
```
    Throws:
    
    Exception
  - reloadResourceLoader
```
public static void reloadResourceLoader()
                                 throws Exception
```
    Throws:
    
    Exception
  - reloadResourceLoader
```
public static void reloadResourceLoader(List<URL> urlsToAdd,
                        List<URL> urlsToRemove)
                                 throws MalformedURLException
```
    Reload the resources loader, keeping URLs already tracked, and adding possibility to add or remove some URLs.
    Useful for hot reload of jars.
    
    Throws:
    
    MalformedURLException
    
    Exception
    Since:
    
    5.6
  - shutdown
```
public static void shutdown()
                     throws Exception
```
    Throws:
    
    Exception
  - isInitialized
```
public static boolean isInitialized()
```
    Tests whether or not the runtime was initialized.
    
    Returns:
    true if the runtime was initialized, false otherwise
  - getResourceLoader
```
public static SharedResourceLoader getResourceLoader()
```
  - getRuntime
```
public static RuntimeService getRuntime()
```
    Gets the runtime service instance.
    
    Returns:
    the runtime service instance
  - getService
```
public static <T> T getService(Class<T> serviceClass)
                    throws Exception
```
    Gets a service given its class.
    
    Throws:
    
    Exception
  - getService
```
public static <T> T getService(Class<T> serviceClass,
               String name)
                    throws Exception
```
    Gets a service given its class and an identifier.
    
    Throws:
    
    Exception
  - getLocalService
```
public static <T> T getLocalService(Class<T> serviceClass)
```
    Gets a nuxeo-runtime local service.
  - lookup
```
public static Object lookup(String key)
```
    Lookup a registered object given its key.
  - login
```
public static LoginContext login()
                          throws LoginException
```
    Login in the system as the system user (a pseudo-user having all privileges).
    
    Returns:
    the login session if successful. Never returns null.
    
    Throws:
    
    LoginException - on login failure
  - loginAs
```
public static LoginContext loginAs(String username)
                            throws LoginException
```
    Login in the system as the system user (a pseudo-user having all privileges). The given username will be used to identify the user id that called this method.
    
    Parameters:
    username - the originating user id
    
    Returns:
    the login session if successful. Never returns null.
    
    Throws:
    
    LoginException - on login failure
  - loginAsUser
```
public static LoginContext loginAsUser(String username)
                                throws LoginException
```
    Login in the system as the given user without checking the password.
    
    Parameters:
    username - the user name to login as.
    
    Returns:
    the login context
    
    Throws:
    
    LoginException - if any error occurs
    Since:
    
    5.4.2
  - login
```
public static LoginContext login(String username,
                 Object password)
                          throws LoginException
```
    Login in the system as the given user using the given password.
    
    Parameters:
    username - the username to login
    password - the password
    
    Returns:
    a login session if login was successful. Never returns null.
    
    Throws:
    
    LoginException - if login failed
  - login
```
public static LoginContext login(CallbackHandler cbHandler)
                          throws LoginException
```
    Login in the system using the given callback handler for login info resolution.
    
    Parameters:
    cbHandler - used to fetch the login info
    
    Returns:
    the login context
    
    Throws:
    
    LoginException
  - sendEvent
```
public static void sendEvent(RuntimeServiceEvent event)
```
  - addListener
```
public static void addListener(RuntimeServiceListener listener)
```
    Registers a listener to be notified about runtime events.
    If the listener is already registered, do nothing.
    
    Parameters:
    listener - the listener to register
  - removeListener
```
public static void removeListener(RuntimeServiceListener listener)
```
    Removes the given listener.
    If the listener is not registered, do nothing.
    
    Parameters:
    listener - the listener to remove
  - getProperty
```
public static String getProperty(String key)
```
    Gets the given property value if any, otherwise null.
    The framework properties will be searched first then if any matching property is found the system properties are searched too.
    
    Parameters:
    key - the property key
    
    Returns:
    the property value if any or null otherwise
  - getProperty
```
public static String getProperty(String key,
                 String defValue)
```
    Gets the given property value if any, otherwise returns the given default value.
    The framework properties will be searched first then if any matching property is found the system properties are searched too.
    
    Parameters:
    key - the property key
    defValue - the default value to use
    
    Returns:
    the property value if any otherwise the default value
  - getProperties
```
public static Properties getProperties()
```
    Gets all the framework properties. The system properties are not included in the returned map.
    
    Returns:
    the framework properties map. Never returns null.
  - expandVars
```
public static String expandVars(String expression)
```
    Expands any variable found in the given expression with the value of the corresponding framework property.
    The variable format is ${property_key}.
    System properties are also expanded.
  - isOSGiServiceSupported
```
public static boolean isOSGiServiceSupported()
```
  - isDevModeSet
```
public static boolean isDevModeSet()
```
    Returns true if dev mode is set.
    Activating this mode, some of the code may not behave as it would in production, to ease up debugging and working on developing the application.
    For instance, it'll enable hot-reload if some packages are installed while the framework is running. It will also reset some caches when that happens.
    Before 5.6, when activating this mode, the Runtime Framework stopped on low-level errors, see handleDevError(Throwable) but this behaviour has been removed.
  - isTestModeSet
```
public static boolean isTestModeSet()
```
    Returns true if test mode is set.
    Activating this mode, some of the code may not behave as it would in production, to ease up testing.
  - isBooleanPropertyFalse
```
public static boolean isBooleanPropertyFalse(String propName)
```
    Returns true if given property is false when compared to a boolean value. Returns false if given property in unset.
    Checks for the system properties if property is not found in the runtime properties.
    
    Since:
    
    5.8
  - isBooleanPropertyTrue
```
public static boolean isBooleanPropertyTrue(String propName)
```
    Returns true if given property is true when compared to a boolean value.
    Checks for the system properties if property is not found in the runtime properties.
    
    Since:
    
    5.6
  - handleDevError
```
public static void handleDevError(Throwable t)
```
    Since 5.6, this method stops the application if property NUXEO_STRICT_RUNTIME_SYSTEM_PROP is set to true, and one of the following errors occurred during startup.
    - Component XML parse error.
    - Contribution to an unknown extension point.
    - Component with an unknown implementation class (the implementation entry exists in the XML descriptor but cannot be resolved to a class).
    - Uncatched exception on extension registration / unregistration (either in framework or user component code)
    - Uncatched exception on component activation / deactivation (either in framework or user component code)
    - Broken Nuxeo-Component MANIFEST entry. (i.e. the entry cannot be resolved to a resource)
    Before 5.6, this method stopped the application if development mode was enabled (i.e. org.nuxeo.dev system property is set) but this is not the case anymore to handle a dev mode that does not stop the runtime framework when using hot reload.
    Parameters:
    t - the exception or null if none
  - trackFile
```
public static void trackFile(File file,
             Object marker)
```
    Deletes the given file when the marker object is collected by GC.
    
    Parameters:
    file - The file to delete
    marker - the marker Object
  - trackFile
```
public static void trackFile(File file,
             Object marker,
             FileDeleteStrategy fileDeleteStrategy)
```
    Deletes the given file when the marker object is collected by GC. The fileDeleteStrategy can be used for instance do delete only empty directory or force deletion.
    
    Parameters:
    file - The file to delete
    marker - the marker Object
    fileDeleteStrategy - add a custom delete strategy
  - main
```
public static void main(String[] args)
```

Class Framework

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NUXEO_DEV_SYSTEM_PROP

NUXEO_TESTING_SYSTEM_PROP

NUXEO_STRICT_RUNTIME_SYSTEM_PROP

Method Detail

initialize

reloadResourceLoader

reloadResourceLoader

shutdown

isInitialized

getResourceLoader

getRuntime

getService

getService

getLocalService

lookup

login

loginAs

loginAsUser

login

login

sendEvent

addListener

removeListener

getProperty

getProperty

getProperties

expandVars

isOSGiServiceSupported

isDevModeSet

isTestModeSet

isBooleanPropertyFalse

isBooleanPropertyTrue

handleDevError

trackFile

trackFile

main