atg.nucleus

Class Nucleus.NucleusStartupOptions

java.lang.Object

atg.nucleus.Nucleus.NucleusStartupOptions

Enclosing class:

Nucleus

public static class Nucleus.NucleusStartupOptions
extends java.lang.Object

Start-up options for Nucleus.

Constructor Summary

Constructors

Constructor and Description
NucleusStartupOptions() Create a new, default NucleusStartupOptions.
NucleusStartupOptions(java.lang.String pConfigPath, java.lang.String pRelativePathPrefix, boolean pRestart, boolean pEnv, LogListener pListener, java.lang.String pInitialServiceName, Nucleus pParent, java.lang.ClassLoader pClassloader) Create a new NucleusStartupOptions.

Method Summary

Modifier and Type	Method and Description
java.lang.ClassLoader	getClassLoader() Returns property classLoader.
java.lang.String	getConfigPath() Returns property configPath.
java.lang.String	getInitialServiceName() Returns property initialServiceName.
LogListener	getListener() Returns property listener.
Nucleus	getParent() Returns property parent.
java.lang.String	getRelativePathPrefix() Returns property relativePathPrefix.
boolean	isEnv() Returns property env.
boolean	isRegisterChildNucleus() Returns property registerChildNucleus.
boolean	isRestart() Returns property restart.
void	setClassLoader(java.lang.ClassLoader pClassLoader) Sets property classLoader.
void	setConfigPath(java.lang.String pConfigPath) Sets property configPath.
void	setEnv(boolean pEnv) Sets property env.
void	setInitialServiceName(java.lang.String pInitialServiceName) Sets property initialServiceName.
void	setListener(LogListener pListener) Sets property listener.
void	setParent(Nucleus pParent) Sets property parent.
void	setRegisterChildNucleus(boolean pRegisterChildNucleus) Sets property registerChildNucleus.
void	setRelativePathPrefix(java.lang.String pRelativePathPrefix) Sets property relativePathPrefix.
void	setRestart(boolean pRestart) Sets property restart.

Methods inherited from class java.lang.Object

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

Constructor Detail

NucleusStartupOptions

public NucleusStartupOptions()

Create a new, default NucleusStartupOptions.

NucleusStartupOptions

public NucleusStartupOptions(java.lang.String pConfigPath,
                             java.lang.String pRelativePathPrefix,
                             boolean pRestart,
                             boolean pEnv,
                             LogListener pListener,
                             java.lang.String pInitialServiceName,
                             Nucleus pParent,
                             java.lang.ClassLoader pClassloader)

Create a new NucleusStartupOptions.

Parameters:

pConfigPath - the configuration path that will be used to find configuration files

pRestart - Whether shell command can handle restarts.

pEnv - Whether to output the environment.

pListener - the log listener for sending log events during the configuration of Nucleus

pInitialServiceName - the name of the initial service.

pNucleus - the parent Nucleus... will be null unless this is a child Nucleus.

pRelativePathPrefix - the prefix applied to relative path names that do not start with "./". Allows services to define files that should be run on a per-instance basis.

Method Detail

setConfigPath

public void setConfigPath(java.lang.String pConfigPath)

Sets property configPath. Configuration path for nucleus, taken from command-line.

getConfigPath

public java.lang.String getConfigPath()

Returns property configPath. Configuration path for nucleus, taken from command-line.

setRelativePathPrefix

public void setRelativePathPrefix(java.lang.String pRelativePathPrefix)

Sets property relativePathPrefix. The prefix for relative paths. Typically set to DYNAMO_HOME.

getRelativePathPrefix

public java.lang.String getRelativePathPrefix()

Returns property relativePathPrefix. The prefix for relative paths. Typically set to DYNAMO_HOME.

setRestart

public void setRestart(boolean pRestart)

Sets property restart. Whether we are doing a shell restart.

isRestart

public boolean isRestart()

Returns property restart. Whether we are doing a shell restart.

setEnv

public void setEnv(boolean pEnv)

Sets property env. Whether we are outputting our environment.

isEnv

public boolean isEnv()

Returns property env. Whether we are outputting our environment.

setListener

public void setListener(LogListener pListener)

Sets property listener. The initial LogListener for logging during Nucleus start-up.

getListener

public LogListener getListener()

Returns property listener. The initial LogListener for logging during Nucleus start-up.

setInitialServiceName

public void setInitialServiceName(java.lang.String pInitialServiceName)

Sets property initialServiceName. The name of the initial service Nucleus component to start-up.

getInitialServiceName

public java.lang.String getInitialServiceName()

Returns property initialServiceName. The name of the initial service Nucleus component to start-up.

setParent

public void setParent(Nucleus pParent)

Sets property parent. The parent Nucleus... normally null unless running multiple Nuclei.

getParent

public Nucleus getParent()

Returns property parent. The parent Nucleus... normally null unless running multiple Nuclei.

setClassLoader

public void setClassLoader(java.lang.ClassLoader pClassLoader)

Sets property classLoader. The ClassLoader to use for loading components.

getClassLoader

public java.lang.ClassLoader getClassLoader()

Returns property classLoader. The ClassLoader to use for loading components.

setRegisterChildNucleus

public void setRegisterChildNucleus(boolean pRegisterChildNucleus)

Sets property registerChildNucleus. Whether to register this child Nucleus with the NucleusRegistry.

isRegisterChildNucleus

public boolean isRegisterChildNucleus()

Returns property registerChildNucleus. Whether to register this child Nucleus with the NucleusRegistry.