public class Nucleus extends GenericContext implements javax.servlet.Servlet
A Nucleus serves two purposes: it is the root of a NameContext hierarchy, and it implements the policies for resolving names in the hierarchy.
Because a Nucleus is the root of the naming hierarchy, the Nucleus has no enclosing NameContext, its name is null, and its absolute name is "/".
When a Nucleus is constructed, it must be passed the configuration path. From there, the Nucleus will find its own configuration, including the property "initialServiceName". This initial service name is then resolved, which causes the rest of the services to be started.
Modifier and Type | Class and Description |
---|---|
static interface |
Nucleus.InitialLogListener
A marker interface to mark an InitalLogListener that
may be removed once a non-InitialLogListener is added (depending
on the removeInitialLogListener property).
|
static class |
Nucleus.NucleusStartupOptions
Start-up options for Nucleus.
|
class |
Nucleus.ValidationRunner |
GenericContext.ConcurrencyModel
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
boolean |
mAllowReloadableComponents |
java.util.Map |
mClassReplacementMap |
boolean |
mEnableClassReplacement |
java.lang.String |
mLastValidationFailureReason |
static int |
RESTART_STATUS |
SERVICE_INFO_KEY
DEFAULT_LOG_TRACE_STATUS
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS
Constructor and Description |
---|
Nucleus(java.lang.String pConfigPath)
Constructs a new Nucleus.
|
Nucleus(java.lang.String pConfigPath,
java.lang.String pRelativePathPrefix,
LogListener pListener)
Constructs a new Nucleus.
|
Modifier and Type | Method and Description |
---|---|
void |
addCachedResolveTime(long pTime) |
void |
addComponentListener(atg.nucleus.ComponentListener l)
add a ComponentListener -- delegated to ComponentRegistry which
monitors component activations/deactivations.
|
void |
addConfigurationListener(atg.nucleus.ConfigurationListener l)
add a ConfigurationListener
|
void |
addLogListener(LogListener pLogListener)
Adds a listener to the list of log listeners
|
void |
addPostShutdownAction(atg.nucleus.PostShutdownAction pPostShutdownAction)
Add a shut-down action to be performed at the end of shutdown.
|
void |
addPostShutdownAction(atg.nucleus.PostShutdownAction pPostShutdownAction,
boolean pAddToEnd)
Add a shut-down action to be performed at the end of shutdown.
|
void |
addPostStartupAction(atg.nucleus.PostStartupAction pPostStartupAction)
Add a start-up action to be performed after startup.
|
void |
addUnCachedResolveTime(long pTime) |
protected javax.servlet.Servlet |
createAdminServlet()
Creates and returns a new Servlet that will administer this
service.
|
protected atg.nucleus.ConfigurationFileSystems |
createConfigFileSystems()
Creates the set of VirtualFileSystem implementations that will be
used to find configurations.
|
protected MultipleConfigurationFinder |
createConfigurationFinder()
Creates and returns the MultipleConfigurationFinder that will be
used to find configurations.
|
void |
destroy()
Called when the servlet is to be destroyed
|
static boolean |
displayLicense(Nucleus pNucleus)
Displays the license in an AWT frame, returns true if accepted,
false if not.
|
void |
doStopService()
This is called when a Service is required to shut down.
|
protected javax.servlet.Servlet |
fetchNextServlet() |
void |
fireConfigurationDeleted(atg.nucleus.ConfigurationEvent evt)
fire a ConfigurationEvent deletion
|
void |
fireConfigurationUpdated(atg.nucleus.ConfigurationEvent evt)
fire a ConfigurationEvent update
|
protected java.lang.String |
formatServiceName(java.lang.String pServiceName,
javax.servlet.http.HttpServletRequest pRequest) |
java.lang.String |
getAbsoluteElementName(NameContextElement pElement,
java.lang.String pName)
Returns what would be the absolute name of the specified element
if it were contained by the specified element.
|
java.lang.String |
getAbsoluteName(NameContextElement pElement)
Returns the absolute name of the specified NameContextElement.
|
java.lang.String |
getAbsoluteNameOf(java.lang.Object pComponent)
Return the absolute name of pComponent.
|
java.lang.String |
getAdminServerPrefix() |
atg.nucleus.AdminServletConfiguration |
getAdminServletConfiguration()
Returns property adminServletConfiguration.
|
java.lang.String |
getAdminServletConfigurationPath()
Returns property adminServletConfigurationPath.
|
atg.nucleus.AllowedClasses |
getAllowedClasses()
The object that determines which classes may or may not be used
in Nucleus.
|
java.lang.String[] |
getAllowedClassNames() |
byte[] |
getAllowedClassNamesSignature() |
boolean |
getAllowReloadableComponents()
Whether to allow reloadable components.
|
java.lang.String[] |
getApplicationNames() |
java.lang.String[] |
getApplicationURLs() |
BeanConfigurator |
getBeanConfigurator()
Returns the BeanConfigurator that should be used to configure a
bean from Properties.
|
atg.nucleus.StartupComponentProcessor[] |
getBeforeStartupComponentProcessors()
Returns property beforeStartupComponentProcessor.
|
boolean |
getCheckFileNameCase()
Whether or not we check the case of property file names against the
canonical case used by the OS.
|
boolean |
getCheckForSerFiles()
Whether or not we check for .ser files when instantiating beans.
|
java.lang.Class[] |
getClassesToLoad()
Returns property classesToLoad.
|
static java.lang.ClassLoader |
getClassLoader()
Returns the global class loader for all Nuclei.
|
java.util.Map |
getClassReplacementMap() |
atg.nucleus.ComponentLockManager |
getComponentLockManager()
Get the component lock manager.
|
atg.nucleus.ComponentProxyFactory |
getComponentProxyFactory()
Returns property
componentProxyFactory |
VirtualFileSystem[] |
getConfigFileSystems()
The configuration file systems used by nucleus.
|
java.io.File[] |
getConfigPath() |
java.lang.String |
getConfigPath(java.lang.String pServerName)
Returns the config path for a specified server name
|
java.lang.String[] |
getConfigPathNames()
The current configpath, separated into individual config path
entries.
|
atg.nucleus.ConfigurationCacheEntry |
getConfigurationCacheEntry(java.lang.String pConfigName)
Gets the cached Configuration object
|
atg.nucleus.ConfigurationCacheEntry |
getConfigurationCacheEntry(java.lang.String pConfigName,
boolean pForceRefresh)
Gets the cached Configuration object
|
long |
getConfigurationCheckMilliseconds() |
java.lang.String |
getConfigurationCompileCommand()
Returns the command used to compile java configurations
|
atg.nucleus.ConfigurationFileSystems |
getConfigurationFileSystems()
Return the ConfigurationFileSystems object for this Nucleus
|
ConfigurationFinder |
getConfigurationFinder()
Returns the ConfigurationFinder that should be used to obtain the
Configuration for a given configuration name.
|
atg.nucleus.ConfigurationListener[] |
getConfigurationListeners()
Returns the list of configuration listeners as an array property.
|
atg.nucleus.ConfigurationPropertyFilter |
getConfigurationPropertyExceptionFilter() |
java.util.Dictionary |
getConfigurations(java.lang.String pName)
Return a dictionary of Configurations that exist within some potential
NameContext.
|
java.util.Dictionary |
getConfigurations(java.lang.String pName,
boolean pForceRefresh)
Return a dictionary of Configurations that exist within some potential
NameContext.
|
atg.nucleus.ConfigurationUpdater |
getConfigurationUpdater(java.lang.String pFileSystemName)
Returns the ConfigurationUpdater that should be used to update a
ConfigurationState in the named file system.
|
boolean |
getCreateSourceTemplates() |
atg.nucleus.ConfigCreationFilter |
getCreationFilter()
Set the creation filter used, if any.
|
atg.nucleus.ConfigurationUpdater |
getDefaultConfigurationUpdater(java.lang.String pFileSystemName)
Returns a ConfigurationUpdater that will update a
component in the default file system for updates, or a given
file system, whichever is the more specific.
|
java.lang.String |
getDefaultLanguage() |
java.util.Locale |
getDefaultLocale()
Returns the server's locale.
|
java.lang.String |
getDefaultRegion() |
boolean |
getEnableClassReplacement()
Returns true if Nucleus should attempt to replace classes at name resolution time by using the values found
in the
classReplacementMap |
boolean |
getEnableLinks() |
java.util.Properties |
getEnvironment() |
atg.nucleus.SoftSelfCleaningCache |
getGlobalComponentCache()
Returns the dictionary containing a
cache of global components
|
static Nucleus |
getGlobalNucleus()
Returns a reference to the global Nucleus for
the current web application.
|
java.lang.String |
getInitialServiceName()
Returns the name of the initial service to start
|
atg.nucleus.InstanceFactory |
getInstanceFactory(java.lang.String pConfigPath)
Get the InstanceFactory at the specified component path.
|
atg.nucleus.InstanceFactory |
getInstanceFactoryForService(java.lang.String pComponentPath)
Get the InstanceFactory for the service at the specified component
path or null if that service does not exist, or if the service
does not use a LanaguageLoader, or if the InstanceFactory that the
service specifies does not exist or cannot be loaded.
|
JavaConfigurationClassLoaders |
getJavaConfigurationClassLoaders()
Returns the object used to obtain class loaders for configuration
directories.
|
static java.lang.Throwable |
getLicenseFailureException() |
boolean |
getLogResourceNames() |
atg.nucleus.dms.DASMessageSource |
getMessageSource() |
atg.naming.NameUnresolver |
getNameUnresolver()
Returns the NameUnresolver associated with this Nucleus' global scope.
|
java.lang.String |
getNextServlet() |
static atg.nucleus.registry.NucleusRegistry |
getNucleusRegistry()
Returns the Nucleus registry used to hold
per web app nuclei.
|
boolean |
getOldParamBehavior() |
java.lang.String |
getOriginalConfigPath()
Returns property originalConfigPath.
|
java.lang.String |
getPreInitialServiceName()
The path of a service to be resolved very early in start-up, event
before even the configuration VFSes are set up.
|
PropertyValueFormatters |
getPropertyValueFormatters()
Returns the table mapping property class to property value
formatter
|
int |
getReferenceCount() |
boolean |
getRegisterRequestComponents()
Will the Nucleus NameUnresolver register
request scoped components?
|
boolean |
getRegisterSessionComponents()
Will the Nucleus NameUnresolver register
session scoped components?
|
java.lang.String |
getRelativePathPrefix() |
java.util.Map<java.lang.String,java.lang.String> |
getRemappedScopes()
Returns property remappedScopes.
|
atg.nucleus.GlobalScopeManager |
getScopeManager()
Returns property scopeManager.
|
atg.nucleus.ComponentSecurityDomain |
getSecurityDomain()
Returns the component security domain used by Nucleus.
|
boolean |
getSendD4StyleEvents() |
javax.servlet.ServletConfig |
getServletConfig()
Returns the configuration for this Servlet
|
javax.servlet.ServletContext |
getServletContext()
Returns the context for this servlet (if any)
|
java.lang.String |
getServletInfo()
Returns the information string for this servlet
|
boolean |
getShellRestart()
Does this nucleus support the restart operation? (i.e.
|
long |
getStartTime()
Time in millis at which this nucleus was created.
|
SubClasser |
getSubClasser(java.lang.String pConfigPaths)
Return the subclasser from the specified config paths (comma separated
list of nucleus paths.
|
static Nucleus |
getSystemNucleus() |
boolean |
getUseJavaConfigurationFinder()
Whether or not we use the JavaConfigurationFinder to check for
.java or .class files which will, when compiled and instantiated,
serve as a component instance.
|
UserAuthority |
getUserAuthority()
Returns the user authority used for ACL resolution in Nucleus.
|
boolean |
getWarningAboutImproperScopeAccess()
Gets the flag indicating whether the warning is wanted.
|
void |
init(javax.servlet.ServletConfig pServletConfig)
Initializes this Servlet with the specified configuration
|
protected void |
initCreationFilter()
Instantiates a new creation filter from the
atg.nucleus.Nucleus.creationFilterClass property.
|
boolean |
isCachingGlobalComponents()
Returns true if this Nucleus is caching global components.
|
boolean |
isConfigFileSystemsCreated()
Whether the "vfs=" entries in the
config file system list have been created.
|
boolean |
isConfigurationExceptionWarning(java.lang.Object pBean,
java.lang.String pPropertyName)
Whether the configuration exception should be a warning instead of
an error.
|
boolean |
isDebugComponentLocking()
Whether to attempt to debug component locking.
|
boolean |
isDisableConfigurationCache()
Whether we should disable the configuration cache altogether.
|
boolean |
isDumpReferenceChains()
Returns property dumpReferenceChains
|
boolean |
isFilteredComponent(java.lang.String pName)
Whether or not the specified component name was previously
filtered.
|
boolean |
isFirstTime() |
boolean |
isGCAfterStartup()
Returns the flag indicating if Nucleus should perform a GC after
starting up.
|
boolean |
isRemoveInitialLogListeners()
Whether to remove log listeners implementing the InitialLogListener
interface when a non-InitialLogListener is added.
|
static boolean |
isSingleNucleus()
Returns true if there is only a single nucleus in the JVM.
|
boolean |
isStopping() |
boolean |
isWarningAboutImproperScopeAccess()
Gets the flag indicating whether the warning is wanted.
|
static java.lang.Class |
loadClass(java.lang.String pClassName)
Load a class using Nucleus' own class loader.
|
static void |
main(java.lang.String[] pArgs)
Runs the Nucleus
|
void |
makeNewClassLoader()
Instantiates a new development class loader and sets it as the global
class loader for Nucleus, if a class path has been specified for it.
|
static java.lang.String[] |
parseNucleusClassPath()
Returns an array of strings representing the parsed Nucleus class path.
|
protected void |
performPostShutdownActions()
Perform any post shut-down actions previously added.
|
protected void |
performPostStartupActions()
Perform any post start-up actions previously added.
|
protected void |
performPostStartupActions(atg.nucleus.PostStartupAction[] pStartupActions)
Perform the specified startup actions.
|
void |
registerValidateableService(Validateable pService)
Registers the specified service with the list of services to be
validated periodically.
|
void |
removeComponentListener(atg.nucleus.ComponentListener l)
remove a ComponentListener
|
void |
removeConfigurationCacheEntry(java.lang.String pConfigName)
Removes the cached Configuration object.
|
void |
removeConfigurationListener(atg.nucleus.ConfigurationListener l)
remove a ConfigurationListener
|
boolean |
removeLiveComponent(java.lang.Object pComponent)
Remove a live component from the Nucleus, stopping it as cleanly as possible
and removing it from its parent context.
|
void |
reportCachePerformance() |
java.lang.Object |
resolveName(ComponentName pName,
NameContext pNameContext,
boolean pCreate)
Resolves the specified name in the specified context.
|
java.lang.Object |
resolveName(java.lang.String pName,
NameContext pNameContext,
boolean pCreate)
Resolves the specified name in the specified context.
|
boolean |
restartInstanceFactoryComponent(java.lang.String pComponentPath,
java.lang.Object pService,
NameResolver pNameResolver)
Restart a component that was created by an InstanceFactory.
|
void |
service(javax.servlet.http.HttpServletRequest pRequest,
javax.servlet.http.HttpServletResponse pResponse)
Handles http requests
|
void |
service(javax.servlet.ServletRequest pRequest,
javax.servlet.ServletResponse pResponse)
Handles requests
|
void |
setAdditionalComponentListeners(atg.nucleus.ComponentListener[] pListeners)
Write only property for adding additional comonent listeners.
|
void |
setAdminServerPrefix(java.lang.String pAdminServerPrefix)
Sets the property AdminServerPrefix.
|
void |
setAdminServletConfigurationPath(java.lang.String pAdminServletConfigurationPath)
Sets property adminServletConfiguration.
|
void |
setAllowedClassNames(java.lang.String[] pAllowedClassNames)
The list of class names allowed to be used as Nucleus Services.
|
void |
setAllowedClassNamesSignature(byte[] pAllowedClassNamesSignature) |
void |
setAllowReloadableComponents(boolean pAllow)
Configures if Nucleus will respect the $reloadable
attribute in .properties files.
|
void |
setApplicationNames(java.lang.String[] pApplicationNames) |
void |
setApplicationURLs(java.lang.String[] pApplicationURLs) |
void |
setBeforeStartupComponentProcessors(atg.nucleus.StartupComponentProcessor[] pBeforeStartupComponentProcessors)
Sets property beforeStartupComponentProcessor.
|
void |
setCacheGlobalComponents(boolean pCache)
Sets if the Nucleus is caching global components
|
void |
setCheckFileNameCase(boolean pCheckCase)
Whether or not we check the case of property file names against the
canonical case used by the OS.
|
void |
setCheckForSerFiles(boolean pCheckForSerFiles) |
void |
setClassesToLoad(java.lang.Class[] pClassesToLoad)
Sets property classesToLoad.
|
static void |
setClassLoader(java.lang.ClassLoader pClassLoader)
Sets the global class loader for this
nucleus.
|
void |
setClassReplacementMap(java.util.Map pClassReplacementMap) |
void |
setComponentLockManager(atg.nucleus.ComponentLockManager pComponentLockManager)
Set the component lock manager.
|
void |
setComponentProxyFactory(atg.nucleus.ComponentProxyFactory pComponentProxyFactory)
Sets property
componentProxyFactory |
void |
setConfigPath(java.io.File[] pConfigPath)
The current configpath as configured by nucleus.
|
void |
setConfigurationCheckMilliseconds(long pConfigurationCheckMilliseconds) |
void |
setConfigurationCompileCommand(java.lang.String pConfigurationCompileCommand)
Sets the command used to compile java configurations
|
void |
setConfigurationListeners(atg.nucleus.ConfigurationListener[] pConfigurationListeners)
Set the list of configuration listeners as an array property.
|
void |
setConfigurationPropertyExceptionFilter(atg.nucleus.ConfigurationPropertyFilter pConfigurationPropertyExceptionFilter)
Sets the property ConfigurationPropertyExceptionFilter.
|
void |
setCreateSourceTemplates(boolean pCreateSourceTemplates) |
void |
setCreationFilter(atg.nucleus.ConfigCreationFilter pCreationFilter)
Get the creation filter used, if any.
|
void |
setDebugComponentLocking(boolean pDebugComponentLocking)
Whether to attempt to debug component locking.
|
void |
setDefaultLanguage(java.lang.String pDefaultLanguage)
Sets the property DefaultLanguage.
|
void |
setDefaultRegion(java.lang.String pDefaultRegion)
Sets the property DefaultRegion.
|
void |
setDisableConfigurationCache(boolean pDisableConfigurationCache)
Whether we should disable the configuration cache altogether.
|
void |
setDocumentRoot(java.io.File pPath)
Override the implementation of the setDocumentRoot to update
the doc root for the docroot config path entry
|
void |
setDumpReferenceChains(boolean pDumpReferenceChains)
Sets property dumpReferenceChains
|
void |
setEnableClassReplacement(boolean pEnableClassReplacement)
Controls if Nucleus should attempt to replace classes at name resolution time by using the values found
in the
classReplacementMap |
void |
setEnableLinks(boolean pEnableLinks)
Sets the property EnableLinks.
|
void |
setEnvironment(java.util.Properties pEnvironment)
The classpath entries that are configured in the Nucleus.properties
file.
|
void |
setGCAfterStartup(boolean pGCAfterStartup)
Sets the flag indicating if Nucleus should perform a GC after
starting up.
|
void |
setInitialServiceName(java.lang.String pInitialServiceName)
Sets the name of the initial service
|
static void |
setLicenseFailureException(java.lang.Throwable pLicenseFailureException)
Sets the property LicenseFailureException.
|
void |
setLogResourceNames(boolean pLogResourceNames)
Sets the property LogResourceNames.
|
void |
setMessageSource(atg.nucleus.dms.DASMessageSource pMessageSource) |
void |
setNextServlet(java.lang.String pNextServlet)
The next servlet to render if we don't find a component for the
specified URL.
|
static void |
setNucleusRegistry(atg.nucleus.registry.NucleusRegistry pNucleusRegistry)
Returns the Nucleus registry used to hold
child Nuclei.
|
void |
setOldParamBehavior(boolean pOldParamBehavior) |
void |
setOriginalConfigPath(java.lang.String pOriginalConfigPath)
Sets property originalConfigPath.
|
void |
setPreInitialServiceName(java.lang.String pPreInitialServiceName)
The path of a service to be resolved very early in start-up, event
before even the configuration VFSes are set up.
|
void |
setReferenceCount(int pReferenceCount)
Sets the property ReferenceCount.
|
void |
setRegisterNucleusShutdownHook(boolean pRegisterNucleusShutdownHook)
Sets the flag indicating if Nucleus should register a shutdown
during startup
|
void |
setRegisterRequestComponents(boolean pRegisterRequestComponents)
Will the Nucleus NameUnresolver register
request scoped components?
|
void |
setRegisterSessionComponents(boolean pRegisterSessionComponents)
Will the Nucleus NameUnresolver register
session scoped components?
|
void |
setRelativePathPrefix(java.lang.String pRelativePathPrefix)
The path name prepended onto relative paths that do not have an
explicit "./" in front of them.
|
void |
setRemappedScopes(java.util.Map<java.lang.String,java.lang.String> pRemappedScopes)
Sets property remappedScopes.
|
void |
setRemoveInitialLogListeners(boolean pRemoveInitialLogListeners)
Whether to remove log listeners implementing the InitialLogListener
interface when a non-InitialLogListener is added.
|
void |
setSendD4StyleEvents(boolean pSendD4StyleEvents) |
void |
setUseJavaConfigurationFinder(boolean pUseFinder)
Whether or not we use the JavaConfigurationFinder.
|
void |
setWarningAboutImproperScopeAccess(boolean pWarn)
Sets the flag which enables or disables the warning.
|
Nucleus |
spawnNucleus(java.lang.ClassLoader pClassLoader,
java.lang.String pConfig,
java.lang.String pPathPrefix)
Spawns a new Nucleus using the given class
loader and the given configpath
|
static Nucleus |
startNucleus(java.lang.String[] pArgs)
Creates a Nucleus initialized from a set of command line args,
then returns it.
|
static Nucleus |
startNucleusCheckLicense(java.lang.String[] pArgs)
Creates a Nucleus initialized from a set of command line args,
then returns it.
|
void |
stopService()
Stops the service.
|
void |
waitForInitialization()
Returns after this Nucleus has completely initialized itself.
|
addNameContextBindingListener, addNameContextPreBindingListener, clearElementLock, complainIfComponentAlreadyHasParentNameContext, createChildNameContext, getAttribute, getAttributeNames, getConfigurationLock, getContext, getContextPath, getDocumentRoot, getElement, getElementLock, getInitParameter, getInitParameterNames, getMajorVersion, getMimeType, getMimeTyper, getMinorVersion, getNameContextBindingListeners, getNameContextPreBindingListeners, getNamedDispatcher, getPendingElement, getRealPath, getRequestDispatcher, getResource, getResourceAsStream, getResourcePaths, getServerInfo, getServlet, getServletContextName, getServletNames, getServlets, isElementBound, isOptimizedForConcurrency, listElement, listElementNames, listElements, log, log, log, notifyAddedObject, notifyRemovedObject, preNotifyAddedObject, preNotifyRemovedObject, putElement, putPendingElement, removeAttribute, removeElement, removeNameContextBindingListener, removeNameContextPreBindingListener, removePendingElement, setAttribute, setMimeTyper, startService
doStartService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getName, getNameContext
nameContextElementBound, nameContextElementUnbound
public static final java.lang.String CLASS_VERSION
public static final int RESTART_STATUS
public boolean mAllowReloadableComponents
public java.lang.String mLastValidationFailureReason
public boolean mEnableClassReplacement
public volatile java.util.Map mClassReplacementMap
public Nucleus(java.lang.String pConfigPath, java.lang.String pRelativePathPrefix, LogListener pListener)
pConfigPath
- the configuration path that will be used to
find configuration filespRelativePathPrefix
- prepend this path prefix onto relative
path names in .properties files (can be null for no prefix)pListener
- a listener to use for receiving log eventspublic Nucleus(java.lang.String pConfigPath)
pConfigPath
- the configuration path that will be used to
find configuration filespublic boolean isCachingGlobalComponents()
public atg.nucleus.SoftSelfCleaningCache getGlobalComponentCache()
public boolean getAllowReloadableComponents()
public void setAllowReloadableComponents(boolean pAllow)
public void setCacheGlobalComponents(boolean pCache)
pCache
- Flag controlling cache use. True means do cache, false means
do not cache.public long getStartTime()
public atg.nucleus.dms.DASMessageSource getMessageSource()
public void setMessageSource(atg.nucleus.dms.DASMessageSource pMessageSource)
public boolean getSendD4StyleEvents()
public void setSendD4StyleEvents(boolean pSendD4StyleEvents)
public boolean getOldParamBehavior()
public void setOldParamBehavior(boolean pOldParamBehavior)
public void setWarningAboutImproperScopeAccess(boolean pWarn)
pWarn
- true if we want the warning, false otherwisepublic boolean getWarningAboutImproperScopeAccess()
public boolean isWarningAboutImproperScopeAccess()
public void setLogResourceNames(boolean pLogResourceNames)
pLogResourceNames
- new value to setpublic boolean getLogResourceNames()
public void setDefaultRegion(java.lang.String pDefaultRegion)
pDefaultRegion
- new value to setpublic java.lang.String getDefaultRegion()
public void setDefaultLanguage(java.lang.String pDefaultLanguage)
pDefaultLanguage
- new value to setpublic java.lang.String getDefaultLanguage()
public java.util.Locale getDefaultLocale()
public void setAdminServerPrefix(java.lang.String pAdminServerPrefix)
pAdminServerPrefix
- new value to setpublic java.lang.String getAdminServerPrefix()
public static void setLicenseFailureException(java.lang.Throwable pLicenseFailureException)
public static java.lang.Throwable getLicenseFailureException()
public atg.nucleus.AdminServletConfiguration getAdminServletConfiguration()
public void setAdminServletConfigurationPath(java.lang.String pAdminServletConfigurationPath)
public java.lang.String getAdminServletConfigurationPath()
public void setRemappedScopes(java.util.Map<java.lang.String,java.lang.String> pRemappedScopes)
public java.util.Map<java.lang.String,java.lang.String> getRemappedScopes()
public static Nucleus getGlobalNucleus()
public static Nucleus getSystemNucleus()
public void setEnableLinks(boolean pEnableLinks)
public boolean getEnableLinks()
public static boolean displayLicense(Nucleus pNucleus)
public atg.nucleus.ConfigurationUpdater getConfigurationUpdater(java.lang.String pFileSystemName)
pFileSystemName
- the name of the file system in which updates
are to take place. If null, a ConfigurationUpdater is returned
that works with all defined file systems, targeting the last.public atg.nucleus.ConfigurationUpdater getDefaultConfigurationUpdater(java.lang.String pFileSystemName)
pFileSystemName
- the name of a "preferred" file system
in which updates are to take place.public boolean removeLiveComponent(java.lang.Object pComponent)
public SubClasser getSubClasser(java.lang.String pConfigPaths)
pConfigPaths
- a comma separated list of nucleus component
paths. These paths should return to SubClassers or InstanceFactories.public atg.nucleus.InstanceFactory getInstanceFactory(java.lang.String pConfigPath)
pConfigPath
- the potentially comma separated list of
Nucleus component paths that either implement InstanceFactory
or SubClasser.public atg.nucleus.InstanceFactory getInstanceFactoryForService(java.lang.String pComponentPath)
public boolean restartInstanceFactoryComponent(java.lang.String pComponentPath, java.lang.Object pService, NameResolver pNameResolver) throws atg.nucleus.InstanceFactoryException
pComponentPath
- the component path of the component to be
restartedpService
- the current instance of the component.pNameResolver
- the name resolve to useatg.nucleus.InstanceFactoryException
public java.util.Dictionary getConfigurations(java.lang.String pName)
public java.util.Dictionary getConfigurations(java.lang.String pName, boolean pForceRefresh)
public void setDocumentRoot(java.io.File pPath)
setDocumentRoot
in class GenericContext
public ConfigurationFinder getConfigurationFinder()
public atg.nucleus.ConfigurationFileSystems getConfigurationFileSystems()
public BeanConfigurator getBeanConfigurator()
public PropertyValueFormatters getPropertyValueFormatters()
public atg.nucleus.ConfigurationCacheEntry getConfigurationCacheEntry(java.lang.String pConfigName)
public atg.nucleus.ConfigurationCacheEntry getConfigurationCacheEntry(java.lang.String pConfigName, boolean pForceRefresh)
public void removeConfigurationCacheEntry(java.lang.String pConfigName)
protected atg.nucleus.ConfigurationFileSystems createConfigFileSystems()
protected MultipleConfigurationFinder createConfigurationFinder()
public void waitForInitialization()
public boolean getCreateSourceTemplates()
public void setCreateSourceTemplates(boolean pCreateSourceTemplates)
public atg.naming.NameUnresolver getNameUnresolver()
public void addComponentListener(atg.nucleus.ComponentListener l)
public void removeComponentListener(atg.nucleus.ComponentListener l)
public void setAdditionalComponentListeners(atg.nucleus.ComponentListener[] pListeners)
public atg.nucleus.ConfigurationListener[] getConfigurationListeners()
public void setConfigurationListeners(atg.nucleus.ConfigurationListener[] pConfigurationListeners)
public void addConfigurationListener(atg.nucleus.ConfigurationListener l)
public void removeConfigurationListener(atg.nucleus.ConfigurationListener l)
public void fireConfigurationUpdated(atg.nucleus.ConfigurationEvent evt)
public void fireConfigurationDeleted(atg.nucleus.ConfigurationEvent evt)
public java.lang.String getInitialServiceName()
public void setInitialServiceName(java.lang.String pInitialServiceName)
public java.lang.String getConfigurationCompileCommand()
public void setConfigurationCompileCommand(java.lang.String pConfigurationCompileCommand)
public boolean isGCAfterStartup()
public void setRegisterNucleusShutdownHook(boolean pRegisterNucleusShutdownHook)
public void setGCAfterStartup(boolean pGCAfterStartup)
public long getConfigurationCheckMilliseconds()
public void setConfigurationCheckMilliseconds(long pConfigurationCheckMilliseconds)
public void setBeforeStartupComponentProcessors(atg.nucleus.StartupComponentProcessor[] pBeforeStartupComponentProcessors)
public atg.nucleus.StartupComponentProcessor[] getBeforeStartupComponentProcessors()
public void setClassesToLoad(java.lang.Class[] pClassesToLoad)
public java.lang.Class[] getClassesToLoad()
public boolean getCheckFileNameCase()
public void setCheckFileNameCase(boolean pCheckCase)
public boolean getUseJavaConfigurationFinder()
public void setUseJavaConfigurationFinder(boolean pUseFinder)
public boolean getCheckForSerFiles()
public void setCheckForSerFiles(boolean pCheckForSerFiles)
public boolean getRegisterSessionComponents()
public void setRegisterSessionComponents(boolean pRegisterSessionComponents)
public boolean getRegisterRequestComponents()
public void setRegisterRequestComponents(boolean pRegisterRequestComponents)
public JavaConfigurationClassLoaders getJavaConfigurationClassLoaders()
public void setEnvironment(java.util.Properties pEnvironment)
public java.util.Properties getEnvironment()
public void setRelativePathPrefix(java.lang.String pRelativePathPrefix)
public java.lang.String getRelativePathPrefix()
public void setConfigPath(java.io.File[] pConfigPath)
Note that since the configpath can also contain entries which do not refer to files, but rather to file system components, this configpath is partial. Use the configPathNames property instead to get all the config path entries.
public java.io.File[] getConfigPath()
public java.lang.String[] getConfigPathNames()
public void setNextServlet(java.lang.String pNextServlet)
public java.lang.String getNextServlet()
protected javax.servlet.Servlet fetchNextServlet()
public void setApplicationURLs(java.lang.String[] pApplicationURLs)
public java.lang.String[] getApplicationURLs()
public void setApplicationNames(java.lang.String[] pApplicationNames)
public java.lang.String[] getApplicationNames()
public void setAllowedClassNames(java.lang.String[] pAllowedClassNames)
public java.lang.String[] getAllowedClassNames()
public void setAllowedClassNamesSignature(byte[] pAllowedClassNamesSignature)
public byte[] getAllowedClassNamesSignature()
public atg.nucleus.AllowedClasses getAllowedClasses()
public java.lang.String getAbsoluteNameOf(java.lang.Object pComponent)
pComponent
- the component to get the absolute name ofpublic java.lang.String getAbsoluteName(NameContextElement pElement)
public java.lang.String getAbsoluteElementName(NameContextElement pElement, java.lang.String pName)
public java.lang.Object resolveName(ComponentName pName, NameContext pNameContext, boolean pCreate)
pName
- the name to be resolvedpNameContext
- the NameContext to which the name is relativepCreate
- flag indicating whether Nucleus should attempt to
create the object if it does not already exist in the naming
hierarchy.public java.lang.Object resolveName(java.lang.String pName, NameContext pNameContext, boolean pCreate)
pName
- the name to be resolvedpNameContext
- the NameContext to which the name is relativepCreate
- flag indicating whether Nucleus should attempt to
create the object if it does not already exist in the naming
hierarchy.public final void registerValidateableService(Validateable pService)
public void init(javax.servlet.ServletConfig pServletConfig) throws javax.servlet.ServletException
init
in interface javax.servlet.Servlet
javax.servlet.ServletException
- if an error occurred while initializing
the Servletpublic javax.servlet.ServletConfig getServletConfig()
getServletConfig
in interface javax.servlet.Servlet
public javax.servlet.ServletContext getServletContext()
public java.lang.String getServletInfo()
getServletInfo
in interface javax.servlet.Servlet
public void destroy()
destroy
in interface javax.servlet.Servlet
public void service(javax.servlet.ServletRequest pRequest, javax.servlet.ServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
service
in interface javax.servlet.Servlet
javax.servlet.ServletException
- if an error occurred while processing
the servlet requestjava.io.IOException
- if an error occurred while reading or writing
the servlet requestprotected java.lang.String formatServiceName(java.lang.String pServiceName, javax.servlet.http.HttpServletRequest pRequest)
public void service(javax.servlet.http.HttpServletRequest pRequest, javax.servlet.http.HttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
javax.servlet.ServletException
- if an error occurred while processing
the servlet requestjava.io.IOException
- if an error occurred while reading or writing
the servlet requestprotected javax.servlet.Servlet createAdminServlet()
createAdminServlet
in class GenericService
public static boolean isSingleNucleus()
public java.lang.String getConfigPath(java.lang.String pServerName)
public boolean getShellRestart()
public boolean isStopping()
public void setReferenceCount(int pReferenceCount)
pReferenceCount
- new value to setpublic int getReferenceCount()
public void setComponentProxyFactory(atg.nucleus.ComponentProxyFactory pComponentProxyFactory)
componentProxyFactory
pComponentProxyFactory
- componentproxy factorypublic atg.nucleus.ComponentProxyFactory getComponentProxyFactory()
componentProxyFactory
public void setCreationFilter(atg.nucleus.ConfigCreationFilter pCreationFilter)
public atg.nucleus.ConfigCreationFilter getCreationFilter()
public void setDebugComponentLocking(boolean pDebugComponentLocking)
public boolean isDebugComponentLocking()
public void setComponentLockManager(atg.nucleus.ComponentLockManager pComponentLockManager)
public atg.nucleus.ComponentLockManager getComponentLockManager()
public VirtualFileSystem[] getConfigFileSystems()
public boolean isConfigFileSystemsCreated()
public void setDisableConfigurationCache(boolean pDisableConfigurationCache)
public boolean isDisableConfigurationCache()
public void setPreInitialServiceName(java.lang.String pPreInitialServiceName)
This property is ignored if an explicit initial service has been passed on the command line, since that typically indicates a more limited start-up environment.
public java.lang.String getPreInitialServiceName()
This property is ignored if an explicit initial service has been passed on the command line, since that typically indicates a more limited start-up environment.
public boolean isFilteredComponent(java.lang.String pName)
pName
- the name (nucleus path) of the
component which may have been previously filtered.public void setConfigurationPropertyExceptionFilter(atg.nucleus.ConfigurationPropertyFilter pConfigurationPropertyExceptionFilter)
pConfigurationPropertyExceptionFilter
- new value to setpublic atg.nucleus.ConfigurationPropertyFilter getConfigurationPropertyExceptionFilter()
public void setDumpReferenceChains(boolean pDumpReferenceChains)
public boolean isDumpReferenceChains()
public void setRemoveInitialLogListeners(boolean pRemoveInitialLogListeners)
public boolean isRemoveInitialLogListeners()
public void setOriginalConfigPath(java.lang.String pOriginalConfigPath)
public java.lang.String getOriginalConfigPath()
public atg.nucleus.GlobalScopeManager getScopeManager()
public boolean isConfigurationExceptionWarning(java.lang.Object pBean, java.lang.String pPropertyName)
public void stopService() throws ServiceException
stopService
in interface ServiceListener
stopService
in class GenericContext
ServiceException
- if an error occurred while attempting
to stop the service.public UserAuthority getUserAuthority()
public atg.nucleus.ComponentSecurityDomain getSecurityDomain()
public static java.lang.ClassLoader getClassLoader()
public static void setClassLoader(java.lang.ClassLoader pClassLoader)
public static java.lang.String[] parseNucleusClassPath()
public void makeNewClassLoader()
protected void initCreationFilter()
public static java.lang.Class loadClass(java.lang.String pClassName) throws java.lang.ClassNotFoundException
java.lang.ClassNotFoundException
public Nucleus spawnNucleus(java.lang.ClassLoader pClassLoader, java.lang.String pConfig, java.lang.String pPathPrefix)
pClassLoader
- the classloader to be used by this NucleuspConfig
- the config path for this nucleuspPathPrefix
- 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.public static atg.nucleus.registry.NucleusRegistry getNucleusRegistry()
public static void setNucleusRegistry(atg.nucleus.registry.NucleusRegistry pNucleusRegistry)
pNucleusRegistry
- the Nucleus registry to usepublic static void main(java.lang.String[] pArgs)
public static Nucleus startNucleus(java.lang.String[] pArgs)
public static Nucleus startNucleusCheckLicense(java.lang.String[] pArgs)
public boolean isFirstTime()
public void addCachedResolveTime(long pTime)
public void addUnCachedResolveTime(long pTime)
public void reportCachePerformance()
public boolean getEnableClassReplacement()
classReplacementMap
public void setEnableClassReplacement(boolean pEnableClassReplacement)
classReplacementMap
public java.util.Map getClassReplacementMap()
public void setClassReplacementMap(java.util.Map pClassReplacementMap)
pClassReplacementMap
- the classReplacementMap to setpublic void doStopService() throws ServiceException
GenericContext
doStopService
in class GenericContext
ServiceException
- if the Service had a problem shutting downpublic void addPostStartupAction(atg.nucleus.PostStartupAction pPostStartupAction)
pPostStartupAction
- the post start-up action add to the list
of actions to be performed at the end of startup.protected void performPostStartupActions()
protected void performPostStartupActions(atg.nucleus.PostStartupAction[] pStartupActions)
pStartupActions
- the startup actions to invoke.public void addPostShutdownAction(atg.nucleus.PostShutdownAction pPostShutdownAction)
pPostShutdownAction
- the post shut-down action to be prepended
to the list of actions to be performed at the end of shutdown.public void addPostShutdownAction(atg.nucleus.PostShutdownAction pPostShutdownAction, boolean pAddToEnd)
pPostShutdownAction
- the post shut-down action to be added
to the list of actions to be performed at the end of shutdown.pAddToEnd
- whether to add to the end of the list. A false value
means add to beginning, a false value means add to beginning (last to
be executed).protected void performPostShutdownActions()
public void addLogListener(LogListener pLogListener)
GenericService
addLogListener
in interface atg.nucleus.logging.ApplicationLoggingSender
addLogListener
in class GenericService