public class GenericRMIService extends atg.nucleus.logging.VariableArgumentApplicationLoggingRMIImpl implements NameContextBindingListener, ComponentNameResolver, NameContextElement, ServiceListener, Service, atg.nucleus.logging.ApplicationLoggingSender, AdminableService, atg.naming.NameContextParentable, atg.naming.AbsoluteNameable, atg.nucleus.Configured
This is a combination of GenericService and UnicastRemoteObject, thereby serving as a convenient base for objects that will be exported by the RMIServer.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
static java.lang.String |
SERVICE_INFO_KEY
Should be used as a key to retrieve the serviceInfo property from ResourceBundles
|
DEFAULT_LOG_TRACE_STATUS
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS
Constructor and Description |
---|
GenericRMIService()
Constructs a new GenericRMIService
|
Modifier and Type | Method and Description |
---|---|
void |
addLogListener(LogListener pListener)
Adds a listener to the list of log listeners
|
protected javax.servlet.Servlet |
createAdminServlet()
Creates and returns a new Servlet that will administer this
service.
|
void |
doStartService()
This is called after a Service has been created, placed into the
naming hierarchy, and initialized with its configured property
values.
|
void |
doStopService()
This is called when a Service is required to shut down.
|
java.lang.String |
getAbsoluteName()
Returns the absolute name of this service, using Nucleus to get
the absolute name.
|
javax.servlet.Servlet |
getAdminServlet()
Returns the Servlet that will handle requests directed at this
service.
|
java.lang.String |
getAdminServletOutputStreamEncoding()
get AdminServletOutputStreamEncoding - This determines the character encoding
for the PrintWriter when the AdminServlet writes data to the response
|
protected ApplicationLogging |
getLoggingForVlogging()
Get the ApplicationLogging instance to use for vlog methods.
|
int |
getLogListenerCount()
Returns the number of log listeners
|
LogListener[] |
getLogListeners()
Returns the list of log listeners as an array property.
|
java.lang.String |
getName()
Returns the name by which this element is know within its enclosing
NameContext.
|
NameContext |
getNameContext()
Returns the NameContext into which this element has been bound,
or null if the element is not bound in a NameContext.
|
Nucleus |
getNucleus()
Returns the Nucleus managing this Service
|
java.rmi.server.RemoteRef |
getRef()
Override getRef() method so that
ref property will not be serialized
to UI client. |
NameContext |
getRoot()
Searches up the tree until it finds the root NameContext
|
Configuration |
getServiceConfiguration()
Returns the Configuration that was used to create this Service,
null if there was none.
|
java.lang.String |
getServiceInfo()
Returns the a descriptive string about this service
|
boolean |
isAdminServletUseServletOutputStream()
get AdminServletUseServletOutputStream - This flag determines whether the
AdminServlet should write data to the response using a ServletOutputStream or
a PrintWriter.
|
boolean |
isLoggingDebug()
This method returns whether or not an debug log event should be
broadcast.
|
boolean |
isLoggingError()
This method returns whether or not an error log event should be
broadcast.
|
boolean |
isLoggingInfo()
This method returns whether or not an info log event should be
broadcast.
|
boolean |
isLoggingTrace()
This method returns whether or not an trace log event should be
broadcast.
|
boolean |
isLoggingWarning()
This method returns whether or not an warning log event should be
broadcast.
|
boolean |
isRunning()
Returns true if this Service is currently running.
|
void |
logDebug(java.lang.String pMessage)
Logs an debug event with the specified message
|
void |
logDebug(java.lang.String pMessage,
java.lang.Throwable pThrowable)
Logs an debug event with the specified message and Throwable
|
void |
logDebug(java.lang.Throwable pThrowable)
Logs an debug event with the specified Throwable
|
void |
logError(java.lang.String pMessage)
Logs an error event with the specified message
|
void |
logError(java.lang.String pMessage,
java.lang.Throwable pThrowable)
Logs an error event with the specified message and Throwable
|
void |
logError(java.lang.Throwable pThrowable)
Logs an error event with the specified Throwable
|
void |
logInfo(java.lang.String pMessage)
Logs an info event with the specified message
|
void |
logInfo(java.lang.String pMessage,
java.lang.Throwable pThrowable)
Logs an info event with the specified message and Throwable
|
void |
logInfo(java.lang.Throwable pThrowable)
Logs an info event with the specified Throwable
|
void |
logTrace(java.lang.String pMessage)
Logs an trace event with the specified message
|
void |
logTrace(java.lang.String pMessage,
java.lang.Throwable pThrowable)
Logs an trace event with the specified message and Throwable
|
void |
logTrace(java.lang.Throwable pThrowable)
Logs an trace event with the specified Throwable
|
void |
logWarning(java.lang.String pMessage)
Logs an warning event with the specified message
|
void |
logWarning(java.lang.String pMessage,
java.lang.Throwable pThrowable)
Logs an warning event with the specified message and Throwable
|
void |
logWarning(java.lang.Throwable pThrowable)
Logs an warning event with the specified Throwable
|
void |
nameContextElementBound(NameContextBindingEvent pEvent)
This is called to notify this context that it is being bound into
a NameContext.
|
void |
nameContextElementUnbound(NameContextBindingEvent pEvent)
This is called to notify this context that it is being unbound
from a NameContext.
|
void |
removeLogListener(LogListener pListener)
Removes a listener from the list of log listeners
|
protected java.lang.Object |
reResolveThis()
Return this service, but re-resolved in our current name context.
|
java.lang.Object |
resolveName(ComponentName pName)
Resolves the specified name, relative to this context's parent.
|
java.lang.Object |
resolveName(ComponentName pName,
boolean pCreate)
Resolves the specified name, relative to this context's parent.
|
java.lang.Object |
resolveName(java.lang.String pName)
Resolves the specified name, relative to this context's parent.
|
java.lang.Object |
resolveName(java.lang.String pName,
boolean pCreate)
Resolves the specified name, relative to this context's parent.
|
void |
sendLogEvent(LogEvent pLogEvent)
Sends a LogEvent to all of the listeners
|
void |
setAdminServletOutputStreamEncoding(java.lang.String pAdminServletOutputStreamEncoding)
set AdminServletOutputStreamEncoding - This determines the character encoding
for the PrintWriter when the AdminServlet writes data to the response
|
void |
setAdminServletUseServletOutputStream(boolean pAdminServletUseServletOutputStream)
set AdminServletUseServletOutputStream - This flag determines whether the
AdminServlet should write data to the response using a ServletOutputStream or
a PrintWriter.
|
void |
setLoggingDebug(boolean pLogging)
Sets whether or not debug log events should be logged.
|
void |
setLoggingError(boolean pLogging)
Sets whether or not error log events should be logged.
|
void |
setLoggingInfo(boolean pLogging)
Sets whether or not info log events should be logged.
|
void |
setLoggingTrace(boolean pLogging)
Sets whether or not trace log events should be logged.
|
void |
setLoggingWarning(boolean pLogging)
Sets whether or not warning log events should be logged.
|
void |
setNucleus(Nucleus pNucleus)
Sets the Nucleus managing this Service
|
void |
setServiceInfo(java.lang.String pServiceInfo)
Sets the a descriptive string about this service
|
void |
startService(ServiceEvent pEvent)
Starts the service running.
|
void |
stopService()
Stops the service.
|
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning
public static java.lang.String CLASS_VERSION
public static final java.lang.String SERVICE_INFO_KEY
public GenericRMIService() throws java.rmi.RemoteException
java.rmi.RemoteException
public void setAdminServletOutputStreamEncoding(java.lang.String pAdminServletOutputStreamEncoding)
pAdminServletOutputStreamEncoding
- the AdminServletOutputStreamEncodingpublic java.lang.String getAdminServletOutputStreamEncoding()
public void setAdminServletUseServletOutputStream(boolean pAdminServletUseServletOutputStream)
pAdminServletUseServletOutputStream
- the AdminServletUseServletOutputStreampublic boolean isAdminServletUseServletOutputStream()
public java.rmi.server.RemoteRef getRef()
ref
property will not be serialized
to UI client.getRef
in class java.rmi.server.RemoteObject
public NameContext getRoot()
public void doStartService() throws ServiceException
ServiceException
- if the Service had a problem starting uppublic void doStopService() throws ServiceException
ServiceException
- if the Service had a problem shutting downpublic java.lang.String getServiceInfo()
public void setServiceInfo(java.lang.String pServiceInfo)
public void addLogListener(LogListener pListener)
addLogListener
in interface atg.nucleus.logging.ApplicationLoggingSender
public void removeLogListener(LogListener pListener)
removeLogListener
in interface atg.nucleus.logging.ApplicationLoggingSender
public LogListener[] getLogListeners()
getLogListeners
in interface atg.nucleus.logging.ApplicationLoggingSender
public int getLogListenerCount()
getLogListenerCount
in interface atg.nucleus.logging.ApplicationLoggingSender
public void sendLogEvent(LogEvent pLogEvent)
public java.lang.Object resolveName(ComponentName pName, boolean pCreate)
pName
- the name to be resolvedpCreate
- 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, boolean pCreate)
pName
- the name to be resolvedpCreate
- 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(ComponentName pName)
resolveName
in interface ComponentNameResolver
pName
- the name to be resolvedpublic java.lang.Object resolveName(java.lang.String pName)
resolveName
in interface NameResolver
pName
- the name to be resolvedpublic java.lang.String getAbsoluteName()
getAbsoluteName
in interface atg.naming.AbsoluteNameable
public void nameContextElementBound(NameContextBindingEvent pEvent)
nameContextElementBound
in interface NameContextBindingListener
public void nameContextElementUnbound(NameContextBindingEvent pEvent)
nameContextElementUnbound
in interface NameContextBindingListener
public NameContext getNameContext()
getNameContext
in interface NameContextElement
getNameContext
in interface atg.naming.NameContextParentable
public java.lang.String getName()
getName
in interface NameContextElement
public void startService(ServiceEvent pEvent) throws ServiceException
startService
in interface ServiceListener
pEvent
- the ServiceEvent encapsulating information about
the Service's environment and configurationServiceException
- if an error occurred while attempting
to start the service.public void stopService() throws ServiceException
stopService
in interface ServiceListener
ServiceException
- if an error occurred while attempting
to stop the service.public Nucleus getNucleus()
getNucleus
in interface Service
public void setNucleus(Nucleus pNucleus)
public Configuration getServiceConfiguration()
getServiceConfiguration
in interface atg.nucleus.Configured
getServiceConfiguration
in interface Service
public boolean isRunning()
public boolean isLoggingInfo()
isLoggingInfo
in interface atg.core.logging.Logging
isLoggingInfo
in interface ApplicationLogging
public void setLoggingInfo(boolean pLogging)
setLoggingInfo
in interface atg.core.logging.Logging
setLoggingInfo
in interface ApplicationLogging
public boolean isLoggingWarning()
isLoggingWarning
in interface atg.core.logging.Logging
isLoggingWarning
in interface ApplicationLogging
public void setLoggingWarning(boolean pLogging)
setLoggingWarning
in interface atg.core.logging.Logging
setLoggingWarning
in interface ApplicationLogging
public boolean isLoggingError()
isLoggingError
in interface atg.core.logging.Logging
isLoggingError
in interface ApplicationLogging
public void setLoggingError(boolean pLogging)
setLoggingError
in interface atg.core.logging.Logging
setLoggingError
in interface ApplicationLogging
public boolean isLoggingDebug()
isLoggingDebug
in interface atg.core.logging.Logging
isLoggingDebug
in interface ApplicationLogging
public void setLoggingDebug(boolean pLogging)
setLoggingDebug
in interface atg.core.logging.Logging
setLoggingDebug
in interface ApplicationLogging
public boolean isLoggingTrace()
isLoggingTrace
in interface atg.core.logging.TraceLogging
isLoggingTrace
in interface atg.nucleus.logging.TraceApplicationLogging
isLoggingTrace
in class atg.nucleus.logging.VariableArgumentApplicationLoggingRMIImpl
public void setLoggingTrace(boolean pLogging)
setLoggingTrace
in interface atg.core.logging.TraceLogging
setLoggingTrace
in interface atg.nucleus.logging.TraceApplicationLogging
public void logInfo(java.lang.String pMessage)
logInfo
in interface atg.core.logging.Logging
logInfo
in interface ApplicationLogging
public void logInfo(java.lang.Throwable pThrowable)
logInfo
in interface atg.core.logging.Logging
logInfo
in interface ApplicationLogging
public void logInfo(java.lang.String pMessage, java.lang.Throwable pThrowable)
logInfo
in interface atg.core.logging.Logging
logInfo
in interface ApplicationLogging
public void logWarning(java.lang.String pMessage)
logWarning
in interface atg.core.logging.Logging
logWarning
in interface ApplicationLogging
public void logWarning(java.lang.Throwable pThrowable)
logWarning
in interface atg.core.logging.Logging
logWarning
in interface ApplicationLogging
public void logWarning(java.lang.String pMessage, java.lang.Throwable pThrowable)
logWarning
in interface atg.core.logging.Logging
logWarning
in interface ApplicationLogging
public void logError(java.lang.String pMessage)
logError
in interface atg.core.logging.Logging
logError
in interface ApplicationLogging
public void logError(java.lang.Throwable pThrowable)
logError
in interface atg.core.logging.Logging
logError
in interface ApplicationLogging
public void logError(java.lang.String pMessage, java.lang.Throwable pThrowable)
logError
in interface atg.core.logging.Logging
logError
in interface ApplicationLogging
public void logDebug(java.lang.String pMessage)
logDebug
in interface atg.core.logging.Logging
logDebug
in interface ApplicationLogging
public void logDebug(java.lang.Throwable pThrowable)
logDebug
in interface atg.core.logging.Logging
logDebug
in interface ApplicationLogging
public void logDebug(java.lang.String pMessage, java.lang.Throwable pThrowable)
logDebug
in interface atg.core.logging.Logging
logDebug
in interface ApplicationLogging
public void logTrace(java.lang.String pMessage)
logTrace
in interface atg.core.logging.TraceLogging
logTrace
in interface atg.nucleus.logging.TraceApplicationLogging
public void logTrace(java.lang.Throwable pThrowable)
logTrace
in interface atg.core.logging.TraceLogging
logTrace
in interface atg.nucleus.logging.TraceApplicationLogging
public void logTrace(java.lang.String pMessage, java.lang.Throwable pThrowable)
logTrace
in interface atg.core.logging.TraceLogging
logTrace
in interface atg.nucleus.logging.TraceApplicationLogging
public javax.servlet.Servlet getAdminServlet()
getAdminServlet
in interface AdminableService
createAdminServlet()
protected javax.servlet.Servlet createAdminServlet()
protected java.lang.Object reResolveThis()
protected ApplicationLogging getLoggingForVlogging()
getLoggingForVlogging
in class atg.nucleus.logging.VariableArgumentApplicationLoggingRMIImpl