com.kabira.platform.component

Class Notifier

java.lang.Object

com.kabira.platform.component.Notifier

public class Notifier
extends java.lang.Object

Component state change notifier class.

A Notifier class may choose to override any of the methods. The default implementation does nothing.

Notifier methods are called from within a transaction.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Notifier() Prevent direct instantiation.

Method Summary

Modifier and Type	Method and Description
protected void	addToClassPath(java.io.File file) Adds to the class path of the current JVM.
protected java.lang.String[]	getApplicationParameters() Returns the application parameters provided to the deploy tool when the current JVM was deployed.
protected java.io.File	getOutputDirectory() Returns a server-side directory which can be used for creating JVM specific artifacts.
protected java.io.File	getResource(java.lang.String resourceName) Deprecated.
protected java.io.File	getTargetArchive() Returns a handle to a local copy of the target archive or file specified to the deploy tool when the current JVM was deployed.
protected java.lang.String	getTargetName() Returns the name of the target provided to the deploy tool when the current JVM was deployed.
protected void	postConfigurationInitialize() Called after all configuration files for the component currently being activated have been loaded and activated.
protected void	postConfigurationTerminate() Called during component deactivation after all of the configuration files from this component have been deactivated and unloaded.
protected void	preConfigurationInitialize() Called before any configuration files for the component currently being activated have been loaded and activated.
protected void	preConfigurationTerminate() Called during component deactivation before any of the configuration files from this component have been deactivated and unloaded.

Methods inherited from class java.lang.Object

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

Constructor Detail

Notifier

protected Notifier()

Prevent direct instantiation.

Method Detail

preConfigurationInitialize

protected void preConfigurationInitialize()
                                   throws ComponentException

Called before any configuration files for the component currently being activated have been loaded and activated.

Throws:

ComponentException - Used to communicate a fatal initialize error.

postConfigurationInitialize

protected void postConfigurationInitialize()
                                    throws ComponentException

Called after all configuration files for the component currently being activated have been loaded and activated.

Throws:

ComponentException - Used to communicate a fatal initialization error.

preConfigurationTerminate

protected void preConfigurationTerminate()

Called during component deactivation before any of the configuration files from this component have been deactivated and unloaded.

postConfigurationTerminate

protected void postConfigurationTerminate()

Called during component deactivation after all of the configuration files from this component have been deactivated and unloaded.

getTargetName

protected final java.lang.String getTargetName()

Returns the name of the target provided to the deploy tool when the current JVM was deployed.

Returns:

target name.

getTargetArchive

protected final java.io.File getTargetArchive()

Returns a handle to a local copy of the target archive or file specified to the deploy tool when the current JVM was deployed. Returns null if the current target is not an archive or file.

Returns:

target archive or file

getResource

@Deprecated
protected final java.io.File getResource(java.lang.String resourceName)
                                              throws ComponentException

Deprecated.

Returns a handle to a local copy of the requested file. This method will be removed from the public interface in a future release. There is no replacement.

Parameters:

resourceName - Name of the file to find. Path information is ignored.

Returns:

The copy of the file. null is returned if the file cannot be found.

Throws:

ComponentException - - no longer used.

getApplicationParameters

protected final java.lang.String[] getApplicationParameters()

Returns the application parameters provided to the deploy tool when the current JVM was deployed.

Returns:

deployment tool application parameters

getOutputDirectory

protected final java.io.File getOutputDirectory()

Returns a server-side directory which can be used for creating JVM specific artifacts.

Null is returned if the output directory found or created.

Returns:

The output directory for the calling JVM.

addToClassPath

protected final void addToClassPath(java.io.File file)

Adds to the class path of the current JVM.

Parameters:

file - The jar or directory to add to the class path.