net.markenwerk.utils.mail.dkim

Enum Canonicalization

java.lang.Object

java.lang.Enum<Canonicalization>

net.markenwerk.utils.mail.dkim.Canonicalization

All Implemented Interfaces:

Serializable, Comparable<Canonicalization>

public enum Canonicalization
extends Enum<Canonicalization>

Provides 'simple' and 'relaxed' canonicalization according to RFC 4871.

Since:

1.0.0

Author:

Torsten Krause (tk at markenwerk dot net), Florian Sager

Enum Constant Summary

Enum Constants

Enum Constant and Description
RELAXED The 'relaxed' canonicalization algorithm.
SIMPLE The 'simple' canonicalization algorithm.

Method Summary

Modifier and Type	Method and Description
abstract String	canonicalizeBody(String body) Performs body canonicalization.
abstract String	canonicalizeHeader(String name, String value) Performs header canonicalization.
String	getType() Returns a string representation of the canonicalization algorithm.
static Canonicalization	valueOf(String name) Returns the enum constant of this type with the specified name.
static Canonicalization[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SIMPLE

public static final Canonicalization SIMPLE

The 'simple' canonicalization algorithm.

RELAXED

public static final Canonicalization RELAXED

The 'relaxed' canonicalization algorithm.

Method Detail

values

public static Canonicalization[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Canonicalization c : Canonicalization.values())
    System.out.println(c);

Returns:

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

valueOf

public static Canonicalization valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

getType

public final String getType()

Returns a string representation of the canonicalization algorithm.

Returns:

The string representation of the canonicalization algorithm.

canonicalizeHeader

public abstract String canonicalizeHeader(String name,
                                          String value)

Performs header canonicalization.

Parameters:

name - The name of the header.

value - The value of the header.

Returns:

The canonicalized header.

canonicalizeBody

public abstract String canonicalizeBody(String body)

Performs body canonicalization.

Parameters:

body - The content of the body.

Returns:

The canonicalized body.