atg.nucleus
Class GenericContext

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.nucleus.GenericContext

All Implemented Interfaces:

NameContext, NameContextBindingEventSource, NameContextBindingListener, NameContextElement, atg.naming.NameContextPreBindingEventSource, NameResolver, AdminableService, atg.nucleus.ConfigurationLockRegistry, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, java.util.EventListener, javax.servlet.ServletContext

Direct Known Subclasses:

EventHandlerRegistry, Nucleus, RequestScopeManager

public class GenericContext
extends GenericService
implements NameContext, NameContextBindingEventSource, atg.naming.NameContextPreBindingEventSource, javax.servlet.ServletContext, atg.nucleus.ConfigurationLockRegistry

A GenericContext is a subclass of GenericService that also implements NameContext and NameContextBindingEventSource. This allows it to contain other services.

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

DEFAULT_LOG_TRACE_STATUS

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS

Constructor Summary

GenericContext()
Constructs a new GenericContext

Method Summary

void	addNameContextBindingListener(NameContextBindingListener pListener) Adds the specified listener to the list of listeners that will be notified whenever an element is bound into or unbound from this NameContext.
void	addNameContextPreBindingListener(atg.naming.NameContextPreBindingListener pListener) Adds the specified listener to the list of listeners that will be notified whenever an element is bound into or unbound from this NameContext.
void	clearElementLock(ComponentName pName) Clears the lock for the given component when it's no longer required.
void	doStopService() This is called when a Service is required to shut down.
java.lang.Object	getAttribute(java.lang.String pName) Returns an the value of an attribute in the ServletContext.
java.util.Enumeration	getAttributeNames() Returns an Enumeration containing the attribute names available within this servlet context.
atg.nucleus.ConfigurationLock	getConfigurationLock() Get a ConfigurationLock for this NameContext.
javax.servlet.ServletContext	getContext(java.lang.String uripath) Returns a ServletContext object that corresponds to a specified URL on the server.
java.lang.String	getContextPath() Gets the context path.
java.io.File	getDocumentRoot() Returns the document root
java.lang.Object	getElement(java.lang.String pName) Returns the element bound to the specified name.
atg.nucleus.ConfigurationLock	getElementLock(ComponentName pName) Get a ConfigurationLock for the given element name in this NameContext.
java.lang.String	getInitParameter(java.lang.String pName) GenericContext does not have any mechanism for specifying init params.
java.util.Enumeration	getInitParameterNames() GenericContext does not have any mechanism for specifying init params.
int	getMajorVersion() Returns the major version of the Java Servlet API that this Web server supports.
java.lang.String	getMimeType(java.lang.String pFile) Returns the mime type of the specified file or null if the mime type is not recognized.
MimeTyper	getMimeTyper() Returns the mime type mapping object.
int	getMinorVersion() Returns the minor version of the Servlet API that this Web server supports.
NameContextBindingListener[]	getNameContextBindingListeners() Returns the list of NameContextBindingListeners
atg.naming.NameContextPreBindingListener[]	getNameContextPreBindingListeners() Returns the list of NameContextBindingListeners
javax.servlet.RequestDispatcher	getNamedDispatcher(java.lang.String pName) GenericContext does not have any mechanism for specifying named servlets in the Servlet 2.2 sense.
java.lang.Object	getPendingElement(ComponentName pName) Get a pending element for this registry.
java.lang.String	getRealPath(java.lang.String pPath) Returns the file system path for the PathInfo specified.
javax.servlet.RequestDispatcher	getRequestDispatcher(java.lang.String pUrlPath) Returns a RequestDispatcher object that acts as a wrapper for the resource located at the named path.
java.net.URL	getResource(java.lang.String pPath) Returns the resource that is mapped to a specified path.
java.io.InputStream	getResourceAsStream(java.lang.String pPath) Returns the resource located at the named path as an InputStream object.
java.util.Set	getResourcePaths(java.lang.String pPath) SERVLET_2_3_UNIMPLEMENTED Stub for a new method in Servlet 2.3 spec.
java.lang.String	getServerInfo() Returns the string identifying the server.
javax.servlet.Servlet	getServlet(java.lang.String pName) Returns a servlet with the specified name.
java.lang.String	getServletContextName() SERVLET_2_3_UNIMPLEMENTED Stub for a new method in Servlet 2.3 spec.
java.util.Enumeration	getServletNames() Returns the list of servlet names as an Enumeration.
java.util.Enumeration	getServlets() Returns the servlets defined in this context
boolean	isElementBound(java.lang.String pName) Returns true if the name has an element bound to it, false if not.
java.lang.Object	listElement(java.lang.String pName) Returns the element bound to the specified name.
java.util.Enumeration	listElementNames() Returns the list of element names as an Enumeration
java.util.Enumeration	listElements() Returns the list of bound elements as an Enumeration
void	log(java.lang.Exception e, java.lang.String pMessage) Writes the stacktrace and the given log message to the "informational" messages for this servlet.
void	log(java.lang.String pMessage) Logs this message using regular nucleus logging facilities for this context
void	log(java.lang.String pMessage, java.lang.Throwable pThrowable) Logs this message using regular nucleus logging facilities for this context
void	notifyAddedObject(java.lang.String pName, java.lang.Object pElement) Notifies pElement that it has just been added to this name context with the name pName.
void	notifyRemovedObject(java.lang.String pName, java.lang.Object pElement) Notifies pElement that it has been removed from this name context.
void	preNotifyAddedObject(java.lang.String pName, java.lang.Object pElement) Notifies pElement that it is about to be added to this name context.
void	preNotifyRemovedObject(java.lang.String pName, java.lang.Object pElement) Notifies pElement that it is about to be removed from this name context.
void	putElement(java.lang.String pName, java.lang.Object pElement) Binds the specified element to the specified name.
void	putPendingElement(ComponentName pName, java.lang.Object pElement) Put a pending element in this registry.
void	removeAttribute(java.lang.String pName) Removes the attribute with the given name from the servlet context.
void	removeElement(java.lang.String pName) Removes the binding for the specified name.
void	removeNameContextBindingListener(NameContextBindingListener pListener) Removes the specified listener from the list of listeners that will be notified whenever an element is bound into or unbound from this NameContext.
void	removeNameContextPreBindingListener(atg.naming.NameContextPreBindingListener pListener) Removes the specified listener from the list of listeners that will be notified whenever an element is bound into or unbound from this NameContext.
void	removePendingElement(ComponentName pName) Removes the pending element for the specified name.
void	setAttribute(java.lang.String pName, java.lang.Object pObject) Gives an attribute a name in this servlet context.
void	setDocumentRoot(java.io.File pDocumentRoot) Sets the document root
void	setMimeTyper(MimeTyper pMimeTyper) Sets the mime type mapping object
void	startService(ServiceEvent pEvent) Overrides the implementation in GenericService.

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, doStartService, getAbsoluteName, getAdminServlet, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, 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, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, stopService

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning

Methods inherited from class java.lang.Object

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

Methods inherited from interface atg.naming.NameContextElement

getName, getNameContext

Methods inherited from interface atg.naming.NameContextBindingListener

nameContextElementBound, nameContextElementUnbound

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Constructor Detail

GenericContext

public GenericContext()

Constructs a new GenericContext

Method Detail

addNameContextPreBindingListener

public void addNameContextPreBindingListener(atg.naming.NameContextPreBindingListener pListener)

Adds the specified listener to the list of listeners that will be notified whenever an element is bound into or unbound from this NameContext.

Specified by:

addNameContextPreBindingListener in interface atg.naming.NameContextPreBindingEventSource

removeNameContextPreBindingListener

public void removeNameContextPreBindingListener(atg.naming.NameContextPreBindingListener pListener)

Removes the specified listener from the list of listeners that will be notified whenever an element is bound into or unbound from this NameContext.

Specified by:

removeNameContextPreBindingListener in interface atg.naming.NameContextPreBindingEventSource

getNameContextPreBindingListeners

public atg.naming.NameContextPreBindingListener[] getNameContextPreBindingListeners()

Returns the list of NameContextBindingListeners

addNameContextBindingListener

public void addNameContextBindingListener(NameContextBindingListener pListener)

Adds the specified listener to the list of listeners that will be notified whenever an element is bound into or unbound from this NameContext.

Specified by:

addNameContextBindingListener in interface NameContextBindingEventSource

removeNameContextBindingListener

public void removeNameContextBindingListener(NameContextBindingListener pListener)

Removes the specified listener from the list of listeners that will be notified whenever an element is bound into or unbound from this NameContext.

Specified by:

removeNameContextBindingListener in interface NameContextBindingEventSource

getNameContextBindingListeners

public NameContextBindingListener[] getNameContextBindingListeners()

Returns the list of NameContextBindingListeners

doStopService

public void doStopService()
                   throws ServiceException

This is called when a Service is required to shut down. The Service should respond by stopping any processes that it has started. This will also stop any services contained by this service.

Overrides:

doStopService in class GenericService

Throws:

ServiceException - if the Service had a problem shutting down

getElement

public java.lang.Object getElement(java.lang.String pName)

Returns the element bound to the specified name.

Specified by:

getElement in interface NameContext

putElement

public void putElement(java.lang.String pName,
                       java.lang.Object pElement)

Binds the specified element to the specified name.

Specified by:

putElement in interface NameContext

notifyAddedObject

public void notifyAddedObject(java.lang.String pName,
                              java.lang.Object pElement)

Notifies pElement that it has just been added to this name context with the name pName.

Parameters:

pName -

pElement -

notifyRemovedObject

public void notifyRemovedObject(java.lang.String pName,
                                java.lang.Object pElement)

Notifies pElement that it has been removed from this name context.

Parameters:

pName - The name the removed object was bound to

pElement - The object being removed

preNotifyRemovedObject

public void preNotifyRemovedObject(java.lang.String pName,
                                   java.lang.Object pElement)

Notifies pElement that it is about to be removed from this name context.

Parameters:

pName - The name the removed object was bound to

pElement - The object being removed

preNotifyAddedObject

public void preNotifyAddedObject(java.lang.String pName,
                                 java.lang.Object pElement)

Notifies pElement that it is about to be added to this name context.

Parameters:

pName - The name the removed object was bound to

pElement - The object being removed

removeElement

public void removeElement(java.lang.String pName)

Removes the binding for the specified name.

Specified by:

removeElement in interface NameContext

isElementBound

public boolean isElementBound(java.lang.String pName)

Returns true if the name has an element bound to it, false if not.

Specified by:

isElementBound in interface NameContext

listElementNames

public java.util.Enumeration listElementNames()

Returns the list of element names as an Enumeration

Specified by:

listElementNames in interface NameContext

listElements

public java.util.Enumeration listElements()

Returns the list of bound elements as an Enumeration

Specified by:

listElements in interface NameContext

listElement

public java.lang.Object listElement(java.lang.String pName)

Returns the element bound to the specified name. This uses unsynchronized access to the element list; in normal circumstances, use getElement(String) instead.

startService

public void startService(ServiceEvent pEvent)
                  throws ServiceException

Overrides the implementation in GenericService. If we are starting a Servlet object, also call its init method.

Specified by:

startService in interface ServiceListener

Overrides:

startService in class GenericService

Parameters:

pEvent - the ServiceEvent encapsulating information about the Service's environment and configuration

Throws:

NamingException - if there was a problem resolving a name

ServiceException - if an error occurred while attempting to start the service.

getServlet

public javax.servlet.Servlet getServlet(java.lang.String pName)

Returns a servlet with the specified name. If the name is a regular string name, it is looked up relative to this NameContext. It can also specifiy an absolute or relative path name to the Servlet to be returned.

Specified by:

getServlet in interface javax.servlet.ServletContext

getServletContextName

public java.lang.String getServletContextName()

SERVLET_2_3_UNIMPLEMENTED Stub for a new method in Servlet 2.3 spec.

Specified by:

getServletContextName in interface javax.servlet.ServletContext

getContextPath

public java.lang.String getContextPath()

Gets the context path. This Servlet 2.5 method is unimplemented and will throw a runtime exception

Specified by:

getContextPath in interface javax.servlet.ServletContext

getServletNames

public java.util.Enumeration getServletNames()

Returns the list of servlet names as an Enumeration. Nucleus defined this method as returning a list of the servlets only defined in this context - not all servlets defined for the server.

Specified by:

getServletNames in interface javax.servlet.ServletContext

getServlets

public java.util.Enumeration getServlets()

Returns the servlets defined in this context

Specified by:

getServlets in interface javax.servlet.ServletContext

log

public void log(java.lang.String pMessage)

Logs this message using regular nucleus logging facilities for this context

Specified by:

log in interface javax.servlet.ServletContext

log

public void log(java.lang.Exception e,
                java.lang.String pMessage)

Writes the stacktrace and the given log message to the "informational" messages for this servlet.

Specified by:

log in interface javax.servlet.ServletContext

getRealPath

public java.lang.String getRealPath(java.lang.String pPath)

Returns the file system path for the PathInfo specified.

Specified by:

getRealPath in interface javax.servlet.ServletContext

getMimeType

public java.lang.String getMimeType(java.lang.String pFile)

Returns the mime type of the specified file or null if the mime type is not recognized.

Specified by:

getMimeType in interface javax.servlet.ServletContext

getServerInfo

public java.lang.String getServerInfo()

Returns the string identifying the server.

Specified by:

getServerInfo in interface javax.servlet.ServletContext

getAttribute

public java.lang.Object getAttribute(java.lang.String pName)

Returns an the value of an attribute in the ServletContext.

Specified by:

getAttribute in interface javax.servlet.ServletContext

getDocumentRoot

public java.io.File getDocumentRoot()

Returns the document root

setDocumentRoot

public void setDocumentRoot(java.io.File pDocumentRoot)

Sets the document root

getMimeTyper

public MimeTyper getMimeTyper()

Returns the mime type mapping object.

setMimeTyper

public void setMimeTyper(MimeTyper pMimeTyper)

Sets the mime type mapping object

getPendingElement

public java.lang.Object getPendingElement(ComponentName pName)

Get a pending element for this registry. A pending element is one that is currently being configured.

Specified by:

getPendingElement in interface atg.nucleus.ConfigurationLockRegistry

putPendingElement

public void putPendingElement(ComponentName pName,
                              java.lang.Object pElement)

Put a pending element in this registry. A pending element is one that is currently being configured.

Specified by:

putPendingElement in interface atg.nucleus.ConfigurationLockRegistry

removePendingElement

public void removePendingElement(ComponentName pName)

Removes the pending element for the specified name.

Specified by:

removePendingElement in interface atg.nucleus.ConfigurationLockRegistry

getConfigurationLock

public atg.nucleus.ConfigurationLock getConfigurationLock()

Get a ConfigurationLock for this NameContext.

Specified by:

getConfigurationLock in interface atg.nucleus.ConfigurationLockRegistry

getElementLock

public atg.nucleus.ConfigurationLock getElementLock(ComponentName pName)

Get a ConfigurationLock for the given element name in this NameContext.

Specified by:

getElementLock in interface atg.nucleus.ConfigurationLockRegistry

clearElementLock

public void clearElementLock(ComponentName pName)

Clears the lock for the given component when it's no longer required.

Specified by:

clearElementLock in interface atg.nucleus.ConfigurationLockRegistry

See Also:

ConfigurationLockRegistry.clearElementLock(ComponentName)

getContext

public javax.servlet.ServletContext getContext(java.lang.String uripath)

Returns a ServletContext object that corresponds to a specified URL on the server.

This method allows servlets to gain access to the resources located at a specified URL and obtain RequestDispatcher objects from it.

In security conscious environments, the servlet engine can return null for a given URL.

Specified by:

getContext in interface javax.servlet.ServletContext

Parameters:

uripath - a String specifying the URL for which you are requesting a ServletContext object

Returns:

the ServletContext object that corresponds to the named URL

See Also:

RequestDispatcher

getMajorVersion

public int getMajorVersion()

Returns the major version of the Java Servlet API that this Web server supports. All implementations that comply with Version 2.1 must have this method return the integer 2.

Specified by:

getMajorVersion in interface javax.servlet.ServletContext

Returns:

2

getMinorVersion

public int getMinorVersion()

Returns the minor version of the Servlet API that this Web server supports. All implementations that comply with Version 2.2 must have this method return the integer 2.

Specified by:

getMinorVersion in interface javax.servlet.ServletContext

Returns:

2

getResource

public java.net.URL getResource(java.lang.String pPath)
                         throws java.net.MalformedURLException

Returns the resource that is mapped to a specified path. The path must be in the form /dir/dir/file.ext.

This method allows the Web server to make a resource available to a servlet from any source. Resources can be located on a local or remote file system, in a database, or on a remote network site.

This method can return null if no resource is mapped to the pathname.

The servlet engine must implement the URL handlers and URLConnection objects that are necessary to access the resource.

This method has a different purpose than java.lang.Class.getResource, which looks up resources based on a class loader. This method does not use class loaders.

Specified by:

getResource in interface javax.servlet.ServletContext

Parameters:

pPath - a String specifying the path to the resource, in the form /dir/dir/file.ext

Returns:

the resource located at the named path, or null if there is no resource at that path

Throws:

java.net.MalformedURLException - if the pathname is not given in the correct form

getResourceAsStream

public java.io.InputStream getResourceAsStream(java.lang.String pPath)

Returns the resource located at the named path as an InputStream object.

The data in the InputStream can be of any type or length. The path must be of the form /dir/dir/file.ext. This method returns null if no resource exists at the specified path.

Metainformation such as content length and content type that is available when you use the getResource method is lost when you use this method.

The servlet engine must implement the URL handlers and URLConnection objects necessary to access the resource.

This method is different from java.lang.Class.getResourceAsStream, which uses a class loader. This method allows servlet engines to make a resource available to a servlet from any location, without using a class loader.

Specified by:

getResourceAsStream in interface javax.servlet.ServletContext

Parameters:

pPath - a String specifying the path to the resource, in the form /dir/dir/file.ext

Returns:

the InputStream returned to the servlet, or null if no resource exists at the specified path

getResourcePaths

public java.util.Set getResourcePaths(java.lang.String pPath)

SERVLET_2_3_UNIMPLEMENTED Stub for a new method in Servlet 2.3 spec.

Specified by:

getResourcePaths in interface javax.servlet.ServletContext

getRequestDispatcher

public javax.servlet.RequestDispatcher getRequestDispatcher(java.lang.String pUrlPath)

Returns a RequestDispatcher object that acts as a wrapper for the resource located at the named path. You can use a RequestDispatcher object to forward a request to the resource or include a resource in a response.

The pathname must be in the form /dir/dir/file.ext. This method returns null if the ServletContext cannot return a RequestDispatcher.

The servlet engine is responsible for wrapping the resource with a RequestDispatcher object.

Specified by:

getRequestDispatcher in interface javax.servlet.ServletContext

Parameters:

pUrlPath - a String specifying the pathname to the resource

Returns:

a RequestDispatcher object that acts as a wrapper for the resource at the path you specify

See Also:

RequestDispatcher

getNamedDispatcher

public javax.servlet.RequestDispatcher getNamedDispatcher(java.lang.String pName)

GenericContext does not have any mechanism for specifying named servlets in the Servlet 2.2 sense.

Specified by:

getNamedDispatcher in interface javax.servlet.ServletContext

getAttributeNames

public java.util.Enumeration getAttributeNames()

Returns an Enumeration containing the attribute names available within this servlet context. You can use the getAttribute(java.lang.String) method with an attribute name to get the value of an attribute.

Specified by:

getAttributeNames in interface javax.servlet.ServletContext

Returns:

an Enumeration of attribute names

See Also:

getAttribute(java.lang.String)

setAttribute

public void setAttribute(java.lang.String pName,
                         java.lang.Object pObject)

Gives an attribute a name in this servlet context. If the name specified is already used for an attribute, this method will overwrite the old attribute and bind the name to the new attribute.

Attribute names should follow the same convention as package names. The Java Servlet API specification reserves names matching java.*, javax.*, and sun.*.

Specified by:

setAttribute in interface javax.servlet.ServletContext

Parameters:

pName - a String specifying the name of the attribute

pObject - an Object representing the attribute to be given the name

removeAttribute

public void removeAttribute(java.lang.String pName)

Removes the attribute with the given name from the servlet context. If you remove an attribute, and then use getAttribute(java.lang.String) to retrieve the attribute's value, getAttribute returns null.

Specified by:

removeAttribute in interface javax.servlet.ServletContext

Parameters:

pName - a String specifying the name of the attribute to be removed

getInitParameter

public java.lang.String getInitParameter(java.lang.String pName)

GenericContext does not have any mechanism for specifying init params. To use this feature you must place your servlet in a Web Application.

Specified by:

getInitParameter in interface javax.servlet.ServletContext

getInitParameterNames

public java.util.Enumeration getInitParameterNames()

GenericContext does not have any mechanism for specifying init params. To use this feature you must place your servlet in a Web Application.

Specified by:

getInitParameterNames in interface javax.servlet.ServletContext

log

public void log(java.lang.String pMessage,
                java.lang.Throwable pThrowable)

Logs this message using regular nucleus logging facilities for this context

Specified by:

log in interface javax.servlet.ServletContext