Class CMSRequest

java.lang.Object
com.netscape.cms.servlet.common.CMSRequest
public class CMSRequest extends Object
This represents a user request.
Version:
$Revision$, $Date$

  • Field Details

    • UNAUTHORIZED

      public static final Integer UNAUTHORIZED

    • SUCCESS

      public static final Integer SUCCESS

    • PENDING

      public static final Integer PENDING

    • SVC_PENDING

      public static final Integer SVC_PENDING

    • REJECTED

      public static final Integer REJECTED

    • ERROR

      public static final Integer ERROR

    • EXCEPTION

      public static final Integer EXCEPTION

  • Constructor Details

    • CMSRequest

      public CMSRequest()
      Constructor

  • Method Details

    • setHttpParams

      public void setHttpParams(ArgBlock httpParams)
      set the HTTP parameters

    • setRequest

      public void setRequest(Request request)
      set the Request aobject associated with this session

    • setHttpReq

      public void setHttpReq(jakarta.servlet.http.HttpServletRequest httpReq)
      set the HTTP Request object associated with this session

    • setHttpResp

      public void setHttpResp(jakarta.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(jakarta.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(jakarta.servlet.ServletContext servletContext)

    • setStatus

      public void setStatus(Integer status)
      Set request status.
      Parameters:
      status - request status. Allowed values are UNAUTHORIZED, SUCCESS, REJECTED, PENDING, ERROR, SVC_PENDING
      Throws:
      IllegalArgumentException - if status is not one of the above values

    • setError

      public void setError(EBaseException error)

    • setError

      public void setError(String error)

    • setErrorDescription

      public void setErrorDescription(String descr)

    • setResult

      public void setResult(Object result)

    • setResult

      public void setResult(String name, Object result)

    • getHttpParams

      public ArgBlock getHttpParams()

    • getHttpReq

      public jakarta.servlet.http.HttpServletRequest getHttpReq()

    • getHttpResp

      public jakarta.servlet.http.HttpServletResponse getHttpResp()

    • getServletConfig

      public jakarta.servlet.ServletConfig getServletConfig()

    • getServletContext

      public jakarta.servlet.ServletContext getServletContext()

    • getRequest

      public Request getRequest()

    • getStatus

      public Integer getStatus()

    • getError

      public String getError()

    • getErrorDescr

      public Vector<String> getErrorDescr()

    • getResult

      public Object getResult()

    • getResult

      public Object getResult(String name)

    • setReason

      public void setReason(String reason)

    • getReason

      public String getReason()

    • setExtData

      public void setExtData(String type, String value)

    • getExtData

      public String getExtData(String type)

    • getPolicyMessages

      public Vector<String> getPolicyMessages()

    • setIRequestStatus

      public void setIRequestStatus() throws EBaseException
      set default CMS status according to Request status.
      Throws:
      EBaseException