org.nuxeo.runtime.reload

Interface ReloadService

All Superinterfaces:

TimestampedService

All Known Implementing Classes:

ReloadComponent

public interface ReloadService
extends TimestampedService

Service tracking reload related events or commands when installing a package

Author:

Bogdan Stefanescu

Field Summary

Fields

Modifier and Type	Field and Description
static String	AFTER_RELOAD_EVENT_ID
static String	BEFORE_RELOAD_EVENT_ID
static String	FLUSH_EVENT_ID
static String	FLUSH_SEAM_EVENT_ID
static String	RELOAD_EVENT_ID
static String	RELOAD_REPOSITORIES_ID
static String	RELOAD_SEAM_EVENT_ID
static String	RELOAD_TOPIC

Method Summary

Modifier and Type	Method and Description
String	deployBundle(File file) Deploys bundle to the runtime, without reloading resources
String	deployBundle(File file, boolean reloadResources) Deploys bundle to the runtime, gives possibility to control resources reloading.
void	flush() Sends a runtime event with id FLUSH_EVENT_ID so that listeners can be notified that a flush is needed (after a reload for instance).
void	flushJaasCache() Sends an event that can trigger reset of JaasCache
void	flushSeamComponents() Sends a runtime event with id FLUSH_SEAM_EVENT_ID
String	getOSGIBundleName(File file) Returns the OSGI bundle name if given file can be identified as an OSGI bundle, or null.
void	installWebResources(File file) Deprecated. since 5.6: runDeploymentPreprocessor() method now re-deploys all jars so that the nuxeo.war holds the same content than it would at startup.
Long	lastFlushed() Returns the last time one of the flush commands where called on this service instance (flush() or flushJaasCache() or flushSeamComponents(), or null if never called
void	reload() Sends a runtime event with id RELOAD_EVENT_ID so that listeners can be notified that a reload has been done.
void	reloadProperties() Reloads runtime framework properties
void	reloadRepository() Reloads the Nuxeo repository configuration
void	reloadSeamComponents() Sends a runtime event with id RELOAD_SEAM_EVENT_ID
void	runDeploymentPreprocessor() Runs the deployment preprocessor
void	undeployBundle(File file, boolean reloadResources) Undeploys bundle from the runtime, given the bundle resource, gives possibility to control resources reloading
void	undeployBundle(String bundleName) Undeploys bundle from the runtime, given the bundle filename

Methods inherited from interface org.nuxeo.runtime.service.TimestampedService

getLastModified, setLastModified

Field Detail

RELOAD_TOPIC

static final String RELOAD_TOPIC

See Also:

Constant Field Values

FLUSH_EVENT_ID

static final String FLUSH_EVENT_ID

See Also:

Constant Field Values

BEFORE_RELOAD_EVENT_ID

static final String BEFORE_RELOAD_EVENT_ID

See Also:

Constant Field Values

RELOAD_EVENT_ID

static final String RELOAD_EVENT_ID

See Also:

Constant Field Values

AFTER_RELOAD_EVENT_ID

static final String AFTER_RELOAD_EVENT_ID

See Also:

Constant Field Values

FLUSH_SEAM_EVENT_ID

static final String FLUSH_SEAM_EVENT_ID

See Also:

Constant Field Values

RELOAD_SEAM_EVENT_ID

static final String RELOAD_SEAM_EVENT_ID

See Also:

Constant Field Values

RELOAD_REPOSITORIES_ID

static final String RELOAD_REPOSITORIES_ID

See Also:

Constant Field Values

Method Detail

reload

void reload()
     throws Exception

Sends a runtime event with id RELOAD_EVENT_ID so that listeners can be notified that a reload has been done.

Also calls reloadProperties() by default, but not other reload methods as they could alter the running application behaviour.

Throws:

Exception

Since:

5.5

See Also:

reloadProperties()

reloadRepository

void reloadRepository()
               throws Exception

Reloads the Nuxeo repository configuration

Throws:

Exception

reloadProperties

void reloadProperties()
               throws Exception

Reloads runtime framework properties

Throws:

Exception

reloadSeamComponents

void reloadSeamComponents()
                   throws Exception

Sends a runtime event with id RELOAD_SEAM_EVENT_ID

Throws:

Exception

Since:

5.5

flush

void flush()
    throws Exception

Sends a runtime event with id FLUSH_EVENT_ID so that listeners can be notified that a flush is needed (after a reload for instance).

Also calls flushJaasCache() by default, but not other flush methods as they could alter the running application behaviour.

Throws:

Exception

Since:

5.5

See Also:

#flushJaasCache()}

lastFlushed

Long lastFlushed()

Returns the last time one of the flush commands where called on this service instance (flush() or flushJaasCache() or flushSeamComponents(), or null if never called

Since:

5.6

flushJaasCache

void flushJaasCache()
             throws Exception

Sends an event that can trigger reset of JaasCache

Throws:

Exception

flushSeamComponents

void flushSeamComponents()
                  throws Exception

Sends a runtime event with id FLUSH_SEAM_EVENT_ID

Throws:

Exception

Since:

5.6

deployBundle

String deployBundle(File file)
             throws Exception

Deploys bundle to the runtime, without reloading resources

Throws:

Exception

Since:

5.5

See Also:

deployBundle(File, boolean)

deployBundle

String deployBundle(File file,
                    boolean reloadResources)
             throws Exception

Deploys bundle to the runtime, gives possibility to control resources reloading.

Throws:

Exception

Since:

5.5

undeployBundle

void undeployBundle(File file,
                    boolean reloadResources)
             throws Exception

Undeploys bundle from the runtime, given the bundle resource, gives possibility to control resources reloading

Throws:

Exception

Since:

5.6

undeployBundle

void undeployBundle(String bundleName)
             throws Exception

Undeploys bundle from the runtime, given the bundle filename

Throws:

Exception

Since:

5.6

runDeploymentPreprocessor

void runDeploymentPreprocessor()
                        throws Exception

Runs the deployment preprocessor

Throws:

Exception

Since:

5.6

installWebResources

@Deprecated
void installWebResources(File file)
                              throws Exception

Deprecated. since 5.6: runDeploymentPreprocessor() method now re-deploys all jars so that the nuxeo.war holds the same content than it would at startup.

Copies the bundle web resources into the nuxeo WAR directory.

Throws:

Exception

Since:

5.5

getOSGIBundleName

String getOSGIBundleName(File file)

Returns the OSGI bundle name if given file can be identified as an OSGI bundle, or null. The OSGI bundle can be a jar or an exploded jar on file system.

Since:

5.6