Package com.netscape.certsrv.request
Class RequestStatus
java.lang.Object
com.netscape.certsrv.request.RequestStatus
- All Implemented Interfaces:
Serializable
The RequestStatus class represents the current state of a request
in a request queue. The state of the request changes as actions
are performed on it.
The request is created in the BEGIN state, then general progresses
through the PENDING, APPROVED, SVC_PENDING, and COMPLETE states.
Some requests may bypass the PENDING state if no agent action is
required.
Requests may be CANCELED (not implemented) or REJECTED. These are
error conditions, and usually result because the request was invalid
or was not approved by an agent.
- Version:
- $Revision$ $Date$
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic RequestStatus
The state of a request that has been approved by an agent, or automatically by the policy engine, but have not been successfully transmitted to the service module.static RequestStatus
The initial state of a request.static RequestStatus
Not implemented.static RequestStatus
The normal final state of a request.static final Collection
<RequestStatus> static final Map
<String, RequestStatus> static RequestStatus
The state of a request that is waiting for action by an agent.static RequestStatus
The state of a request after it is rejected.static RequestStatus
The state of a request that has been sent to the service, but has not been fully processed. -
Method Summary
Modifier and TypeMethodDescriptionboolean
int
hashCode()
toString()
Returns the string form of the RequestStatus, which may be used to record the status in a database.static RequestStatus
Converts a string name for a request status into the request status enum object.
-
Field Details
-
INSTANCES
-
LABELS
-
BEGIN
The initial state of a request. Requests in this state have not been review by policy. While in this state the source of the request (usually the servlet, but it could be some other protocol module, such as email) should populate the request with data need to service it. -
PENDING
The state of a request that is waiting for action by an agent. When the agent approves or rejects the request, process will continue as appropriate. In this state there may be PolicyMessages present that indicate the reason for the pending status. -
APPROVED
The state of a request that has been approved by an agent, or automatically by the policy engine, but have not been successfully transmitted to the service module. These requests are resent to the service during the recovery process that runs at server startup. -
SVC_PENDING
The state of a request that has been sent to the service, but has not been fully processed. The service will invoke the serviceComplete() method to cause processing to continue. -
CANCELED
Not implemented. This is intended to be a final state that is reached when a request is removed from the processing queue without normal notification occurring. (see REJECTED) -
REJECTED
The state of a request after it is rejected. When a request is rejected, the notifier is called prior to making the finl status change. Rejected requests may have PolicyMessages indicating the reason for the rejection, or AgentMessages, which allow the agent to give reasons for the action. -
COMPLETE
The normal final state of a request. The completion status attribute gives other information about the request. The request is not necessarily successful, but may indicated that service processing did not succeed. -
label
-
-
Method Details
-
valueOf
Converts a string name for a request status into the request status enum object.- Parameters:
label
- The string representation of the state.- Returns:
- request status
-
toString
Returns the string form of the RequestStatus, which may be used to record the status in a database. -
hashCode
public int hashCode() -
equals
-