com.netscape.certsrv.key

Interface KeyResource

@Path(value="agent/keys")
public interface KeyResource

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	KEY_STATUS_ACTIVE
static java.lang.String	KEY_STATUS_INACTIVE

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	getActiveKeyInfo(java.lang.String clientKeyID)
javax.ws.rs.core.Response	getKeyInfo(KeyId id)
javax.ws.rs.core.Response	listKeys(java.lang.String clientKeyID, java.lang.String status, java.lang.Integer maxResults, java.lang.Integer maxTime, java.lang.Integer start, java.lang.Integer size, java.lang.String realm)
javax.ws.rs.core.Response	modifyKeyStatus(KeyId id, java.lang.String status)
javax.ws.rs.core.Response	retrieveKey(KeyRecoveryRequest data) Used to retrieve a key
javax.ws.rs.core.Response	retrieveKey(javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String> form)

Field Detail

KEY_STATUS_ACTIVE

static final java.lang.String KEY_STATUS_ACTIVE

See Also:

Constant Field Values

KEY_STATUS_INACTIVE

static final java.lang.String KEY_STATUS_INACTIVE

See Also:

Constant Field Values

Method Detail

listKeys

@GET
javax.ws.rs.core.Response listKeys(@QueryParam(value="clientKeyID")
                                        java.lang.String clientKeyID,
                                        @QueryParam(value="status")
                                        java.lang.String status,
                                        @QueryParam(value="maxResults")
                                        java.lang.Integer maxResults,
                                        @QueryParam(value="maxTime")
                                        java.lang.Integer maxTime,
                                        @QueryParam(value="start")
                                        java.lang.Integer start,
                                        @QueryParam(value="size")
                                        java.lang.Integer size,
                                        @QueryParam(value="realm")
                                        java.lang.String realm)

getActiveKeyInfo

@GET
 @Path(value="active/{clientKeyID}")
javax.ws.rs.core.Response getActiveKeyInfo(@PathParam(value="clientKeyID")
                                                                                     java.lang.String clientKeyID)

getKeyInfo

@GET
 @Path(value="{id}")
javax.ws.rs.core.Response getKeyInfo(@PathParam(value="id")
                                                               KeyId id)

modifyKeyStatus

@POST
 @Path(value="{id}")
javax.ws.rs.core.Response modifyKeyStatus(@PathParam(value="id")
                                                                     KeyId id,
                                                                     @QueryParam(value="status")
                                                                     java.lang.String status)

retrieveKey

@POST
 @Path(value="retrieve")
javax.ws.rs.core.Response retrieveKey(KeyRecoveryRequest data)

Used to retrieve a key

Parameters:

data -

Returns:

retrieveKey

@POST
 @Path(value="retrieve")
 @Consumes(value="application/x-www-form-urlencoded")
javax.ws.rs.core.Response retrieveKey(javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String> form)