dods.servlet
Class ReqState

java.lang.Object
  extended bydods.servlet.ReqState

public class ReqState
extends java.lang.Object

User request information gets cached here for easy access by downstream code. This object may not be immutable/thread safe.

Author:
Nathan Potter

Constructor Summary
ReqState(javax.servlet.http.HttpServletRequest myRequest, javax.servlet.ServletConfig sc, java.lang.String serverClassName)
           
ReqState(java.lang.String dataSetName, java.lang.String requestSuffix, java.lang.String CE, boolean acceptsCompressed, javax.servlet.ServletConfig sc, java.lang.String serverClassName)
          Deprecated.  
 
Method Summary
 boolean getAcceptsCompressed()
          ************************************************************************* Evaluates the (private) request object to determine if the client that sent the request accepts compressed return documents.
 java.lang.String getConstraintExpression()
           
 java.lang.String getDASCache()
          This method will attempt to get the DAS cache directory name from the servlet's InitParameters.
 java.lang.String getDataSet()
          ***********************************************************************
 java.lang.String getDDSCache()
          This method will attempt to get the DDS cache directory name from the servlet's InitParameters.
 java.lang.String getINFOCache()
          This method will attempt to get the INFO cache directory name from the servlet's InitParameters.
 java.lang.String getInitParameter(java.lang.String name)
           
 java.util.Enumeration getInitParameterNames()
           
 java.lang.String getRequestSuffix()
           
 java.lang.String getServerClassName()
           
 java.lang.String getServerName()
           
 java.lang.Object getUserObject()
           
protected  void setDefaultDASCache(java.lang.String cachedir)
          Sets the default DAS Cache directory name to the string cachedir.
protected  void setDefaultDDSCache(java.lang.String cachedir)
          Sets the default DDS Cache directory name to the string cachedir.
protected  void setDefaultINFOCache(java.lang.String cachedir)
          Sets the default INFO Cache directory name to the string cachedir.
 void setUserObject(java.lang.Object userObj)
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ReqState

public ReqState(java.lang.String dataSetName,
                java.lang.String requestSuffix,
                java.lang.String CE,
                boolean acceptsCompressed,
                javax.servlet.ServletConfig sc,
                java.lang.String serverClassName)
Deprecated.  

Functionality has beed moved from the servlet into ReqState. This machinery negates the need for this constructor with it's complex method signature.

Parameters:
dataSetName -
requestSuffix -
CE -
acceptsCompressed -
sc -
serverClassName -

ReqState

public ReqState(javax.servlet.http.HttpServletRequest myRequest,
                javax.servlet.ServletConfig sc,
                java.lang.String serverClassName)
         throws BadURLException
Parameters:
myRequest - The HttpServletRequest object asscoicated with this client request.
sc -
serverClassName -
Throws:
BadURLException
Method Detail

getAcceptsCompressed

public boolean getAcceptsCompressed()
************************************************************************* Evaluates the (private) request object to determine if the client that sent the request accepts compressed return documents.

Returns:
True is the client accpets a compressed return document. False otherwise.

getDataSet

public java.lang.String getDataSet()
***********************************************************************


getServerName

public java.lang.String getServerName()

getServerClassName

public java.lang.String getServerClassName()

getRequestSuffix

public java.lang.String getRequestSuffix()

getConstraintExpression

public java.lang.String getConstraintExpression()

getDDSCache

public java.lang.String getDDSCache()
This method will attempt to get the DDS cache directory name from the servlet's InitParameters. Failing this it will return the default DDS cache directory name.

Returns:
The name of the DDS cache directory.

setDefaultDDSCache

protected void setDefaultDDSCache(java.lang.String cachedir)
Sets the default DDS Cache directory name to the string cachedir. Note that if the servlet configuration conatins an Init Parameter DDSCache the default value will be ingnored.

Parameters:
cachedir -

getDASCache

public java.lang.String getDASCache()
This method will attempt to get the DAS cache directory name from the servlet's InitParameters. Failing this it will return the default DAS cache directory name.

Returns:
The name of the DAS cache directory.

setDefaultDASCache

protected void setDefaultDASCache(java.lang.String cachedir)
Sets the default DAS Cache directory name to the string cachedir. Note that if the servlet configuration conatins an Init Parameter DASCache the default value will be ingnored.

Parameters:
cachedir -

getINFOCache

public java.lang.String getINFOCache()
This method will attempt to get the INFO cache directory name from the servlet's InitParameters. Failing this it will return the default INFO cache directory name.

Returns:
The name of the INFO cache directory.

setDefaultINFOCache

protected void setDefaultINFOCache(java.lang.String cachedir)
Sets the default INFO Cache directory name to the string cachedir. Note that if the servlet configuration conatins an Init Parameter INFOcache the default value will be ingnored.

Parameters:
cachedir -

getInitParameterNames

public java.util.Enumeration getInitParameterNames()

getInitParameter

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

getUserObject

public java.lang.Object getUserObject()

setUserObject

public void setUserObject(java.lang.Object userObj)

toString

public java.lang.String toString()