com.netscape.certsrv.key

Interface KeyRequestResource

@Path(value="agent/keyrequests")
public interface KeyRequestResource

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ASYMMETRIC_KEY_TYPE
static java.lang.String	PASS_PHRASE_TYPE
static java.lang.String	SYMMETRIC_KEY_TYPE

Method Summary

Methods

Modifier and Type	Method and Description
void	approveRequest(RequestId id)
javax.ws.rs.core.Response	archiveKey(KeyArchivalRequest data)
javax.ws.rs.core.Response	archiveKey(javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String> form)
void	cancelRequest(RequestId id)
KeyRequestInfo	getRequestInfo(RequestId id) Used to retrieve key request info for a specific request
KeyRequestInfos	listRequests(java.lang.String requestState, java.lang.String requestType, java.lang.String clientID, RequestId start, java.lang.Integer pageSize, java.lang.Integer maxResults, java.lang.Integer maxTime) Used to generate list of key requests based on the search parameters
javax.ws.rs.core.Response	recoverKey(KeyRecoveryRequest data)
javax.ws.rs.core.Response	recoverKey(javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String> form)
void	rejectRequest(RequestId id)

Field Detail

SYMMETRIC_KEY_TYPE

static final java.lang.String SYMMETRIC_KEY_TYPE

See Also:

Constant Field Values

PASS_PHRASE_TYPE

static final java.lang.String PASS_PHRASE_TYPE

See Also:

Constant Field Values

ASYMMETRIC_KEY_TYPE

static final java.lang.String ASYMMETRIC_KEY_TYPE

See Also:

Constant Field Values

Method Detail

listRequests

@GET
@Produces(value={"application/xml","application/json"})
KeyRequestInfos listRequests(@QueryParam(value="requestState")
                                        java.lang.String requestState,
                                        @QueryParam(value="requestType")
                                        java.lang.String requestType,
                                        @QueryParam(value="clientID")
                                        java.lang.String clientID,
                                        @QueryParam(value="start")
                                        RequestId start,
                                        @QueryParam(value="pageSize")
                                        java.lang.Integer pageSize,
                                        @QueryParam(value="maxResults")
                                        java.lang.Integer maxResults,
                                        @QueryParam(value="maxTime")
                                        java.lang.Integer maxTime)

Used to generate list of key requests based on the search parameters

getRequestInfo

@GET
@Path(value="{id}")
@Produces(value={"application/xml","application/json"})
KeyRequestInfo getRequestInfo(@PathParam(value="id")
                                              RequestId id)

Used to retrieve key request info for a specific request

archiveKey

@POST
@Path(value="archive")
@Produces(value={"application/xml","application/json"})
@Consumes(value="application/x-www-form-urlencoded")
javax.ws.rs.core.Response archiveKey(javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String> form)

archiveKey

@POST
@Path(value="archive")
@Produces(value={"application/xml","application/json"})
@Consumes(value={"application/xml","application/json"})
javax.ws.rs.core.Response archiveKey(KeyArchivalRequest data)

recoverKey

@POST
@Path(value="recover")
@Produces(value={"application/xml","application/json"})
@Consumes(value="application/x-www-form-urlencoded")
javax.ws.rs.core.Response recoverKey(javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String> form)

recoverKey

@POST
@Path(value="recover")
@Produces(value={"application/xml","application/json"})
@Consumes(value={"application/xml","application/json"})
javax.ws.rs.core.Response recoverKey(KeyRecoveryRequest data)

approveRequest

@POST
@Path(value="{id}/approve")
void approveRequest(@PathParam(value="id")
                            RequestId id)

rejectRequest

@POST
@Path(value="{id}/reject")
void rejectRequest(@PathParam(value="id")
                           RequestId id)

cancelRequest

@POST
@Path(value="{id}/cancel")
void cancelRequest(@PathParam(value="id")
                           RequestId id)