Oracle Key Vault Java SDK APIs

The Oracle Key Vault Java SDK provides APIs similar to C SDK APIs.

• Java SDK Management APIs

  This section describes the interfaces for Oracle Key Vault program environment.

• Java SDK Connection Management APIs

  This section describes the interfaces for Oracle Key Vault connection management.

• Java SDK KMIP APIs

  The Java SDK KMIP APIs provide functions for creating keys, activating keys, adding attributes to keys, destroying keys, and other operations.

• Java SDK KMIP Batch APIs

  This section describes the interfaces for the Oracle Key Vault KMIP Batch functions.

• Java SDK KMIP Attribute APIs This section describes the interfaces that help create and interpret Oracle Key Vault KMIP attributes.

• Java SDK KMIP Custom Attribute APIs

  This section describes the interfaces that help create and interpret Oracle Key Vault KMIP custom attributes.

• Java SDK Extension Operation Management APIs

  This section describes the interfaces for Oracle Key Vault operations used to execute custom KMIP requests.

• Java SDK TTLV Object APIs

  This section describes the interfaces for Oracle Key Vault KMIP parser/builder.

• Java SDK Utility APIs

  The Java SDK Utility API provides a function for creating the cryptographic context.

Java SDK Management APIs

This section describes the interfaces for Oracle Key Vault program environment.

Management APIs

• okvEnvGetOpRequestObj

• okvEnvSetConfig

Java SDK Connection Management APIs

This section describes the interfaces for Oracle Key Vault connection management.

Connection Management APIs

• okvConnect

• okvConnSendRecvBytes

• okvDisconnect

Java SDK KMIP APIs

The Java SDK KMIP APIs provide functions for creating keys, activating keys, adding attributes to keys, destroying keys, and other operations.

KMIP APIs

• okvActivate

• okvAddAttribute

• okvCreateKey

• okvCreateKeyPair

• okvDecrypt

• okvDeleteAttribute

• okvDestroy

• okvEncrypt

• okvGetAttributeList

• okvGetAttributes

• okvGetCertificate

• okvGetCertificateRequest

• okvGetKey

• okvGetOpaqueData

• okvGetPrivateKey

• okvGetPublicKey

• okvGetSecretData

• okvGetTemplate

• okvLocate

• okvModifyAttribute

• okvQueryCapability

• okvRegCertificate

• okvRegCertificateRequest

• okvRegKey

• okvRekey

• okvRegOpaqueData

• okvRegPrivateKey

• okvRegPublicKey

• okvRevoke

• okvRegSecretData

• okvRegTemplate

• okvSign

• okvSignVerify

Java SDK KMIP Batch APIs

This section describes the interfaces for the Oracle Key Vault KMIP Batch functions.

KMIP Batch APIs

• okvActivate

• okvAddAttribute

• okvBatchExecute

• okvCreateKey

• okvCreateKeyPair

• okvDecrypt

• okvDeleteAttribute

• okvDestroy

• okvEncrypt

• okvGetAttributeList

• okvGetAttributes

• okvGetCertificate

• okvGetCertificateRequest

• okvGetKey

• okvGetOpaqueData

• okvGetPrivateKey

• okvGetPublicKey

• okvGetSecretData

• okvGetTemplate

• okvLocate

• okvModifyAttribute

• okvQueryCapability

• okvRegCertificate

• okvRegCertificateRequest

• okvRegKey

• okvRegOpaqueData

• okvRegPrivateKey

• okvRegPublicKey

• okvRegSecretData

• okvRegTemplate

• okvRekey

• okvRevoke

• okvSign

• okvSignVerify

Java SDK KMIP Attribute APIs

This section describes the interfaces that help create and interpret Oracle Key Vault KMIP attributes.

KMIP Attribute APIs

• okvAddAttributeObject

• okvAttrAddActivationDate

• okvAttrAddArchiveDate

• okvAttrAddCertLen

• okvAttrAddCertType

• okvAttrAddCompromiseDate

• okvAttrAddCompromiseOccurrenceDate

• okvAttrAddContactInfo

• okvAttrAddCryptoAlgo

• okvAttrAddCryptoLen

• okvAttrAddCryptoParams

• okvAttrAddCryptoUsageMask

• okvAttrAddDeactivationDate

• okvAttrAddDestroyDate

• okvAttrAddDigest

• okvAttrAddDigitalSignAlgo

• okvAttrAddExtractable

• okvAttrAddFresh

• okvAttrAddInitialDate

• okvAttrAddLastChangeDate

• okvAttrAddLeaseTime

• okvAttrAddName

• okvAttrAddNeverExtractable

• okvAttrAddObjectGroup

• okvAttrAddObjectType

• okvAttrAddProcessStartDate

• okvAttrAddProtectStopDate

• okvAttrAddRevocationReason

• okvAttrAddState

• okvAttrAddUniqueID

• okvAttrAddUsageLimits

• okvAttrAddX509CertId

• okvAttrAddX509CertIss

• okvAttrAddX509CertIssAltName

• okvAttrAddX509CertSubj

• okvAttrAddX509CertSubjAltName

• okvAttrGetActivationDate

• okvAttrGetArchiveDate

• okvAttrGetCertLen

• okvAttrGetCertType

• okvAttrGetCompromiseDate

• okvAttrGetCompromiseOccurrenceDate

• okvAttrGetContactInfo

• okvAttrGetCryptoAlgo

• okvAttrGetCryptoLen

• okvAttrGetCryptoParams

• okvAttrGetCryptoUsageMask

• okvAttrGetDeactivationDate

• okvAttrGetDestroyDate

• okvAttrGetDigest

• okvAttrGetDigitalSignAlgo

• okvAttrGetExtractable

• okvAttrGetFresh

• okvAttrGetInitialDate

• okvAttrGetLastChangeDate

• okvAttrGetLeaseTime

• okvAttrGetName

• okvAttrGetNeverExtractable

• okvAttrGetObjectGroup

• okvAttrGetObjectType

• okvAttrGetProcessStartDate

• okvAttrGetProtectStopDate

• okvAttrGetRevocationReason

• okvAttrGetState

• okvAttrGetUniqueID

• okvAttrGetUsageLimits

• okvAttrGetX509CertId

• okvAttrGetX509CertIss

• okvAttrGetX509CertIssAltName

• okvAttrGetX509CertSubj

• okvAttrGetX509CertSubjAltName

• okvGetAttributeObject

Java SDK KMIP Custom Attribute APIs

This section describes the interfaces that help create and interpret Oracle Key Vault KMIP custom attributes.

Note: Do not use the prefix of x-OKV with custom attribute names. The custom attributes that start with the x-OKV prefix are reserved for use by Oracle Key Vault only.

KMIP Custom Attribute APIs

• okvCustomAttrAddBoolean

• okvCustomAttrAddByteString

• okvCustomAttrAddBigInteger

• okvCustomAttrAddDateTime

• okvCustomAttrAddEnum

• okvCustomAttrAddInteger

• okvCustomAttrAddInterval

• okvCustomAttrAddLongInteger

• okvCustomAttrAddStructure

• okvCustomAttrAddTextString

• okvCustomAttrGetBigInteger

• okvCustomAttrGetBoolean

• okvCustomAttrGetByName

• okvCustomAttrGetByteString

• okvCustomAttrGetByType

• okvCustomAttrGetDateTime

• okvCustomAttrGetEnum

• okvCustomAttrGetInteger

• okvCustomAttrGetInterval

• okvCustomAttrGetLongInteger

• okvCustomAttrGetStructure

• okvCustomAttrGetTextString

Java SDK Extension Operation Management APIs

This section describes the interfaces for Oracle Key Vault operations used to execute custom KMIP requests.

Extension Operation Management APIs

• okvOpsExecuteOp

Java SDK TTLV Object APIs

This section describes the interfaces for Oracle Key Vault KMIP parser/builder.

KMIP Extension TTLV Object APIs

• okvTTLVGetChild

• okvTTLVGetChildByTag

• okvTTLVGetFirstChildByTag

• okvTTLVGetLen

• okvTTLVGetTag

• okvTTLVGetType

• okvTTLVGetValue

Java SDK Utility APIs

The Java SDK Utility API provides a function for creating the cryptographic context.

Utility APIs

• okvCryptoContextCreate