org.exoplatform.web.security.hash

Class XmlSafeSaltedHashCodec

java.lang.Object

org.exoplatform.web.security.hash.XmlSafeSaltedHashCodec

All Implemented Interfaces:

SaltedHashCodec

public class XmlSafeSaltedHashCodec
extends Object
implements SaltedHashCodec

A codec able to transform a SaltedHash to and from String. The string representations produced by encode(SaltedHash) are granted to be valid XML element names if the length of byte arrays returned by SaltedHash.getSalt() and SaltedHash.getHash() is divisible by 12. This important because encode(SaltedHash) uses the URL safe variant of Byte64 encoding (see Base64) and for byte array lengths other than 12, the string encoded by Byte64 would have to be padded with character '*' which would make the result an invalid XML name.

Author:

Peter Palaga

Field Summary

Fields

Modifier and Type	Field and Description
static SaltedHashCodec	INSTANCE

Constructor Summary

Constructors

Constructor and Description
XmlSafeSaltedHashCodec()

Method Summary

Modifier and Type	Method and Description
SaltedHash	decode(String encodedSaltedHash) Parses the given String to a SaltedHash.
String	encode(SaltedHash saltedHash) Transforms the given SaltedHash to String.
protected byte[]	toBytes(String str)
protected String	toString(byte[] bytes)

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final SaltedHashCodec INSTANCE

Constructor Detail

XmlSafeSaltedHashCodec

public XmlSafeSaltedHashCodec()

Method Detail

encode

public String encode(SaltedHash saltedHash)

Description copied from interface: SaltedHashCodec

Transforms the given SaltedHash to String.

Specified by:

encode in interface SaltedHashCodec

Returns:

decode

public SaltedHash decode(String encodedSaltedHash)
                  throws SaltedHashEncodingException

Description copied from interface: SaltedHashCodec

Parses the given String to a SaltedHash.

Specified by:

decode in interface SaltedHashCodec

Returns:

Throws:

SaltedHashEncodingException

toString

protected String toString(byte[] bytes)

toBytes

protected byte[] toBytes(String str)