Module org.sejda.sambox

Package org.sejda.sambox.encryption

Enum Class StandardSecurityEncryption

java.lang.Object

java.lang.Enum<StandardSecurityEncryption>

org.sejda.sambox.encryption.StandardSecurityEncryption

All Implemented Interfaces:

Serializable, Comparable<StandardSecurityEncryption>, Constable

public enum StandardSecurityEncryption
extends Enum<StandardSecurityEncryption>

Available standard security encryptions

Author:

Andrea Vacondio

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AES_128
AES_256
ARC4_128

Field Summary

Fields

Modifier and Type	Field	Description
final StandardSecurityHandlerRevision	revision
final int	version

Method Summary

Modifier and Type	Method	Description
abstract GeneralEncryptionAlgorithm	encryptionAlgorithm(EncryptionContext context)
COSDictionary	generateEncryptionDictionary(EncryptionContext context)	Generates the encryption dictionary for this standard encryption
static StandardSecurityEncryption	valueOf(String name)	Returns the enum constant of this class with the specified name.
static StandardSecurityEncryption[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ARC4_128

public static final StandardSecurityEncryption ARC4_128

AES_128

public static final StandardSecurityEncryption AES_128

AES_256

public static final StandardSecurityEncryption AES_256

Field Details

version

public final int version

revision

public final StandardSecurityHandlerRevision revision

Method Details

values

public static StandardSecurityEncryption[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static StandardSecurityEncryption valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

generateEncryptionDictionary

public COSDictionary generateEncryptionDictionary(EncryptionContext context)

Generates the encryption dictionary for this standard encryption

Parameters:

context -

Returns:

encryptionAlgorithm

public abstract GeneralEncryptionAlgorithm encryptionAlgorithm(EncryptionContext context)