com.edorasware.commons.core.property

Interface PropertyEncoder

All Known Implementing Classes:

AesPropertyEncoder

public interface PropertyEncoder

Encodes and decodes property values.

A property value may contain sections that are encoded so that they are not plaintext readable.

We start with a plaintext value, where the part to be encoded is marked with <ENCODE> delimiters:

<ENCODE<topSecret<ENCODE>

This is passed through the encodeProperty() method to give an encoded equivalent:

<ENC>…<ENC>

The decodeProperty() method is used to convert the encoded property value back to the original, but without the original delimiters:

topSecret

Method Summary

Modifier and Type	Method and Description
String	decode(String propertyValue) Decodes the given property value, transforming sub-strings delimited by the <ENC> marker.
String	encode(String propertyValue) Encodes the given property value, transforming sub-strings delimited by the <ENCODE> marker.

Method Detail

encode

String encode(String propertyValue)

Encodes the given property value, transforming sub-strings delimited by the <ENCODE> marker.

The resulting encoded property will contain equivalent sub-strings delimited by the <ENC> marker.

Parameters:

propertyValue - the property value to be encoded

Returns:

the encoded property value

decode

String decode(String propertyValue)

Decodes the given property value, transforming sub-strings delimited by the <ENC> marker.

The resulting decoded property will contain equivalent sub-strings without markers.

Parameters:

propertyValue - the property value to be decoded

Returns:

the decoded property value