RequestStatus (pki-javadoc)

java.lang.Object
- com.netscape.certsrv.request.RequestStatus

All Implemented Interfaces:

java.io.Serializable
```
public final class RequestStatus
extends java.lang.Object
implements java.io.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:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static RequestStatus`	`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.
`static RequestStatus`	`BEGIN` The initial state of a request.
`static RequestStatus`	`CANCELED` Not implemented.
`static RequestStatus`	`COMPLETE` The normal final state of a request.
`static java.util.Collection<RequestStatus>`	`INSTANCES`
`static java.util.Map<java.lang.String,RequestStatus>`	`LABELS`
`static RequestStatus`	`PENDING` The state of a request that is waiting for action by an agent.
`static RequestStatus`	`REJECTED` The state of a request after it is rejected.
`static RequestStatus`	`SVC_PENDING` The state of a request that has been sent to the service, but has not been fully processed.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`static RequestStatus`	`fromString(java.lang.String label)` Converts a string name for a request status into the request status enum object.
`int`	`hashCode()`
`java.lang.String`	`toString()` Returns the string form of the RequestStatus, which may be used to record the status in a database.
`static RequestStatus`	`valueOf(java.lang.String label)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - INSTANCES
```
public static final java.util.Collection<RequestStatus> INSTANCES
```
  - LABELS
```
public static final java.util.Map<java.lang.String,RequestStatus> LABELS
```
  - BEGIN
```
public static RequestStatus 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
```
public static RequestStatus 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
```
public static RequestStatus 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
```
public static RequestStatus 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
```
public static RequestStatus 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
```
public static RequestStatus 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
```
public static RequestStatus 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.
- Method Detail
  - fromString
```
public static RequestStatus fromString(java.lang.String label)
```
    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
  - valueOf
```
public static RequestStatus valueOf(java.lang.String label)
```
  - toString
```
public java.lang.String toString()
```
    Returns the string form of the RequestStatus, which may be used to record the status in a database.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    request status
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class RequestStatus

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

INSTANCES

LABELS

BEGIN

PENDING

APPROVED

SVC_PENDING

CANCELED

REJECTED

COMPLETE

Method Detail

fromString

valueOf

toString

hashCode

equals