oracle.okv.operation

Class OKVBatchOperation

java.lang.Object

oracle.okv.operation.OKVOperationImpl<oracle.okv.response.impl.OKVBatchResponseImpl>

oracle.okv.operation.OKVBatchOperation

All Implemented Interfaces:

oracle.okv.operation.OKVOperation<oracle.okv.response.impl.OKVBatchResponseImpl>

public class OKVBatchOperation
extends oracle.okv.operation.OKVOperationImpl<oracle.okv.response.impl.OKVBatchResponseImpl>

This class composes the KMIP Batch operation request and decomposes the response into the response object. This class is a composite (see Composite Design Pattern) and contains a map of child operations. The compose and decompose operations are essentially implemented by calling the same method on each of the child operations.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_NAME
static java.util.logging.Logger	logger

Constructor Summary

Constructors

Constructor and Description
OKVBatchOperation()

Method Summary

Modifier and Type	Method and Description
void	clearBatchItems() Removes all items from the batch.
java.util.List<OKVTTLV>	composeRequest() Composes a KMIP operation request into a hierarchy of TTLV objects
java.util.List<OKVTTLV>	composeRequest(oracle.okv.service.OKVEnv env) Composes a KMIP operation request into a hierarchy of TTLV objects
java.util.Map<java.lang.Integer,oracle.okv.operation.OKVChildOperation>	getChildOperationMap() Returns the batch item map, where the key is the batch item id and the value is the batched operation.
java.lang.Integer	okvActivate(java.lang.String uid) Implements the KMIP Activate operation.
java.lang.Integer	okvAddAttribute(java.lang.String uid, OKVTTLV attr) Implements the KMIP add attribute operation.
java.lang.Integer	okvCreateKey(OKVTagEnum algorithm, int keyLength, int usageMask, OKVTTLV attributeList, java.lang.String walletName) Implements the KMIP Create operation for the KMIP symmetric key object.
java.lang.Integer	okvCreateKeyPair(OKVTagEnum algorithm, int keyLength, int privateKeyUsageMask, int publicKeyUsageMask, OKVTTLV commonAttributeList, OKVTTLV privateKeyAttributeList, OKVTTLV publicKeyAttributeList, java.lang.String walletName) Implements the KMIP create key pair operation.
java.lang.Integer	okvDecrypt(java.lang.String uid, byte[] data, OKVCryptoContext cryptoContext) API to perform the decryption operation on the provided data using KMIP object.
java.lang.Integer	okvDeleteAttribute(java.lang.String uid, java.lang.String attrName, int attrIndex) Implements the KMIP delete attribute operation.
java.lang.Integer	okvDestroy(java.lang.String uid) Implements the KMIP Destroy operation.
java.lang.Integer	okvEncrypt(java.lang.String uid, byte[] data, OKVCryptoContext cryptoContext) API to perform the encryption operation on the provided data using KMIP object.
java.lang.Integer	okvGetAttributeList(java.lang.String uid) Implements KMIP Get Attribute List operation.
java.lang.Integer	okvGetAttributes(java.lang.String uid, java.util.List<java.lang.String> attrList) Implements KMIP Get Attribute operation.
java.lang.Integer	okvGetCertificate(java.lang.String uid) Implements the KMIP Get operation for the KMIP certificate object.
java.lang.Integer	okvGetCertificateRequest(java.lang.String uid) Implements the KMIP Get operation for the certificate request object.
java.lang.Integer	okvGetKey(java.lang.String uid) Implements the KMIP Get operation for the KMIP symmetric key object.
java.lang.Integer	okvGetOpaqueData(java.lang.String uid) Implements the KMIP Get operation for the KMIP opaque data object.
java.lang.Integer	okvGetPrivateKey(java.lang.String uid) Implements the KMIP Get operation for the KMIP private key object.
java.lang.Integer	okvGetPublicKey(java.lang.String uid) Implements the KMIP Get operation for the KMIP public key object.
java.lang.Integer	okvGetSecretData(java.lang.String uid) Implements the KMIP Get operation for the KMIP secret data object.
java.lang.Integer	okvGetTemplate(java.lang.String uid) Implements the KMIP Get operation for the KMIP template object.
java.lang.Integer	okvLocate(java.lang.Integer maxItems, java.lang.Integer storageStatusMask, OKVTagEnum objectGroupMember, OKVTTLV attributeList) Implements the KMIP locate operation.
java.lang.Integer	okvModifyAttribute(java.lang.String uid, OKVTTLV attr) Implements the KMIP modify attribute operation.
java.lang.Integer	okvQueryCapability(java.util.List<OKVTagEnum> queryFuncs) Implements the KMIP Query operation.
java.lang.Integer	okvRegCertificate(OKVTagEnum certificateType, OKVTag certificateSubType, byte[] certificateValue, int usageMask, OKVTTLV attributeList, java.lang.String privateKeyUID, java.lang.String walletName) Implements the KMIP Register operation for the KMIP certificate object.
java.lang.Integer	okvRegCertificateRequest(OKVTagEnum certificateRequestType, byte[] certificateRequestValue, OKVTTLV attributeList, java.lang.String privateKeyUID, java.lang.String walletName) Implements the KMIP Register operation for the certificate request object.
java.lang.Integer	okvRegKey(byte[] keyValue, OKVTagEnum algorithm, int keyLength, int usageMask, OKVTTLV attributeList, java.lang.String walletName) Implements the KMIP Register operation for the KMIP symmetric key object.
java.lang.Integer	okvRegOpaqueData(OKVTagEnum opaqueType, byte[] opaqueValue, OKVTTLV attributeList, java.lang.String walletName) Implements the KMIP Register operation for the KMIP opaque data object.
java.lang.Integer	okvRegPrivateKey(byte[] privateKeyValue, OKVTagEnum algorithm, int privateKeyLength, int usageMask, OKVTTLV attributeList, java.lang.String walletName) Implements the KMIP Register operation for the KMIP private key object.
java.lang.Integer	okvRegPublicKey(byte[] publicKeyValue, OKVTagEnum algorithm, int publicKeyLength, int usageMask, OKVTTLV attributeList, java.lang.String privateKeyUID, java.lang.String walletName) Implements the KMIP Register operation for the KMIP public key object.
java.lang.Integer	okvRegSecretData(OKVTagEnum secretDataType, byte[] secretDataValue, int usageMask, OKVTTLV attributeList, java.lang.String walletName) Implements the KMIP Register operation for the KMIP secret data object.
java.lang.Integer	okvRegTemplate(OKVTTLV attributeList, java.lang.String walletName) Implements the KMIP Register operation for the KMIP template object (not to be confused with KMIP template-attribute object).
java.lang.Integer	okvRekey(java.lang.String uid, java.lang.Integer offset, OKVTTLV attributeList) Implements the KMIP REKEY operation.
java.lang.Integer	okvRevoke(java.lang.String uid, OKVTagEnum reasonCode, java.lang.String reasonMessage, java.util.Date compromiseOccurenceDate) Implements the KMIP Revoke operation.
java.lang.Integer	okvSign(java.lang.String uid, byte[] data, DataType dataType, OKVCryptoContext cryptoContext) API to perform the sign operation on the provided data using KMIP object.
java.lang.Integer	okvSignVerify(java.lang.String uid, byte[] data, DataType dataType, byte[] signatureData, OKVCryptoContext cryptoContext) API to perform the signature verify operation on the provided data using KMIP object.

Methods inherited from class oracle.okv.operation.OKVOperationImpl

decomposeResponse

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_NAME

public static final java.lang.String CLASS_NAME

logger

public static final java.util.logging.Logger logger

Constructor Detail

OKVBatchOperation

public OKVBatchOperation()

Method Detail

composeRequest

public java.util.List<OKVTTLV> composeRequest()
                                       throws OKVException

Description copied from interface: oracle.okv.operation.OKVOperation

Composes a KMIP operation request into a hierarchy of TTLV objects

Returns:

OKVTTLV

Throws:

OKVException

composeRequest

public java.util.List<OKVTTLV> composeRequest(oracle.okv.service.OKVEnv env)
                                       throws OKVException

Description copied from interface: oracle.okv.operation.OKVOperation

Composes a KMIP operation request into a hierarchy of TTLV objects

Returns:

OKVTTLV

Throws:

OKVException

clearBatchItems

public void clearBatchItems()

Removes all items from the batch.

getChildOperationMap

public java.util.Map<java.lang.Integer,oracle.okv.operation.OKVChildOperation> getChildOperationMap()

Returns the batch item map, where the key is the batch item id and the value is the batched operation.

Returns:

the child operation map

okvActivate

public java.lang.Integer okvActivate(java.lang.String uid)

Implements the KMIP Activate operation. It will activate the KMIP Object identified by unique identifier. The unique identifier of the symmetric key object generated by the OKV server is returned in OKVUidResponse.

Parameters:

uid - Unique identifier (can be null for batching)

Returns:

Integer the Batch Item Number assigned to the operation

okvAddAttribute

public java.lang.Integer okvAddAttribute(java.lang.String uid,
                                         OKVTTLV attr)

Implements the KMIP add attribute operation. It adds an attribute to the KMIP Object specified by the unique identifier. The unique identifier of the symmetric key object generated by the OKV server is returned in OKVUidResponse.

Parameters:

uid - Unique Identifier (can be null for batching)

attr - Attribute to be added

Returns:

Integer the Batch Item Number assigned to the operation

okvCreateKey

public java.lang.Integer okvCreateKey(OKVTagEnum algorithm,
                                      int keyLength,
                                      int usageMask,
                                      OKVTTLV attributeList,
                                      java.lang.String walletName)

Implements the KMIP Create operation for the KMIP symmetric key object. A symmetric key of the specified length for the specified algorithm and for a specific use (cryptographic usage mask) is generated. The unique identifier of the symmetric key object generated by the OKV server is returned in OKVUidResponse. It is recommended to add a KMIP Name attribute to symmetric key object to help identify it in future.

Parameters:

algorithm - symmetric key algorithm

keyLength - key length of the symmetric key

usageMask - cryptographic mask usage of the symmetric key

attributeList - template names or attributes that will form the Template-Attribute

walletName - wallet membership of the symmetric key

Returns:

Integer the Batch Item Number assigned to the operation

okvCreateKeyPair

public java.lang.Integer okvCreateKeyPair(OKVTagEnum algorithm,
                                          int keyLength,
                                          int privateKeyUsageMask,
                                          int publicKeyUsageMask,
                                          OKVTTLV commonAttributeList,
                                          OKVTTLV privateKeyAttributeList,
                                          OKVTTLV publicKeyAttributeList,
                                          java.lang.String walletName)

Implements the KMIP create key pair operation. An asymmetric key pair of the specified length for the specified algorithm and for a specific use (cryptographic usage mask) is generated.

Parameters:

algorithm - Cryptographic Algorithm

keyLength - Key length

privateKeyUsageMask - Private key cryptographic usage mask

publicKeyUsageMask - Public key cryptographic usage mask

commonAttributeList - common template attribute list

privateKeyAttributeList - private key template attribute list

publicKeyAttributeList - public key template attribute list

walletName - Wallet name

Returns:

Integer the Batch Item Number assigned to the operation

okvDeleteAttribute

public java.lang.Integer okvDeleteAttribute(java.lang.String uid,
                                            java.lang.String attrName,
                                            int attrIndex)

Implements the KMIP delete attribute operation. It deletes an attribute specified by an attribute name and attribute index of the KMIP Object specified by the unique identifier.

Parameters:

uid - unique identifier (can be null for batching)

attrName - name of the attribute to be deleted

attrIndex - index of the attribute to be deleted

Returns:

Integer the Batch Item Number assigned to the operation

okvDestroy

public java.lang.Integer okvDestroy(java.lang.String uid)

Implements the KMIP Destroy operation. It will destroy the KMIP Object specified by unique identifier.

Parameters:

uid - unique identifier (can be null for batching)

Returns:

Integer the Batch Item Number assigned to the operation

okvGetAttributes

public java.lang.Integer okvGetAttributes(java.lang.String uid,
                                          java.util.List<java.lang.String> attrList)

Implements KMIP Get Attribute operation. It retrieves the specified list of regular and custom attributes for a given KMIP Object specified by the unique identifier.

Parameters:

uid - unique identifier (can be null for batching)

attrList - Names of the attributes to be retrieved

Returns:

Integer the Batch Item Number assigned to the operation

okvGetAttributeList

public java.lang.Integer okvGetAttributeList(java.lang.String uid)

Implements KMIP Get Attribute List operation. It retrieves the names of the regular and custom attributes of a KMIP Object specified by the unique identifier.

Parameters:

uid - unique identifier (can be null for batching)

Returns:

Integer the Batch Item Number assigned to the operation

okvGetCertificate

public java.lang.Integer okvGetCertificate(java.lang.String uid)

Implements the KMIP Get operation for the KMIP certificate object. For the specified unique identifier of the certificate, the certificate type, the certificate length and the certificate bytes in the EndPoint program supplied buffer are returned in OKVCertificateResponse.

Parameters:

uid - unique identifier (can be null for batching)

Returns:

Integer the Batch Item Number assigned to the operation

okvGetCertificateRequest

public java.lang.Integer okvGetCertificateRequest(java.lang.String uid)

Implements the KMIP Get operation for the certificate request object. For the specified unique identifier of the certificate request, the certificate request length and the certificate request bytes in the EndPoint program supplied buffer are returned in OKVOpaqueDataResponse.

Parameters:

uid - unique identifier (can be null for batching)

Returns:

Integer the Batch Item Number assigned to the operation

okvGetPrivateKey

public java.lang.Integer okvGetPrivateKey(java.lang.String uid)

Implements the KMIP Get operation for the KMIP private key object. For the specified unique identifier of the private key, the key length, key algorithm, the actual key bytes in the EndPoint program supplied buffer and the actual length of the key bytes are returned in OKVPrivateKeyResponse.

Parameters:

uid - unique identifier (can be null for batching)

Returns:

Integer the Batch Item Number assigned to the operation

okvGetPublicKey

public java.lang.Integer okvGetPublicKey(java.lang.String uid)

Implements the KMIP Get operation for the KMIP public key object. For the specified unique identifier of the public key, the key length, key algorithm, the actual key bytes in the EndPoint program supplied buffer and the actual length of the key bytes are returned in OKVPublicKeyResponse.

Parameters:

uid - unique identifier (can be null for batching)

Returns:

Integer the Batch Item Number assigned to the operation

okvGetKey

public java.lang.Integer okvGetKey(java.lang.String uid)

Implements the KMIP Get operation for the KMIP symmetric key object. For the specified unique identifier of the symmetric key, the key length, key algorithm, the actual key bytes in the EndPoint program supplied buffer and the actual length of the key bytes are returned in OKVKeyResponse.

Parameters:

uid - unique identifier (can be null for batching)

Returns:

Integer the Batch Item Number assigned to the operation

okvGetOpaqueData

public java.lang.Integer okvGetOpaqueData(java.lang.String uid)

Implements the KMIP Get operation for the KMIP opaque data object. For the specified unique identifier of the opaque data, the opaque data type, the opaque data length and the opaque data bytes in the EndPoint program supplied buffer is returned in OKVOpaqueDataResponse.

Parameters:

uid - unique identifier (can be null for batching)

Returns:

Integer the Batch Item Number assigned to the operation

okvGetSecretData

public java.lang.Integer okvGetSecretData(java.lang.String uid)

Implements the KMIP Get operation for the KMIP secret data object. For the specified unique identifier of the secret data, the secret data type, the secret data length and the secret data bytes in the EndPoint program supplied buffer is returned in OKVSecretDataResponse.

Parameters:

uid - unique identifier (can be null for batching)

Returns:

Integer the Batch Item Number assigned to the operation

okvGetTemplate

public java.lang.Integer okvGetTemplate(java.lang.String uid)

Implements the KMIP Get operation for the KMIP template object. The template is a list of attributes, which can be interpreted using the OKV Utility or OKV KMIP Extension functions. For the specified unique identifier of the template, the attributes of the template object are returned in OKVAttrsResponse.

Parameters:

uid - unique identifier

Returns:

Integer the Batch Item Number assigned to the operation

okvLocate

public java.lang.Integer okvLocate(java.lang.Integer maxItems,
                                   java.lang.Integer storageStatusMask,
                                   OKVTagEnum objectGroupMember,
                                   OKVTTLV attributeList)

Implements the KMIP locate operation. The locate operation will look up all the objects in OKV that match the attributes specified in the locate_attrs. The server will only return uid_max number of unique identifiers even if the look up returns more.

Parameters:

maxItems - maximum number of unique identifiers expected

storageStatusMask - look for archived or online objects

objectGroupMember - object group member type

attributeList - attributes that define the locate search

Returns:

Integer the Batch Item Number assigned to the operation

okvModifyAttribute

public java.lang.Integer okvModifyAttribute(java.lang.String uid,
                                            OKVTTLV attr)

Implements the KMIP modify attribute operation. It modifies an attribute of the KMIP Object specified by the unique identifier.

Parameters:

uid - unique identifier

attr - Attribute to be modified

Returns:

Integer the Batch Item Number assigned to the operation

okvQueryCapability

public java.lang.Integer okvQueryCapability(java.util.List<OKVTagEnum> queryFuncs)

Implements the KMIP Query operation. KMIP Query operation returns the OKV Server supported items - KMIP operations, objects, server information. Items can also be retrieved one at a time. Query function specifies which items should returned. The supported values of query functions are, OKVQUERY_OPERATIONS OKVQUERY_OBJECTS OKVQUERY_SERVER_INFORMATION The count of the item not requested in the query function will be zero. If server information is not requested then server_information can be NULL.

Parameters:

queryFuncs - KMIP query functions requested

Returns:

Integer the Batch Item Number assigned to the operation

okvRegKey

public java.lang.Integer okvRegKey(byte[] keyValue,
                                   OKVTagEnum algorithm,
                                   int keyLength,
                                   int usageMask,
                                   OKVTTLV attributeList,
                                   java.lang.String walletName)
                            throws OKVException

Implements the KMIP Register operation for the KMIP symmetric key object. A symmetric key of the specified length for a specified algorithm and use (cryptographic usage mask) is registered with OKV Server. The unique identifier of the symmetric key object generated by the OKV server is returned in OKVUidResponse. The new key created can take in additional attributes specified the help of attributes and/or template names. The attributes and/or template names will be the template attribute added to KMIP Register operation. Comments: It is recommended to add a KMIP Name attribute to symmetric key object to help identify it in future.

Parameters:

keyValue - symmetric Key

algorithm - symmetric key algorithm

keyLength - key length of the symmetric key

usageMask - cryptographic mask usage of the symmetric key

attributeList - template names or attributes that will form the Template-Attribute

walletName - wallet membership of the symmetric key

Returns:

Integer the Batch Item Number assigned to the operation

Throws:

OKVException

okvRegPrivateKey

public java.lang.Integer okvRegPrivateKey(byte[] privateKeyValue,
                                          OKVTagEnum algorithm,
                                          int privateKeyLength,
                                          int usageMask,
                                          OKVTTLV attributeList,
                                          java.lang.String walletName)
                                   throws OKVException

Implements the KMIP Register operation for the KMIP private key object. A private key of the specified length for a specified algorithm and use (cryptographic usage mask) is registered with OKV Server. The unique identifier of the private key object generated by the OKV server is returned in OKVUidResponse. The new key created can take in additional attributes specified the help of attributes and/or template names. The attributes and/or template names will be the template attribute added to KMIP Register operation. Comments: It is recommended to add a KMIP Name attribute to private key object to help identify it in future.

Parameters:

privateKeyValue - private key being registered

algorithm - private key algorithm

privateKeyLength - key length of the private key

usageMask - cryptographic mask usage of the private key

attributeList - template names or attributes that will form the Template-Attribute

walletName - wallet membership of the private key

Returns:

Integer the Batch Item Number assigned to the operation

Throws:

OKVException

okvRegPublicKey

public java.lang.Integer okvRegPublicKey(byte[] publicKeyValue,
                                         OKVTagEnum algorithm,
                                         int publicKeyLength,
                                         int usageMask,
                                         OKVTTLV attributeList,
                                         java.lang.String privateKeyUID,
                                         java.lang.String walletName)
                                  throws OKVException

Implements the KMIP Register operation for the KMIP public key object. A public key of the specified length for a specified algorithm and use (cryptographic usage mask) is registered with OKV Server. The unique identifier of the public key object generated by the OKV server is returned in OKVUidResponse. The new key created can take in additional attributes specified the help of attributes and/or template names. The attributes and/or template names will be the template attribute added to KMIP Register operation. Comments: It is recommended to add a KMIP Name attribute to public key object to help identify it in future.

Parameters:

publicKeyValue - public Key being registered

algorithm - public key algorithm

publicKeyLength - key length of the public key

usageMask - cryptographic mask usage of the public key

attributeList - template names or attributes that will form the Template-Attribute

privateKeyUID - UID of the private key associated with the public key

walletName - wallet membership of the public key

Returns:

Integer the Batch Item Number assigned to the operation

Throws:

OKVException

okvRegCertificate

public java.lang.Integer okvRegCertificate(OKVTagEnum certificateType,
                                           OKVTag certificateSubType,
                                           byte[] certificateValue,
                                           int usageMask,
                                           OKVTTLV attributeList,
                                           java.lang.String privateKeyUID,
                                           java.lang.String walletName)
                                    throws OKVException

Implements the KMIP Register operation for the KMIP certificate object. A certificate of a specific type is registered with OKV Server. The unique identifier of the certificate object generated by the OKV server is returned in OKVUidResponse. The new certificate created can take in additional attributes specified the help of attributes and/or template names. The attributes and/or template names will be the template attribute added to KMIP Register operation. Comments: It is recommended to add a KMIP Name attribute to certificate object to help identify it in future.

Parameters:

certificateType - type of certificate being registered

certificateSubType - sub type of the certificate being registered OKVTag.OKV_CERT_SUBTYPE_USER_CERT represents User Certificate OKVTag.OKV_CERT_SUBTYPE_TRUSTPOINT represents Trustpoint

certificateValue - certificate being registered

usageMask - cryptographic mask usage of the certificate

attributeList - template names or attributes that will form the Template-Attribute

privateKeyUID - UID of the private key associated with certificate

walletName - wallet membership of certificate

Returns:

Integer the Batch Item Number assigned to the operation

Throws:

OKVException

okvRegCertificateRequest

public java.lang.Integer okvRegCertificateRequest(OKVTagEnum certificateRequestType,
                                                  byte[] certificateRequestValue,
                                                  OKVTTLV attributeList,
                                                  java.lang.String privateKeyUID,
                                                  java.lang.String walletName)
                                           throws OKVException

Implements the KMIP Register operation for the certificate request object. A certificate request object is registered as an opaque object with Oracle Key Vault Server. The unique identifier of the certificate request object generated by the Oracle Key Vault server is returned in OKVUidResponse. The new certificate request created can take in additional attributes specified the help of attributes and template names if specified. The attributes and template names (if specified) will be the template attribute added to KMIP Register operation. Comments: It is recommended to add a KMIP Name attribute to certificate request object to help identify it in future.

Parameters:

certificateRequestType - type of certificate request being registered. Allowed values: OKVTagEnum.OPAQUE_DATA_TYPE_EXTENSIONS

certificateRequestValue - certificate request object being registered

attributeList - template names or attributes that will form the Template-Attribute

privateKeyUID - UID of the private key associated with certificate request

walletName - wallet membership of certificate request

Returns:

Integer the Batch Item Number assigned to the operation

Throws:

OKVException

okvRegSecretData

public java.lang.Integer okvRegSecretData(OKVTagEnum secretDataType,
                                          byte[] secretDataValue,
                                          int usageMask,
                                          OKVTTLV attributeList,
                                          java.lang.String walletName)
                                   throws OKVException

Implements the KMIP Register operation for the KMIP secret data object. A secret data of a specific type is registered with OKV Server. Secret data is usually a psd or a string. The unique identifier of the symmetric key object generated by the OKV server is returned in OKVUidResponse. The new secret data created can take in additional attributes specified the help of attributes and/or template names. The attributes and/or template names will be the template attribute added to KMIP Register operation. Comments: It is recommended to add a KMIP Name attribute to secret data object to help identify it in future.

Parameters:

secretDataType - type of secret data being registered

secretDataValue - secret data being registered

usageMask - cryptographic mask usage of the secret data

attributeList - template names or attributes that will form the Template-Attribute

walletName - wallet membership of secret data

Returns:

Integer the Batch Item Number assigned to the operation

Throws:

OKVException

okvRegOpaqueData

public java.lang.Integer okvRegOpaqueData(OKVTagEnum opaqueType,
                                          byte[] opaqueValue,
                                          OKVTTLV attributeList,
                                          java.lang.String walletName)
                                   throws OKVException

Implements the KMIP Register operation for the KMIP opaque data object. An opaque data of a specific type is registered with OKV Server. The opaque data is a byte string. A text file, text string, binary file or key anything can be uploaded as an opaque data. The unique identifier of the opaque data object registered by the OKV server is returned in OKVUidResponse. The new opaque data created can take in additional attributes specified the help of attributes and/or template names. The attributes and/or template names will be the template attribute added to KMIP Register operation. Comments: It is recommended to add a KMIP Name attribute to opaque data object to help identify it in future.

Parameters:

opaqueType - type of opaque object being registered

opaqueValue - opaque object being registered

attributeList - template names or attributes that will form the Template-Attribute

walletName - wallet membership of opaque data

Returns:

Integer the Batch Item Number assigned to the operation

Throws:

OKVException

okvRegTemplate

public java.lang.Integer okvRegTemplate(OKVTTLV attributeList,
                                        java.lang.String walletName)

Implements the KMIP Register operation for the KMIP template object (not to be confused with KMIP template-attribute object). A template object is a collection attributes. The unique identifier of the symmetric key object generated by the OKV server is returned in OKVUidResponse.

Parameters:

attributeList - attributes of the template

walletName - wallet membership of the template

Returns:

Integer the Batch Item Number assigned to the operation

okvRekey

public java.lang.Integer okvRekey(java.lang.String uid,
                                  java.lang.Integer offset,
                                  OKVTTLV attributeList)

Implements the KMIP REKEY operation. The REKEY operation requires the unique identifier of the symmetric key that needs be me RE-KEYed. Most of the attributes are carried over from the old key. Some attributes are modified per KMIP defined rules. The activation date can be modified using the offset argument. The unique identifier of the symmetric key object generated by the OKV server is returned in OKVUidResponse.

Parameters:

uid - unique identifier (can be null for batching)

offset - time interval indicating the difference between the Initialization Date and the Activation Date of the replacement key to be created

attributeList - template names or attributes that will form the Template-Attribute

Returns:

Integer the Batch Item Number assigned to the operation

okvRevoke

public java.lang.Integer okvRevoke(java.lang.String uid,
                                   OKVTagEnum reasonCode,
                                   java.lang.String reasonMessage,
                                   java.util.Date compromiseOccurenceDate)

Implements the KMIP Revoke operation. It revokes the KMIP Object specified by the unique identifier with a revocation reason and the date when the object was compromised. A key must be revoked prior to calling the destroy operation.

Parameters:

uid - unique identifier (can be null for batching)

reasonCode - revocation reason for revoking the KMIP object

reasonMessage - revocation message for revoking the KMIP object

compromiseOccurenceDate - Date when the KMIP object compromise occurred

Returns:

Integer the Batch Item Number assigned to the operation

okvEncrypt

public java.lang.Integer okvEncrypt(java.lang.String uid,
                                    byte[] data,
                                    OKVCryptoContext cryptoContext)
                             throws OKVException

API to perform the encryption operation on the provided data using KMIP object.

Parameters:

uid - unique identifier

data - data to be encrypted

cryptoContext - crypto context containing required parameters for encryption like cryptographic parameters, IV

Returns:

Integer the Batch Item Number assigned to the operation

Throws:

OKVException

okvDecrypt

public java.lang.Integer okvDecrypt(java.lang.String uid,
                                    byte[] data,
                                    OKVCryptoContext cryptoContext)
                             throws OKVException

API to perform the decryption operation on the provided data using KMIP object.

Parameters:

uid - unique identifier

data - data to be decrypted

cryptoContext - crypto context containing required parameters for decryption like cryptographic parameters, IV

Returns:

Integer the Batch Item Number assigned to the operation

Throws:

OKVException

okvSign

public java.lang.Integer okvSign(java.lang.String uid,
                                 byte[] data,
                                 DataType dataType,
                                 OKVCryptoContext cryptoContext)
                          throws OKVException

API to perform the sign operation on the provided data using KMIP object.

Parameters:

uid - unique identifier

data - data to be signed

dataType - data type RAW or Digest

cryptoContext - crypto context containing required parameters for signing like hashing, padding and cryptographic algorithm

Returns:

Integer the Batch Item Number assigned to the operation

Throws:

OKVException

okvSignVerify

public java.lang.Integer okvSignVerify(java.lang.String uid,
                                       byte[] data,
                                       DataType dataType,
                                       byte[] signatureData,
                                       OKVCryptoContext cryptoContext)
                                throws OKVException

API to perform the signature verify operation on the provided data using KMIP object.

Parameters:

uid - unique identifier

data - data to be signed

dataType - data type RAW or Digest

signatureData - signature data to be verified

cryptoContext - crypto context containing required parameters for signing like hashing, padding and cryptographic algorithm

Returns:

Integer the Batch Item Number assigned to the operation

Throws:

OKVException