Package net.markenwerk.utils.mail.dkim

Class DomainKey

java.lang.Object

net.markenwerk.utils.mail.dkim.DomainKey

public final class DomainKey
extends Object

A DomainKey holds the information about a domain key.

Since:

1.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

Constructor	Description
DomainKey(Map<Character,String> tags)	Creates a new DomainKey from the given tags.

Method Summary

Modifier and Type	Method	Description
void	check(String identity, PrivateKey privateKey)	Checks, whether this DomainKey fits to the given identity and RSAPrivateKey.
Pattern	getGranularity()	Returns a Pattern that matches the granularity of this DomainKey, as described in the 'g' tag.
PublicKey	getPublicKey()	Returns the public key of this DomainKey, as provided by the 'p' tag.
KeyPairType	getPublicKeyType()	Returns the type of public key of this DomainKey, as provided by the 'p' tag.
Set<String>	getServiceTypes()	Returns the set of service types supported by this DomainKey, as described in the 's' tag.
Map<Character,String>	getTags()	Returns the unmodifiable map of tags, this DomainKey was constructed from.
long	getTimestamp()	Returns the construction time of this DomainKey as a timestamp.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DomainKey

public DomainKey(Map<Character,String> tags)
          throws DkimException

Creates a new DomainKey from the given tags.

Parameters:

tags - The tags to be used.

Throws:

DkimException - If either the version, key type or service type given in the tags is incompatible to this library ('DKIM1', 'RSA' or 'Ed25519' and 'email' respectively).

Method Detail

getTimestamp

public long getTimestamp()

Returns the construction time of this DomainKey as a timestamp.

Returns:

The construction time of this DomainKey as a timestamp.

getGranularity

public Pattern getGranularity()

Returns a Pattern that matches the granularity of this DomainKey, as described in the 'g' tag.

Returns:

A Pattern that matches the granularity of this DomainKey.

getServiceTypes

public Set<String> getServiceTypes()

Returns the set of service types supported by this DomainKey, as described in the 's' tag.

Returns:

The set of service types supported by this DomainKey.

getPublicKeyType

public KeyPairType getPublicKeyType()

Returns the type of public key of this DomainKey, as provided by the 'p' tag.

Returns:

The type of public key of this DomainKey.

getPublicKey

public PublicKey getPublicKey()

Returns the public key of this DomainKey, as provided by the 'p' tag.

Returns:

The public key of this DomainKey.

getTags

public Map<Character,String> getTags()

Returns the unmodifiable map of tags, this DomainKey was constructed from.

Returns:

The map of tags, this DomainKey was constructed from.

toString

public String toString()

Overrides:

toString in class Object

check

public void check(String identity,
                  PrivateKey privateKey)
           throws DkimSigningException

Checks, whether this DomainKey fits to the given identity and RSAPrivateKey.

Parameters:

identity - The identity.

privateKey - The RSAPrivateKey.

Throws:

DkimSigningException - If either the granularity of this DomainKey doesn't match the given identity or the public key of this DomainKey doesn't belong to the given RSAPrivateKey.