Package com.netscape.cms.servlet.common
Class CMSRequest
- java.lang.Object
-
- com.netscape.cms.servlet.common.CMSRequest
-
- All Implemented Interfaces:
ICMSRequest
public class CMSRequest extends java.lang.Object implements ICMSRequest
This represents a user request.- Version:
- $Revision$, $Date$
-
-
Field Summary
-
Fields inherited from interface com.netscape.certsrv.common.ICMSRequest
ERROR, EXCEPTION, PENDING, REJECTED, SUCCESS, SVC_PENDING, UNAUTHORIZED
-
-
Constructor Summary
Constructors Constructor Description CMSRequest()
Constructor
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getError()
java.util.Vector<java.lang.String>
getErrorDescr()
java.lang.String
getExtData(java.lang.String type)
IArgBlock
getHttpParams()
javax.servlet.http.HttpServletRequest
getHttpReq()
javax.servlet.http.HttpServletResponse
getHttpResp()
IRequest
getIRequest()
java.util.Vector<java.lang.String>
getPolicyMessages()
java.lang.String
getReason()
java.lang.Object
getResult()
java.lang.Object
getResult(java.lang.String name)
javax.servlet.ServletConfig
getServletConfig()
javax.servlet.ServletContext
getServletContext()
java.lang.Integer
getStatus()
void
setError(EBaseException error)
void
setError(java.lang.String error)
void
setErrorDescription(java.lang.String descr)
void
setExtData(java.lang.String type, java.lang.String value)
void
setHttpParams(IArgBlock httpParams)
set the HTTP parametersvoid
setHttpReq(javax.servlet.http.HttpServletRequest httpReq)
set the HTTP Request object associated with this sessionvoid
setHttpResp(javax.servlet.http.HttpServletResponse httpResp)
set the HTTP Response object which is used to create the HTTP response which is sent back to the uservoid
setIRequest(IRequest request)
set the Request aobject associated with this sessionvoid
setIRequestStatus()
set default CMS status according to IRequest status.void
setReason(java.lang.String reason)
void
setResult(java.lang.Object result)
void
setResult(java.lang.String name, java.lang.Object result)
void
setServletConfig(javax.servlet.ServletConfig servletConfig)
set the servlet configuration.void
setServletContext(javax.servlet.ServletContext servletContext)
void
setStatus(java.lang.Integer status)
Set request status.
-
-
-
Method Detail
-
setHttpParams
public void setHttpParams(IArgBlock httpParams)
set the HTTP parameters
-
setIRequest
public void setIRequest(IRequest request)
set the Request aobject associated with this session
-
setHttpReq
public void setHttpReq(javax.servlet.http.HttpServletRequest httpReq)
set the HTTP Request object associated with this session
-
setHttpResp
public void setHttpResp(javax.servlet.http.HttpServletResponse httpResp)
set the HTTP Response object which is used to create the HTTP response which is sent back to the user
-
setServletConfig
public void setServletConfig(javax.servlet.ServletConfig servletConfig)
set the servlet configuration. The servlet configuration is read from the WEB-APPS/web.xml file under the <servlet> XML definition. The parameters are delimited by init-param param-name/param-value options as described in the servlet documentation.
-
setServletContext
public void setServletContext(javax.servlet.ServletContext servletContext)
-
setStatus
public void setStatus(java.lang.Integer status)
Set request status.- Parameters:
status
- request status. Allowed values are UNAUTHORIZED, SUCCESS, REJECTED, PENDING, ERROR, SVC_PENDING- Throws:
java.lang.IllegalArgumentException
- if status is not one of the above values
-
setError
public void setError(EBaseException error)
-
setError
public void setError(java.lang.String error)
-
setErrorDescription
public void setErrorDescription(java.lang.String descr)
-
setResult
public void setResult(java.lang.Object result)
-
setResult
public void setResult(java.lang.String name, java.lang.Object result)
-
getHttpParams
public IArgBlock getHttpParams()
-
getHttpReq
public javax.servlet.http.HttpServletRequest getHttpReq()
-
getHttpResp
public javax.servlet.http.HttpServletResponse getHttpResp()
-
getServletConfig
public javax.servlet.ServletConfig getServletConfig()
-
getServletContext
public javax.servlet.ServletContext getServletContext()
-
getIRequest
public IRequest getIRequest()
-
getStatus
public java.lang.Integer getStatus()
-
getError
public java.lang.String getError()
-
getErrorDescr
public java.util.Vector<java.lang.String> getErrorDescr()
-
getResult
public java.lang.Object getResult()
-
getResult
public java.lang.Object getResult(java.lang.String name)
-
setReason
public void setReason(java.lang.String reason)
-
getReason
public java.lang.String getReason()
-
setExtData
public void setExtData(java.lang.String type, java.lang.String value)
-
getExtData
public java.lang.String getExtData(java.lang.String type)
-
getPolicyMessages
public java.util.Vector<java.lang.String> getPolicyMessages()
-
setIRequestStatus
public void setIRequestStatus() throws EBaseException
set default CMS status according to IRequest status.- Throws:
EBaseException
-
-