Class KeyRequestClient

java.lang.Object

com.netscape.certsrv.client.Client

com.netscape.certsrv.key.KeyRequestClient

public class KeyRequestClient
extends Client

Author:

Endi S. Dewata, Abhishek Koneru

Field Summary

Fields

Modifier and Type	Field	Description
static org.slf4j.Logger	logger

Fields inherited from class Client

client, name, prefix, subsystem

Constructor Summary

Constructors

Constructor	Description
KeyRequestClient(PKIClient client)

Method Summary

Modifier and Type	Method	Description
void	approveRequest(RequestId id)	Approve a secret recovery request
void	cancelRequest(RequestId id)	Cancel a secret recovery request
KeyRequestInfo	getRequestInfo(RequestId id)	Return a KeyRequestInfo object for a specific request.
KeyRequestInfoCollection	listRequests(String requestState, String requestType)
KeyRequestInfoCollection	listRequests(String requestState, String requestType, String realm)	Search key requests in the DRM based on the state/type of the requests.
KeyRequestInfoCollection	listRequests(String requestState, String requestType, String clientKeyID, RequestId start, Integer pageSize, Integer maxResults, Integer maxTime, String realm)	List/Search key requests in the DRM
void	rejectRequest(RequestId id)	Reject a secret recovery request

Methods inherited from class Client

delete, delete, get, get, get, getCollection, getName, getSubsystem, getTargetPath, patch, post, post, post, post, put, target

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

logger

public static org.slf4j.Logger logger

Constructor Details

KeyRequestClient

public KeyRequestClient(PKIClient client)
                 throws Exception

Throws:

Exception

Method Details

listRequests

public KeyRequestInfoCollection listRequests(String requestState,
 String requestType,
 String realm)
                                      throws Exception

Search key requests in the DRM based on the state/type of the requests.

Parameters:

requestState - -- State of the requests to be queried.

requestType - -- Type of the requests to be queried.

realm - -- Authz Realm

Returns:

a KeyRequestCollection object.

Throws:

Exception

listRequests

public KeyRequestInfoCollection listRequests(String requestState,
 String requestType)
                                      throws Exception

Throws:

Exception

listRequests

public KeyRequestInfoCollection listRequests(String requestState,
 String requestType,
 String clientKeyID,
 RequestId start,
 Integer pageSize,
 Integer maxResults,
 Integer maxTime,
 String realm)
                                      throws Exception

List/Search key requests in the DRM

Parameters:

requestState - -- State of the requests to be queried.

requestType - -- Type of the requests to be queried.

clientKeyID - -- Client Key Identifier

start - -- Start index of list

pageSize - -- Size of the list to be returned.

maxResults - -- Maximum number of requests to be fetched

maxTime - -- Maximum time for the operation to take

realm - -- Authz Realm

Returns:

a KeyRequestInfoCollection object.

Throws:

Exception

getRequestInfo

public KeyRequestInfo getRequestInfo(RequestId id)
                              throws Exception

Return a KeyRequestInfo object for a specific request.

Parameters:

id - -- A Request Id object

Returns:

the KeyRequestInfo object for a specific request.

Throws:

Exception

approveRequest

public void approveRequest(RequestId id)
                    throws Exception

Approve a secret recovery request

Parameters:

id - -- Id of the request

Throws:

Exception

rejectRequest

public void rejectRequest(RequestId id)
                   throws Exception

Reject a secret recovery request

Parameters:

id - -- Id of the request

Throws:

Exception

cancelRequest

public void cancelRequest(RequestId id)
                   throws Exception

Cancel a secret recovery request

Parameters:

id - -- Id of the request

Throws:

Exception