org.nuxeo.runtime.reload

Class ReloadComponent

java.lang.Object

org.nuxeo.runtime.model.DefaultComponent

org.nuxeo.runtime.reload.ReloadComponent

All Implemented Interfaces:

Adaptable, Component, Extensible, ReloadService, TimestampedService

public class ReloadComponent
extends DefaultComponent
implements ReloadService

Author:

Bogdan Stefanescu

Field Summary

Fields inherited from interface org.nuxeo.runtime.reload.ReloadService

FLUSH_EVENT_ID, FLUSH_SEAM_EVENT_ID, RELOAD_EVENT_ID, RELOAD_REPOSITORIES_ID, RELOAD_SEAM_EVENT_ID, RELOAD_TOPIC

Constructor Summary

Constructors

Constructor and Description
ReloadComponent()

Method Summary

Methods

Modifier and Type	Method and Description
void	activate(ComponentContext context) Activates the component.
void	deactivate(ComponentContext context) Deactivates the component.
String	deployBundle(File file) Deploys bundle to the runtime, without reloading resources
String	deployBundle(File file, boolean reloadResourceClasspath) Deploys bundle to the runtime, gives possibility to control resources reloading.
void	flush() Sends a runtime event with id ReloadService.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 ReloadService.FLUSH_SEAM_EVENT_ID
static org.osgi.framework.Bundle	getBundle()
static org.osgi.framework.BundleContext	getBundleContext()
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, use runDeploymentPreprocessor() instead
Long	lastFlushed() Returns the last time one of the flush commands where called on this service instance (ReloadService.flush() or ReloadService.flushJaasCache() or ReloadService.flushSeamComponents(), or null if never called
void	reload() Sends a runtime event with id ReloadService.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 ReloadService.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 class org.nuxeo.runtime.model.DefaultComponent

applicationStarted, getAdapter, getApplicationStartedOrder, getLastModified, registerContribution, registerExtension, setLastModified, unregisterContribution, unregisterExtension

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getLastModified, setLastModified

Constructor Detail

ReloadComponent

public ReloadComponent()

Method Detail

getBundleContext

public static org.osgi.framework.BundleContext getBundleContext()

getBundle

public static org.osgi.framework.Bundle getBundle()

activate

public void activate(ComponentContext context)
              throws Exception

Description copied from interface: Component

Activates the component.

This method is called by the runtime when a component is activated.

Specified by:

activate in interface Component

Overrides:

activate in class DefaultComponent

Parameters:

context - the runtime context

Throws:

Exception - if an error occurs during activation

deactivate

public void deactivate(ComponentContext context)
                throws Exception

Description copied from interface: Component

Deactivates the component.

This method is called by the runtime when a component is deactivated.

Specified by:

deactivate in interface Component

Overrides:

deactivate in class DefaultComponent

Parameters:

context - the runtime context

Throws:

Exception - if an error occurs during activation

reload

public void reload()
            throws Exception

Description copied from interface: ReloadService

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

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

Specified by:

reload in interface ReloadService

Throws:

Exception

See Also:

ReloadService.reloadProperties()

reloadProperties

public void reloadProperties()
                      throws Exception

Description copied from interface: ReloadService

Reloads runtime framework properties

Specified by:

reloadProperties in interface ReloadService

Throws:

Exception

reloadRepository

public void reloadRepository()
                      throws Exception

Description copied from interface: ReloadService

Reloads the Nuxeo repository configuration

Specified by:

reloadRepository in interface ReloadService

Throws:

Exception

reloadSeamComponents

public void reloadSeamComponents()
                          throws Exception

Description copied from interface: ReloadService

Sends a runtime event with id ReloadService.RELOAD_SEAM_EVENT_ID

Specified by:

reloadSeamComponents in interface ReloadService

Throws:

Exception

flush

public void flush()
           throws Exception

Description copied from interface: ReloadService

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

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

Specified by:

flush in interface ReloadService

Throws:

Exception

See Also:

#flushJaasCache()}

flushJaasCache

public void flushJaasCache()
                    throws Exception

Description copied from interface: ReloadService

Sends an event that can trigger reset of JaasCache

Specified by:

flushJaasCache in interface ReloadService

Throws:

Exception

flushSeamComponents

public void flushSeamComponents()
                         throws Exception

Description copied from interface: ReloadService

Sends a runtime event with id ReloadService.FLUSH_SEAM_EVENT_ID

Specified by:

flushSeamComponents in interface ReloadService

Throws:

Exception

deployBundle

public String deployBundle(File file)
                    throws Exception

Description copied from interface: ReloadService

Deploys bundle to the runtime, without reloading resources

Specified by:

deployBundle in interface ReloadService

Throws:

Exception

See Also:

ReloadService.deployBundle(File, boolean)

deployBundle

public String deployBundle(File file,
                  boolean reloadResourceClasspath)
                    throws MalformedURLException,
                           org.osgi.framework.BundleException

Description copied from interface: ReloadService

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

Specified by:

deployBundle in interface ReloadService

Throws:

MalformedURLException

org.osgi.framework.BundleException

undeployBundle

public void undeployBundle(File file,
                  boolean reloadResources)
                    throws Exception

Description copied from interface: ReloadService

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

Specified by:

undeployBundle in interface ReloadService

Throws:

Exception

undeployBundle

public void undeployBundle(String bundleName)
                    throws Exception

Description copied from interface: ReloadService

Undeploys bundle from the runtime, given the bundle filename

Specified by:

undeployBundle in interface ReloadService

Throws:

Exception

lastFlushed

public Long lastFlushed()

Description copied from interface: ReloadService

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

Specified by:

lastFlushed in interface ReloadService

installWebResources

@Deprecated
public void installWebResources(File file)
                         throws Exception

Deprecated. since 5.6, use runDeploymentPreprocessor() instead

Description copied from interface: ReloadService

Copies the bundle web resources into the nuxeo WAR directory.

Specified by:

installWebResources in interface ReloadService

Throws:

Exception

runDeploymentPreprocessor

public void runDeploymentPreprocessor()
                               throws Exception

Description copied from interface: ReloadService

Runs the deployment preprocessor

Specified by:

runDeploymentPreprocessor in interface ReloadService

Throws:

Exception

getOSGIBundleName

public String getOSGIBundleName(File file)

Description copied from interface: ReloadService

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.

Specified by:

getOSGIBundleName in interface ReloadService