org.refcodes.tabular.alt.cryptography.impls.EncryptionColumnImpl Maven / Gradle / Ivy

Go to download
// /////////////////////////////////////////////////////////////////////////////
// REFCODES.ORG
// =============================================================================
// This code is copyright (c) by Siegfried Steiner, Munich, Germany and licensed
// under the following (see "http://en.wikipedia.org/wiki/Multi-licensing")
// licenses:
// =============================================================================
// GNU General Public License, v3.0 ("http://www.gnu.org/licenses/gpl-3.0.html")
// together with the GPL linking exception applied; as being applied by the GNU
// Classpath ("http://www.gnu.org/software/classpath/license.html")
// =============================================================================
// Apache License, v2.0 ("http://www.apache.org/licenses/LICENSE-2.0")
// =============================================================================
// Please contact the copyright holding author(s) of the software artifacts in
// question for licensing issues not being covered by the above listed licenses,
// also regarding commercial licensing models or regarding the compatibility
// with other open source licenses.
// /////////////////////////////////////////////////////////////////////////////

package org.refcodes.tabular.alt.cryptography.impls;

import java.text.ParseException;

import org.refcodes.cryptography.EncryptionProvider;
import org.refcodes.data.consts.TextConsts;
import org.refcodes.tabular.Column;
import org.refcodes.tabular.impls.AbstractColumn;

/**
 * This {@link Column} solely can encrypt {@link String} texts using the
 * refcodes-cryptography framework.
 */
public class EncryptionColumnImpl extends AbstractColumn implements Cloneable {

	// /////////////////////////////////////////////////////////////////////////
	// VARIABLES:
	// /////////////////////////////////////////////////////////////////////////

	private EncryptionProvider _encryptionProvider;

	// /////////////////////////////////////////////////////////////////////////
	// CONSTRUCTORS:
	// /////////////////////////////////////////////////////////////////////////

	/**
	 * Creates an {@link EncryptionColumnImpl} encrypting any text
	 * 
	 * @param aKey The key to be used.
	 * 
	 * @param aEncryptionProvider The {@link EncryptionProvider} to be used.
	 */
	public EncryptionColumnImpl( String aKey, EncryptionProvider aEncryptionProvider ) {
		super( aKey, String.class );
		_encryptionProvider = aEncryptionProvider;
	}

	// /////////////////////////////////////////////////////////////////////////
	// METHODS:
	// /////////////////////////////////////////////////////////////////////////

	/**
	 * {@inheritDoc}
	 */
	@Override
	public String[] toStorageStrings( String aValue ) {
		if ( aValue == null ) {
			return null;
		}
		return new String[] {
			_encryptionProvider.toEncrypted( aValue )
		};
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public String fromStorageStrings( String[] aStringValues ) throws ParseException {
		throw new UnsupportedOperationException( TextConsts.UNSUPPORTED_OPERATION );
	}

	// /////////////////////////////////////////////////////////////////////////
	// COMMON:
	// /////////////////////////////////////////////////////////////////////////

	/**
	 * {@inheritDoc}
	 */
	@Override
	public Object clone() throws CloneNotSupportedException {
		return super.clone();
	}
}