Enhydra 5.1 API

org.enhydra.servlet.servletManager
Class ServletStatus

java.lang.Object
  |
  +--org.enhydra.servlet.servletManager.ServletStatus

public class ServletStatus
extends java.lang.Object

This class describes the current status of a Servlet being stored in the ServletManager. Instances of this class are returned by a ServletManager.

Author:
Andy John
See Also:
ServletManager,

Field Summary
 java.lang.String className
          The class name of the Servlet.
 java.lang.String[] classPath
          The additional classpath used for this Servlet.
 java.util.Date createTime
          The time when the Servlet was instantiated, and init() was called.
 double currentReqPerMinute
          The number of requests per minute made to this Servlet for the most recent completed minute.
 java.lang.String defaultSessionTimeOut
          The default session timeout used by a war
 java.lang.String description
          A human readable string describing the Servlet.
 java.lang.String docRoot
          The Servlet's root on the filesystem?
 java.util.Properties initArgs
          The initialization string that either will be or was used to initialize the Servlet.
 java.lang.String isInvokerEnabled
          The isWARValidated used by a war
 boolean isWar
          If this servlet is a war
 java.lang.String isWARExpanded
          The isWARExpanded used by a war
 java.lang.String isWARValidated
          The default session timeout used by a war
 java.lang.String isWorkDirPersistent
          The isInvokerEnabled used by a war
static org.apache.log4j.Logger logger
          The log channel the Servlet writes to.
 double maxReqPerMinute
          The highwater mark for currentReqPerMinute.
 java.util.Date maxReqPerMinuteTime
          The time at which the maxReqPerMinute occured.
 java.util.Vector paths
          The URL prefix used by the context
 int refCount
          The number of times that this Servlet was asked for by get().
 boolean running
          True if the Servlet currently exists.
 boolean runOnInit
          True if the configuration information for the conterxt says to start at init time
 
Constructor Summary
protected ServletStatus()
          Protected contructor.
 
Method Summary
 boolean IsInvokerEnabled()
           
 boolean IsWARExpanded()
           
 boolean IsWARValidated()
           
 boolean IsWorkDirPersistent()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

initArgs

public java.util.Properties initArgs
The initialization string that either will be or was used to initialize the Servlet. If running is true, the Servlet has been created and initialized.

See Also:
ServletManager, Properties

description

public java.lang.String description
A human readable string describing the Servlet.

See Also:
ServletManager

className

public java.lang.String className
The class name of the Servlet. For Enhydra applications this will be org.enhydra.Servlet.


docRoot

public java.lang.String docRoot
The Servlet's root on the filesystem?

See Also:
ServletManager

classPath

public java.lang.String[] classPath
The additional classpath used for this Servlet.


running

public boolean running
True if the Servlet currently exists. False if it does not exist. After calling get() or start(), the Servlet will exist, so this will be true. After calling stop() the Servlet will no longer exist, so this will be false.

See Also:
ServletManager

runOnInit

public boolean runOnInit
True if the configuration information for the conterxt says to start at init time

See Also:
ServletManager

logger

public static org.apache.log4j.Logger logger
The log channel the Servlet writes to. If the Servlet call the log() method of it's ServletContext, the string ends up being written to this channel.


refCount

public int refCount
The number of times that this Servlet was asked for by get().

See Also:
ServletManager

createTime

public java.util.Date createTime
The time when the Servlet was instantiated, and init() was called. This will have happend as a result of either a get() or a start() code. If running is null, then the Servlet is not currently instantiated, in which case this will be null also.


currentReqPerMinute

public double currentReqPerMinute
The number of requests per minute made to this Servlet for the most recent completed minute. This statistic can be up to 59 seconds out of date. This is reset when the Servlet is started.


maxReqPerMinute

public double maxReqPerMinute
The highwater mark for currentReqPerMinute. This is the largest value of currentReqPerMinute seen since the Servlet was started. This is reset when the Servlet is started.


maxReqPerMinuteTime

public java.util.Date maxReqPerMinuteTime
The time at which the maxReqPerMinute occured. This is reset when the Servlet is started.


isWar

public boolean isWar
If this servlet is a war


paths

public java.util.Vector paths
The URL prefix used by the context


defaultSessionTimeOut

public java.lang.String defaultSessionTimeOut
The default session timeout used by a war


isWARExpanded

public java.lang.String isWARExpanded
The isWARExpanded used by a war


isWARValidated

public java.lang.String isWARValidated
The default session timeout used by a war


isInvokerEnabled

public java.lang.String isInvokerEnabled
The isWARValidated used by a war


isWorkDirPersistent

public java.lang.String isWorkDirPersistent
The isInvokerEnabled used by a war

Constructor Detail

ServletStatus

protected ServletStatus()
Protected contructor. Only a ServletManager should create instances of this class.

See Also:
ServletManager
Method Detail

IsWARExpanded

public boolean IsWARExpanded()

IsWARValidated

public boolean IsWARValidated()

IsInvokerEnabled

public boolean IsInvokerEnabled()

IsWorkDirPersistent

public boolean IsWorkDirPersistent()

Enhydra 5.1 API