Skip navigation links

oracle.irm.engine.content.crypto
Class CryptoSchemaOperationsInstance

java.lang.Object
oracle.irm.engine.content.crypto.CryptoSchemaOperationsInstance

public final class CryptoSchemaOperationsInstance

extends Object

Operations for obtaining cryptography schemas.

This class provides static methods for a set of procedural style methods. The methods can be made to appear as global methods by using import static. e.g.

import static oracle.irm.engine.content.crypto.CryptoSchemaOperationsInstance.*;

Method Summary

static CryptoSchema	getCryptoSchema(String id) Get a cryptography schema from the schema identity.
static Collection<CryptoSchema>	getCryptoSchemas() List the available cryptography schemas in the system.
static CryptoSchema	getDefaultCryptoSchema() Get the default cryptography schema.
static void	validateCryptoSchema(CryptoSchema schema) Test the validity of a cryptography schema.

Methods inherited from class java.lang.Object

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

Method Detail

getCryptoSchemas

public static Collection<CryptoSchema> getCryptoSchemas()

List the available cryptography schemas in the system. Please note that some schemas may not be available depending on the cryptographic algorithm support. Schemas that cannot be used will not appear in this list.

State

The collection returned by this method is an unmodifiable view on the internal collection state of the object.

Returns:

the value of the property. If this collection is empty this method returns an empty collection rather than returning null.

getDefaultCryptoSchema

public static CryptoSchema getDefaultCryptoSchema()

Get the default cryptography schema. When a KeySet is are created a cryptography schema must be specified. The cryptography schema determines the key generation algorithms and key sizes required to generate the set of keys need to create and open sealed content. This operation provides the system configured default schema.

Returns:

the value of the property. This method will never return null.

getCryptoSchema

public static CryptoSchema getCryptoSchema(String id)
                                    throws UnknownCryptoSchemaException

Get a cryptography schema from the schema identity.

Parameters:

id - the schema identity.

Returns:

the cryptography schema. This method will never return null.

Throws:

UnknownCryptoSchemaException - if the cryptography schema with the supplied id is not known.

validateCryptoSchema

public static void validateCryptoSchema(CryptoSchema schema)
                                 throws UnsupportedCryptoSchemaException

Test the validity of a cryptography schema. A cryptography schema may not be valid because one or more of the algorithms it defines are not supported or the corresponding attributes (such as key size) are invalid.

Parameters:

schema - the cryptography schema.

Throws:

UnsupportedCryptoSchemaException - this exception is thrown if the cryptography schema is unsupported. The cause of the exception can be examined to determine what part of the cryptography schema could not be supported (algorithm, key size, etc).

Skip navigation links