org.apereo.cas

Interface CipherExecutor<I,O>

Type Parameters:

I - the type parameter for the input

O - the type parameter for the output

public interface CipherExecutor<I,O>

Responsible to define operation that deal with encryption, signing and verification of a value.

Since:

4.1

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_CONTENT_ENCRYPTION_ALGORITHM The default content encryption algorithm.
static org.slf4j.Logger	LOGGER

Method Summary

Modifier and Type	Method and Description
default O	decode(I value) Decode the value.
O	decode(I value, java.lang.Object[] parameters) Decode the value.
default java.util.Map<java.lang.String,java.lang.Object>	decode(java.util.Map<java.lang.String,java.lang.Object> properties, java.lang.Object[] parameters) Decode map.
default O	encode(I value) Encrypt the value.
O	encode(I value, java.lang.Object[] parameters) Encrypt the value.
default java.lang.String	getName() The (component) name of this cipher.
default boolean	isEnabled() Supports encryption of values.
static CipherExecutor<java.io.Serializable,java.io.Serializable>	noOp() Factory method.
static CipherExecutor<java.io.Serializable,java.lang.String>	noOpOfSerializableToString() Factory method.
static CipherExecutor<java.lang.String,java.lang.String>	noOpOfStringToString() Factory method.

Field Detail

LOGGER

static final org.slf4j.Logger LOGGER

DEFAULT_CONTENT_ENCRYPTION_ALGORITHM

static final java.lang.String DEFAULT_CONTENT_ENCRYPTION_ALGORITHM

The default content encryption algorithm.

See Also:

Constant Field Values

Method Detail

encode

O encode(I value,
         java.lang.Object[] parameters)

Encrypt the value. Implementations may choose to also sign the final value.

Parameters:

value - the value

parameters - the parameters

Returns:

the encrypted value or null

encode

default O encode(I value)

Encrypt the value.

Parameters:

value - the value

Returns:

the encrypted value or null

decode

O decode(I value,
         java.lang.Object[] parameters)

Decode the value. Signatures may also be verified.

Parameters:

value - encrypted value

parameters - the parameters

Returns:

the decoded value.

decode

default O decode(I value)

Decode the value.

Parameters:

value - the value

Returns:

the decoded value or null

decode

default java.util.Map<java.lang.String,java.lang.Object> decode(java.util.Map<java.lang.String,java.lang.Object> properties,
                                                                java.lang.Object[] parameters)

Decode map.

Parameters:

properties - the properties

parameters - the parameters

Returns:

the map

isEnabled

default boolean isEnabled()

Supports encryption of values.

Returns:

true /false

getName

default java.lang.String getName()

The (component) name of this cipher.

Returns:

the name.

noOp

static CipherExecutor<java.io.Serializable,java.io.Serializable> noOp()

Factory method.

Returns:

Strongly -typed Noop CipherExecutor Serializable -> Serializable

noOpOfStringToString

static CipherExecutor<java.lang.String,java.lang.String> noOpOfStringToString()

Factory method.

Returns:

Strongly -typed Noop CipherExecutor String -> String

noOpOfSerializableToString

static CipherExecutor<java.io.Serializable,java.lang.String> noOpOfSerializableToString()

Factory method.

Returns:

Strongly -typed Noop CipherExecutor Serializable -> String