Package | Description |
---|---|
oracle.okv.exception |
This package contains all the exceptions thrown by the Java SDK Oracle Key
Vault interface.
|
oracle.okv.kmip |
This package contains enum class for KMIP tags, tag enumerations, and types.
|
oracle.okv.service |
This package contains the OKVService class through which all the high level
Java SDK APIs are exposed.
|
Modifier and Type | Class and Description |
---|---|
class |
OKVAppNamespaceNotSuppException
Thrown when an application namespace is not supported.
|
class |
OKVAuthNotSuccessfulException
Thrown when the authentication is not successful.
|
class |
OKVBatchResponseException
Thrown when a batch operation fails.
|
class |
OKVConfigurationException
Throws Oracle Key Vault configuration exceptions.
|
class |
OKVConnectionException
Thrown when an error occurred while attempting to connect to the key
management server.
|
class |
OKVCryptographicFailureException
Thrown when a cryptographic failure occurs.
|
class |
OKVEncodingOptionException
Thrown when the encoding option is not permitted which can result when
the key wrapping specification contains attribute names.
|
class |
OKVFeatureNotSuppException
Thrown when a feature is not supported.
|
class |
OKVGeneralFailureException
Thrown for general failures.
|
class |
OKVIllegalOperationException
Thrown during an illegal operation.
|
class |
OKVIndexOutOfBoundsException
Thrown for an index out of bounds error.
|
class |
OKVInsufficientGrpPrivException
Thrown when group privileges are insufficient.
|
class |
OKVInvalidArgumentException
Thrown when the argument that was passed to the function is null or has
an invalid value.
|
class |
OKVInvalidAttrValueException
Thrown when an attribute value is not of the expected type.
|
class |
OKVInvalidFieldException
Thrown for an invalid field.
|
class |
OKVInvalidGroupException
Thrown when an invalid object group is used.
|
class |
OKVInvalidMessageException
Thrown for an invalid message.
|
class |
OKVInvalidTTLVException
Thrown when OKVTTLV object is null or has an
invalid value for the operation.
|
class |
OKVItemNotFoundException
Thrown for an item that is not found.
|
class |
OKVKeyCompressionTypeNotSuppException
Thrown when an object exists but it cannot be provided in the desired
key compression type.
|
class |
OKVKeyFormatTypeNotSuppException
Thrown when the key format type is not supported.
|
class |
OKVMissingDataException
Thrown when data is missing.
|
class |
OKVNoReasonException
Thrown when the key management server returns an error but the reason
for the error is not provided.
|
class |
OKVObjectArchivedException
Thrown when an object is archived.
|
class |
OKVOperationCancelledException
Thrown when a requester cancels an operation.
|
class |
OKVOperationNotSuppException
Thrown when an operation is not supported.
|
class |
OKVPermissionDeniedException
Thrown when permission is denied.
|
class |
OKVResponseException
The superclass that is extended by Oracle Key Vault response exceptions.
|
class |
OKVResponseTooLargeException
Thrown when the response is too large.
|
class |
OKVRestrictedModeException
Thrown when Oracle Key Vault is in restricted mode.
|
class |
OKVWrongObjectTypeException
Thrown when the unique identifier that was provided is incorrect for the
requested object type.
|
Modifier and Type | Method and Description |
---|---|
OKVTTLV |
OKVTTLV.okvAttrAddActivationDate(java.util.Date date)
API to add an activation date attribute to an OKVTTLV object.
|
OKVTTLV |
OKVTTLV.okvAttrAddArchiveDate(java.util.Date date)
API to add an archive date attribute to an OKVTTLV object.
|
OKVTTLV |
OKVTTLV.okvAttrAddCertLen(int certLen)
API to add a certificate length attribute to an OKVTTLV object.
|
OKVTTLV |
OKVTTLV.okvAttrAddCertType(OKVTagEnum certType)
API to add a certificate type attribute to an OKVTTLV object.
|
OKVTTLV |
OKVTTLV.okvAttrAddCompromiseDate(java.util.Date date)
API to add a compromise date attribute to an OKVTTLV object.
|
OKVTTLV |
OKVTTLV.okvAttrAddCompromiseOccurrenceDate(java.util.Date date)
API to add a compromise occurrence date attribute to an OKVTTLV object.
|
OKVTTLV |
OKVTTLV.okvAttrAddContactInfo(java.lang.String contact)
API to add a contact information attribute to an OKVTTLV object.
|
OKVTTLV |
OKVTTLV.okvAttrAddCryptoAlgo(OKVTagEnum cryptoAlg)
API to add a cryptographic algorithm attribute
to an OKVTTLV parent object.
|
OKVTTLV |
OKVTTLV.okvAttrAddCryptoDomainParams(java.lang.Integer qLength,
OKVTagEnum recommendedCurve)
API to add cryptographic domain parameters attribute to an
OKVTTLV object.
|
OKVTTLV |
OKVTTLV.okvAttrAddCryptoLen(int length)
API to add a cryptographic length attribute to an OKVTTLV object.
|
OKVTTLV |
OKVTTLV.okvAttrAddCryptoParams(OKVTagEnum blockCipherMode,
OKVTagEnum paddingMethod,
OKVTagEnum hashingAlgo,
OKVTagEnum keyRoleType)
API to add a cryptographic parameter attribute to an OKVTTLV object.
|
OKVTTLV |
OKVTTLV.okvAttrAddCryptoUsageMask(int cryptoUsageMask)
API to add a cryptographic usage mask attribute to an OKVTTLV object.
|
OKVTTLV |
OKVTTLV.okvAttrAddDeactivationDate(java.util.Date date)
API to add a deactivation date attribute to an OKVTTLV object.
|
OKVTTLV |
OKVTTLV.okvAttrAddDestroyDate(java.util.Date date)
API to add a destroy date attribute to an OKVTTLV object.
|
OKVTTLV |
OKVTTLV.okvAttrAddDigest(OKVTagEnum hashAlg,
OKVTagEnum keyFormatType,
byte[] digest)
API to add digest attribute parameters to an OKVTTLV object.
|
OKVTTLV |
OKVTTLV.okvAttrAddFresh(boolean fresh)
API to add a fresh attribute to an OKVTTLV object.
|
OKVTTLV |
OKVTTLV.okvAttrAddInitialDate(java.util.Date date)
API to add an initial date attribute to an OKVTTLV object.
|
OKVTTLV |
OKVTTLV.okvAttrAddLastChangeDate(java.util.Date date)
API to add a last change date attribute to an OKVTTLV object.
|
OKVTTLV |
OKVTTLV.okvAttrAddLeaseTime(int leaseTime)
API to add a lease time attribute to an OKVTTLV object.
|
OKVTTLV |
OKVTTLV.okvAttrAddLink(OKVTagEnum type,
java.lang.String objId)
API to add a link attribute to an OKVTTLV object.
|
OKVTTLV |
OKVTTLV.okvAttrAddName(java.lang.String name,
OKVTagEnum nameType)
API to add a name attribute to an OKVTTLV object.
|
OKVTTLV |
OKVTTLV.okvAttrAddObjectGroup(java.lang.String objectGroup)
API to add an object group attribute to an OKVTTLV object.
|
OKVTTLV |
OKVTTLV.okvAttrAddObjectType(OKVTagEnum objType)
API to add an object type attribute to an OKVTTLV object.
|
OKVTTLV |
OKVTTLV.okvAttrAddProcessStartDate(java.util.Date date)
API to add a process start date attribute to an OKVTTLV object.
|
OKVTTLV |
OKVTTLV.okvAttrAddProtectStopDate(java.util.Date date)
API to add a protect stop date attribute to an OKVTTLV object.
|
OKVTTLV |
OKVTTLV.okvAttrAddRevocationReason(OKVTagEnum code,
java.lang.String msg)
API to add revocation reason attribute parameters to an OKVTTLV object.
|
OKVTTLV |
OKVTTLV.okvAttrAddSignAlgo(OKVTagEnum alg)
API to add a digital signature algorithm attribute to an OKVTTLV object.
|
OKVTTLV |
OKVTTLV.okvAttrAddState(OKVTagEnum state)
API to add a state attribute to an OKVTTLV object.
|
OKVTTLV |
OKVTTLV.okvAttrAddUniqueId(java.lang.String uid)
API to add a unique identifier attribute to an OKVTTLV object.
|
OKVTTLV |
OKVTTLV.okvAttrAddUsageLimits(long total,
long count,
OKVTagEnum unit)
API to add usage limit attribute parameters to an OKVTTLV object.
|
java.util.Date |
OKVTTLV.okvAttrGetActivationDate()
API to get the activation date attribute value from an OKVTTLV object.
|
java.util.Date |
OKVTTLV.okvAttrGetArchiveDate()
API to get the archive date attribute value from an OKVTTLV object.
|
java.lang.Integer |
OKVTTLV.okvAttrGetCertLen()
API to get the certificate length attribute value from an OKVTTLV object.
|
OKVTagEnum |
OKVTTLV.okvAttrGetCertType()
API to get the certificate type attribute value from an OKVTTLV object.
|
java.util.Date |
OKVTTLV.okvAttrGetCompromiseDate()
API to get the compromise date attribute value from an OKVTTLV object.
|
java.util.Date |
OKVTTLV.okvAttrGetCompromiseOccurrenceDate()
API to get the compromise occurrence date attribute
value from an OKVTTLV object.
|
java.lang.String |
OKVTTLV.okvAttrGetContactInfo()
API to get the contact information attribute value
from an OKVTTLV object.
|
OKVTagEnum |
OKVTTLV.okvAttrGetCryptoAlgo()
API to get cryptographic algorithm attribute from an OKVTTLV object.
|
OKVCryptoDomainParams |
OKVTTLV.okvAttrGetCryptoDomainParams()
API to get the cryptographic domain parameters values
from an OKVTTLV object.
|
java.lang.Integer |
OKVTTLV.okvAttrGetCryptoLen()
API to get the cryptographic length attribute value
from an OKVTTLV object.
|
OKVCryptoParams |
OKVTTLV.okvAttrGetCryptoParams(int elemIndex)
API to get the cryptographic parameter values from an OKVTTLV object.
|
java.lang.Integer |
OKVTTLV.okvAttrGetCryptoUsageMask()
API to get the cryptographic usage mask attribute value
from an OKVTTLV object.
|
java.util.Date |
OKVTTLV.okvAttrGetDeactivationDate()
API to get the deactivation date attribute value
from an OKVTTLV object.
|
java.util.Date |
OKVTTLV.okvAttrGetDestroyDate()
API to get the destroy date attribute value from an OKVTTLV object.
|
OKVDigest |
OKVTTLV.okvAttrGetDigest(int elemIndex)
API to get the digest attribute values from an OKVTTLV object.
|
java.lang.Boolean |
OKVTTLV.okvAttrGetFresh()
API to get the fresh attribute value from an OKVTTLV object.
|
java.util.Date |
OKVTTLV.okvAttrGetInitialDate()
API to get the initial date attribute value from an OKVTTLV object.
|
java.util.Date |
OKVTTLV.okvAttrGetLastChangeDate()
API to get the last change date attribute value from an OKVTTLV object.
|
java.lang.Integer |
OKVTTLV.okvAttrGetLeaseTime()
API to get the lease time attribute value from an OKVTTLV object.
|
OKVLink |
OKVTTLV.okvAttrGetLink(int elemIndex)
API to get the link parameters from an OKVTTLV object.
|
OKVName |
OKVTTLV.okvAttrGetName(int elemIndex)
API to get the name and name type values from an OKVTTLV object.
|
java.lang.String |
OKVTTLV.okvAttrGetObjectGroup()
API to get the object group attribute from an OKVTTLV object.
|
OKVTagEnum |
OKVTTLV.okvAttrGetObjectType()
API to get the object type attribute value from an OKVTTLV object.
|
java.util.Date |
OKVTTLV.okvAttrGetProcessStartDate()
API to get the process start date attribute value
from an OKVTTLV object.
|
java.util.Date |
OKVTTLV.okvAttrGetProtectStopDate()
API to get the protect stop date attribute value
from an OKVTTLV object.
|
OKVRevocationReason |
OKVTTLV.okvAttrGetRevocationReason()
API to get the revocation reason attribute values
from an OKVTTLV object.
|
OKVTagEnum |
OKVTTLV.okvAttrGetSignAlgo(int elemIndex)
API to get the digital signature algorithm attribute
value from an OKVTTLV object.
|
OKVTagEnum |
OKVTTLV.okvAttrGetState()
API to get state attribute value from an OKVTTLV object.
|
java.lang.String |
OKVTTLV.okvAttrGetUniqueID(int elemIndex)
API to get the unique identifier value from an OKVTTLV object.
|
OKVUsageLimits |
OKVTTLV.okvAttrGetUsageLimits()
API to get the usage limits attribute values from an OKVTTLV object.
|
OKVTTLV |
OKVTTLV.okvCustomAttrAddBigInteger(java.lang.String name,
int attrIndex,
java.math.BigInteger value)
API to add a big integer data type with an attribute index to the
custom attribute of the OKVTTLV object.
|
OKVTTLV |
OKVTTLV.okvCustomAttrAddBoolean(java.lang.String name,
int attrIndex,
java.lang.Boolean value)
API to add a boolean data type with an attribute index to
the custom attribute of the OKVTTLV object.
|
OKVTTLV |
OKVTTLV.okvCustomAttrAddByteString(java.lang.String name,
int attrIndex,
byte[] value)
API to add a byte string data type with an attribute index
to the custom attribute of an OKVTTLV object.
|
OKVTTLV |
OKVTTLV.okvCustomAttrAddDateTime(java.lang.String name,
int attrIndex,
java.util.Date value)
API to add a date time data type with an attribute index
to the custom attribute of the OKVTTLV object.
|
OKVTTLV |
OKVTTLV.okvCustomAttrAddEnum(java.lang.String name,
int attrIndex,
int value)
API to add an enumeration data type with an attribute index to
the custom attribute of the OKVTTLV object.
|
OKVTTLV |
OKVTTLV.okvCustomAttrAddInteger(java.lang.String name,
int attrIndex,
java.lang.Integer value)
API to add an integer data type with an attribute index
to the custom attribute of the OKVTTLV object.
|
OKVTTLV |
OKVTTLV.okvCustomAttrAddInterval(java.lang.String name,
int attrIndex,
int value)
API to add an interval data type with an attribute index to
the custom attribute of the OKVTTLV object.
|
OKVTTLV |
OKVTTLV.okvCustomAttrAddLongInteger(java.lang.String name,
int attrIndex,
java.lang.Long value)
API to add a long integer data type with an attribute index
to the custom attribute of the OKVTTLV object.
|
OKVTTLV |
OKVTTLV.okvCustomAttrAddStructure(java.lang.String name,
int attrIndex,
OKVTTLV value)
API to add a structure data type with an attribute index
to the custom attribute of the OKVTTLV object.
|
OKVTTLV |
OKVTTLV.okvCustomAttrAddTextString(java.lang.String name,
int attrIndex,
java.lang.String value)
API to add a text string data type with an attribute index
to the custom attribute of the OKVTTLV object.
|
java.lang.Integer |
OKVTTLV.okvCustomAttrGetAttrIndex()
API to get the attribute index of a custom attribute
from an OKVTTLV object.
|
java.math.BigInteger |
OKVTTLV.okvCustomAttrGetBigInteger()
API to get Big Integer value from the
custom attribute of OKVTTLV object.
|
java.lang.Boolean |
OKVTTLV.okvCustomAttrGetBoolean()
API to get the Boolean value from the custom attribute
of an OKVTTLV object.
|
OKVAttribute |
OKVTTLV.okvCustomAttrGetByName(java.lang.String name,
int elemIndex)
API to get the first custom attribute which is of given name at
given element index or higher from the custom attribute
of an OKVTTLV object.
|
byte[] |
OKVTTLV.okvCustomAttrGetByteString()
API to get the byte array value from the
custom attribute of an OKVTTLV object.
|
OKVAttribute |
OKVTTLV.okvCustomAttrGetByType(OKVType type,
int elemIndex)
API to get the first custom attribute which is of given type at
given element index or higher from the custom attribute
of an OKVTTLV object.
|
java.util.Date |
OKVTTLV.okvCustomAttrGetDateTime()
API to get the date time value from the custom attribute
of an OKVTTLV object.
|
java.lang.Integer |
OKVTTLV.okvCustomAttrGetEnum()
API to get the enumeration value from the custom attribute
of an OKVTTLV object.
|
java.lang.Integer |
OKVTTLV.okvCustomAttrGetInteger()
API to get the integer value from the custom attribute
of an OKVTTLV object.
|
java.lang.Integer |
OKVTTLV.okvCustomAttrGetInterval()
API to get the interval value from the custom attribute
of an OKVTTLV object.
|
java.lang.Long |
OKVTTLV.okvCustomAttrGetLongInteger()
API to get the long integer value from the
custom attribute of an OKVTTLV object.
|
java.lang.String |
OKVTTLV.okvCustomAttrGetName()
API to get the attribute name of a custom attribute
from an OKVTTLV object.
|
OKVTTLV |
OKVTTLV.okvCustomAttrGetStructure()
API to get the TTLV structure from the custom
attribute of an OKVTTLV object.
|
java.lang.String |
OKVTTLV.okvCustomAttrGetTextString()
API to get the text string value from the custom attribute
of an OKVTTLV object.
|
OKVAttribute |
OKVTTLV.okvGetAttributeObject(int elemIndex)
API to get the attribute and its name from the parent attribute
found at element index 'elemIndex'.
|
Modifier and Type | Method and Description |
---|---|
TResponse |
OKVTransporterImpl.executeOperation()
API executes a KMIP operation, sending the operation request to
the key management server and returning the response back to the client.
|
TResponse |
OKVTransporter.executeOperation()
Executes a KMIP operation on the key management server and returns a
TResponse response object.
|
OKVUidResponse |
OKVService.okvActivate(java.lang.String uid)
API to perform the KMIP activate operation on a KMIP object.
|
OKVUidResponse |
OKVService.okvAddAttribute(java.lang.String uid,
OKVTTLV attr)
API to perform the KMIP add attribute operation on a KMIP object.
|
OKVBatchResponse |
OKVService.okvBatchExecute(oracle.okv.operation.OKVBatchOperation batchRequest)
API to execute the batched KMIP functions in the same order as set in
the OKVBatchOperation instance.
|
OKVUidResponse |
OKVService.okvCreateKey(OKVTagEnum algorithm,
int keyLength,
int usageMask,
OKVTTLV attributeList,
java.lang.String walletName)
API to perform the KMIP create operation for the KMIP symmetric
key object.
|
OKVResponse |
OKVService.okvDeleteAttribute(java.lang.String uid,
java.lang.String attrName,
int attrIndex)
API to perform the KMIP delete attribute operation on a KMIP object.
|
OKVResponse |
OKVService.okvDestroy(java.lang.String uid)
API to perform the KMIP destroy operation on a KMIP object.
|
static OKVService |
OKVService.okvEnvSetConfig()
API to create an OKVService instance and set the connection
with default configuration.
|
static OKVService |
OKVService.okvEnvSetConfig(char[] password)
API to create a OKVService instance and set the default
connection configuration and specify the password for the SSL connection
wallet.
|
static OKVService |
OKVService.okvEnvSetConfig(java.lang.String connConfigFile)
API to create a OKVService instance and specify connection
configuration file.
|
static OKVService |
OKVService.okvEnvSetConfig(java.lang.String connConfigFile,
char[] password)
API to create a OKVService instance and specify connection
configuration file and the password for the SSL connection wallet.
|
OKVAttrListResponse |
OKVService.okvGetAttributeList(java.lang.String uid)
API to perform the KMIP get attribute list operation.
|
OKVAttrsResponse |
OKVService.okvGetAttributes(java.lang.String uid,
java.util.List<java.lang.String> attrList)
API to perform the KMIP get attribute operation on a KMIP object.
|
OKVCertResponse |
OKVService.okvGetCertificate(java.lang.String uid)
API to do the KMIP Get operation for the KMIP certificate object.
|
OKVKeyResponse |
OKVService.okvGetKey(java.lang.String uid)
API to perform the KMIP get operation for the KMIP symmetric
key object.
|
OKVOpaqueDataResponse |
OKVService.okvGetOpaqueData(java.lang.String uid)
API to perform the KMIP get operation for the KMIP opaque data object.
|
OKVSecretDataResponse |
OKVService.okvGetSecretData(java.lang.String uid)
API to perform the the KMIP get operation for the KMIP secret
data object.
|
OKVAttrsResponse |
OKVService.okvGetTemplate(java.lang.String uid)
API to perform the KMIP get operation for the KMIP template object.
|
OKVUidListResponse |
OKVService.okvLocate(java.lang.Integer maxItems,
java.lang.Integer storageStatusMask,
OKVTagEnum objectGroupMember,
OKVTTLV attributeList)
API to find a KMIP object through the KMIP locate operation.
|
OKVResponse |
OKVService.okvModifyAttribute(java.lang.String uid,
OKVTTLV attr)
API to perform the KMIP modify attribute operation on a KMIP object.
|
<TResponse> |
OKVService.okvOpsExecuteOp(oracle.okv.operation.OKVOperation<TResponse> inKMIPOperation)
Executes the operation passed in OKVOperation.
|
OKVQueryResponse |
OKVService.okvQueryCapability(java.util.List<OKVTagEnum> queryFuncs)
API to perform the the KMIP query operation.
|
OKVUidResponse |
OKVService.okvRegCertificate(OKVTagEnum certType,
byte[] certValue,
OKVTagEnum algorithm,
int certLength,
int usageMask,
OKVTTLV attributeList,
java.lang.String walletName)
API to do the KMIP Register operation for the KMIP certificate object.
|
OKVUidResponse |
OKVService.okvRegKey(byte[] keyValue,
OKVTagEnum algorithm,
int keyLength,
int usageMask,
OKVTTLV attributeList,
java.lang.String walletName)
API to perform the KMIP Register operation for the KMIP
symmetric key object.
|
OKVUidResponse |
OKVService.okvRegOpaqueData(OKVTagEnum opaqueType,
byte[] opaqueValue,
OKVTTLV attributeList,
java.lang.String walletName)
API to perform the KMIP Register operation for the KMIP
opaque data object.
|
OKVUidResponse |
OKVService.okvRegSecretData(OKVTagEnum secretDataType,
byte[] secretDataValue,
int usageMask,
OKVTTLV attributeList,
java.lang.String walletName)
API to perform the KMIP register operation for the
KMIP secret data object.
|
OKVUidResponse |
OKVService.okvRegTemplate(OKVTTLV attributeList,
java.lang.String walletName)
API to perform the KMIP register operation for the KMIP
template object.
|
OKVUidResponse |
OKVService.okvRekey(java.lang.String uid,
java.lang.Integer offset,
OKVTTLV attributeList)
API to perform the KMIP rekey operation for the
symmetric key object.
|
OKVResponse |
OKVService.okvRevoke(java.lang.String uid,
OKVTagEnum reasonCode,
java.lang.String reasonMessage,
java.util.Date compromiseOccurrenceDate)
API to perform the KMIP revoke operation on a KMIP object.
|