iaik.xkms
Interface RevokeRequest

All Superinterfaces:
XKRSSRequest, XMessageAbstractType, XRequestAbstractType

public interface RevokeRequest
extends XKRSSRequest

Request revocation of a previously registered key binding.

[258] A Registration service MAY permit clients to revoke previously issued key bindings. A revocation request need only contain sufficient information to identify the key binding to be revoked and the authority for the revocation request.

[259] If an XKMS key binding is bound to a data object in an underlying PKI the revocation of the key binding SHOULD result in the revocation of the underlying data object. For example if the XKMS key binding is bound to an X.509 certificate the revocation of the key binding SHOULD result in revocation of the underlying certificate.

[319] The revoke request message contains a <RevokeRequest> element that contains the following elements:
<RevokeKeyBinding> [Required]
Identifies the key binding to be revoked.
<Authentication> [Choice]
Information that authenticates the request.
<RevocationCode> [Choice]
The revocation code value that generates the revocation code identifier value specified during registration.


Method Summary
 byte[] getRevocationCode()
          Gets the revocation code.
 RevokeKeyBinding getRevokeKeyBinding()
          Gets the RevokeKeyBinding of this request.
 void setRevocationCode(Key key)
          Sets the recovation code for this request.
 void setRevokeKeyBinding(RevokeKeyBinding rkb)
          Sets the RevokeKeyBinding of this request
 
Methods inherited from interface XKRSSRequest
getAuthentication, hasKeyBindingAuthenticationSignature, setAuthentication
 
Methods inherited from interface XRequestAbstractType
acceptPending, acceptRepresent, acceptRequestSignatureValue, addRespondWith, addResponseMechanism, getOriginalRequestId, getPendingNotification, getRespondWith, getResponseLimit, getResponseMechanism, removeRespondWith, removeResponseMechanism, setOriginalRequestId, setPendingNotification, setResponseLimit
 
Methods inherited from interface XMessageAbstractType
addDefaults, addOpaqueClientData, clearOpaqueClientData, getId, getMessageName, getNonce, getOpaqueClientData, getRequestSignatureValue, getService, getSignatureCertificate, hasSignature, isValid, setId, setNonce, setService, setSignature, toString
 

Method Detail

getRevokeKeyBinding

RevokeKeyBinding getRevokeKeyBinding()
Gets the RevokeKeyBinding of this request.

Returns:
the RevokeKeyBinding of this request

setRevokeKeyBinding

void setRevokeKeyBinding(RevokeKeyBinding rkb)
Sets the RevokeKeyBinding of this request

Parameters:
rkb - the new RevokeKeyBinding for this request

setRevocationCode

void setRevocationCode(Key key)
                       throws XKMSException
Sets the recovation code for this request.

Parameters:
key - the key to set.
Throws:
XKMSException - if an Authentication is already set

getRevocationCode

byte[] getRevocationCode()
Gets the revocation code.

Returns:
the recovation code