Package com.identity4j.util.crypt.impl

Class AbstractEncoder

java.lang.Object

com.identity4j.util.crypt.impl.AbstractEncoder

All Implemented Interfaces:

Encoder

Direct Known Subclasses:

AbstractPHPHashEncoder, AbstractUnixSHAEncoder, Base64Encoder, CompoundEncoder, MessageDigestEncoder, NSSEncoder, PBEWithMD5AndDESEncoder, PlainEncoder, RawAESEncoder, UnicodeEncoder, UnixBlowfishEncoder, UnixDESEncoder, UnixMD5Encoder

public abstract class AbstractEncoder
extends Object
implements Encoder

Constructor Summary

Constructors

Constructor	Description
AbstractEncoder(String id)

Method Summary

Modifier and Type	Method	Description
byte[]	decode(byte[] toDecode, byte[] salt, byte[] passphrase, String charset)	Decode bytes (if supported) to text.
String	getId()	Get the ID of this encoder.
boolean	isOfType(byte[] encodedBytes, String charset)	Determine if this encoder may have been used to create the provided encoded bytes.
boolean	match(byte[] encodedData, byte[] unencodedData, byte[] passphrase, String charset)	Check if the provide un-encoded data would match the encoded data if it was encoded.
protected byte[]	randomBytes(int count)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.identity4j.util.crypt.Encoder

encode

Constructor Detail

AbstractEncoder

public AbstractEncoder(String id)

Method Detail

decode

public byte[] decode(byte[] toDecode,
                     byte[] salt,
                     byte[] passphrase,
                     String charset)
              throws EncoderException

Description copied from interface: Encoder

Decode bytes (if supported) to text.

Specified by:

decode in interface Encoder

Parameters:

toDecode - bytes to decode

salt - TODO

passphrase - passphrase if supported

charset - character set

Returns:

decoded text

Throws:

EncoderException - if encoding fails

getId

public String getId()

Description copied from interface: Encoder

Get the ID of this encoder.

Specified by:

getId in interface Encoder

Returns:

id

isOfType

public boolean isOfType(byte[] encodedBytes,
                        String charset)

Description copied from interface: Encoder

Determine if this encoder may have been used to create the provided encoded bytes. This method should only be used if it is very likely to be the right encoder.

Specified by:

isOfType in interface Encoder

Parameters:

encodedBytes - encoded bytes

charset - character set

Returns:

this almost certainly was encoded with a similar encoder

match

public boolean match(byte[] encodedData,
                     byte[] unencodedData,
                     byte[] passphrase,
                     String charset)

Description copied from interface: Encoder

Check if the provide un-encoded data would match the encoded data if it was encoded.

Specified by:

match in interface Encoder

Parameters:

encodedData - encoded data

unencodedData - un-encoded data

passphrase - passphrase if supported

charset - character set

Returns:

matches

randomBytes

protected byte[] randomBytes(int count)