SystemConfiguration

/*
 * Copyright 2003 - 2013 The eFaps Team
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * Revision:        $Rev$
 * Last Changed:    $Date$
 * Last Changed By: $Author$
 */

package org.efaps.admin.common;

import java.io.IOException;
import java.io.Serializable;
import java.io.StringReader;
import java.security.Provider;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Properties;
import java.util.UUID;

import org.efaps.admin.datamodel.Type;
import org.efaps.admin.user.Company;
import org.efaps.ci.CIAdminCommon;
import org.efaps.db.Context;
import org.efaps.db.Instance;
import org.efaps.db.transaction.ConnectionResource;
import org.efaps.db.wrapper.SQLPart;
import org.efaps.db.wrapper.SQLSelect;
import org.efaps.util.EFapsException;
import org.efaps.util.cache.CacheLogListener;
import org.efaps.util.cache.CacheObjectInterface;
import org.efaps.util.cache.CacheReloadException;
import org.efaps.util.cache.InfinispanCache;
import org.infinispan.Cache;
import org.jasypt.encryption.pbe.StandardPBEStringEncryptor;
import org.jasypt.encryption.pbe.config.StringPBEConfig;
import org.jasypt.properties.EncryptableProperties;
import org.jasypt.salt.SaltGenerator;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * The class handles the caching for system configurations with their attributes
 * and links.
 *
 * @author The eFaps Team
 * @version $Id$
 */
public final class SystemConfiguration
    implements CacheObjectInterface, Serializable
{
    /**
     * Used for serialization.
     */
    private static final long serialVersionUID = 1L;

    /**
     * This is the SQL select statement to select the configs from the database
     * by ID.
     */
    private static final String SQL_CONFIG = new SQLSelect()
                    .column(0, "TYPEID")
                    .column(0, "KEY")
                    .column(0, "VALUE")
                    .column(0, "COMPANYID")
                    .from("T_CMSYSCONF", 0)
                    .addPart(SQLPart.WHERE).addColumnPart(0, "ABSTRACTID").addPart(SQLPart.EQUAL).addValuePart("?")
                    .toString();

    /**
     * This is the SQL select statement to select a role from the database by
     * ID.
     */
    private static final String SQL_ID = new SQLSelect()
                    .column(0, "ID")
                    .column(0, "NAME")
                    .column(0, "UUID")
                    .from("T_CMABSTRACT", 0)
                    .addPart(SQLPart.WHERE).addColumnPart(0, "ID").addPart(SQLPart.EQUAL).addValuePart("?").toString();

    /**
     * This is the SQL select statement to select a role from the database by
     * Name.
     */
    private static final String SQL_NAME = new SQLSelect()
                    .column(0, "ID")
                    .column(0, "NAME")
                    .column(0, "UUID")
                    .from("T_CMABSTRACT", 0)
                    .addPart(SQLPart.WHERE).addColumnPart(0, "NAME").addPart(SQLPart.EQUAL).addValuePart("?")
                    .toString();

    /**
     * This is the SQL select statement to select a role from the database by
     * UUID.
     */
    private static final String SQL_UUID = new SQLSelect()
                    .column(0, "ID")
                    .column(0, "NAME")
                    .column(0, "UUID")
                    .from("T_CMABSTRACT", 0)
                    .addPart(SQLPart.WHERE).addColumnPart(0, "UUID").addPart(SQLPart.EQUAL).addValuePart("?")
                    .toString();

    /**
     * Name of the Cache by UUID.
     */
    private static final String UUIDCACHE = SystemConfiguration.class.getName() + ".UUID";

    /**
     * Name of the Cache by ID.
     */
    private static final String IDCACHE = SystemConfiguration.class.getName() + ".ID";

    /**
     * Name of the Cache by Name.
     */
    private static final String NAMECACHE = SystemConfiguration.class.getName() + ".Name";

    /**
     * Logging instance used in this class.
     */
    private static final Logger LOG = LoggerFactory.getLogger(SystemConfiguration.class);

    /**
     * The configuration for the PBE used for jasypt.
     */
    private static final EFapsPBEConfig BPECONF = new EFapsPBEConfig();

    /**
     * The encryptor for the PBE used for jasypt.
     */
    private static StandardPBEStringEncryptor ENCRYPTOR;

    /**
     * The instance variable stores the id of this SystemAttribute.
     *
     * @see #getId()
     */
    private final long id;

    /**
     * The instance variable stores the UUID of this SystemAttribute.
     *
     * @see #getUUID()
     */
    private final UUID uuid;

    /**
     * The instance variable stores the Name of this SystemAttribute.
     *
     * @see #getName()
     */
    private final String name;

    /**
     * Map with all attributes for this system configuration.
     */
    private final Map<Long, Map<String, String>> attributes = new HashMap<Long, Map<String, String>>();

    /**
     * Map with all links for this system configuration.
     */
    private final Map<Long, Map<String, String>> links = new HashMap<Long, Map<String, String>>();

    /**
     * Map with all object attributes for this system configuration.
     */
    private final Map<Long, Map<String, String>> objectAttributes = new HashMap<Long, Map<String, String>>();

    /**
     * Constructor setting instance variables.
     *
     * @param _id id of the SystemConfiguration
     * @param _uuid uuid of the SystemConfiguration
     * @param _name name of the SystemConfiguration
     */
    private SystemConfiguration(final long _id,
                                final String _name,
                                final String _uuid)
    {
        this.id = _id;
        this.uuid = UUID.fromString(_uuid);
        this.name = _name;
        this.attributes.put(new Long(0), new HashMap<String, String>());
        this.links.put(new Long(0), new HashMap<String, String>());
        this.objectAttributes.put(new Long(0), new HashMap<String, String>());
    }

    /**
     * Returns for given parameter <i>_id</i> the instance of class
     * {@link SystemConfiguration}.
     *
     * @param _id id of the system configuration
     * @return instance of class {@link SystemConfiguration}
     * @throws CacheReloadException on error
     */
    public static SystemConfiguration get(final long _id)
        throws CacheReloadException
    {
        final Cache<Long, SystemConfiguration> cache = InfinispanCache.get().<Long, SystemConfiguration>getCache(
                        SystemConfiguration.IDCACHE);
        if (!cache.containsKey(_id)) {
            SystemConfiguration.getSystemConfigurationFromDB(SystemConfiguration.SQL_ID, _id);
        }
        return cache.get(_id);
    }

    /**
     * Returns for given parameter <i>_name</i> the instance of class
     * {@link SystemConfiguration}.
     *
     * @param _name name of the system configuration
     * @return instance of class {@link SystemConfiguration}
     * @throws CacheReloadException on error
     */
    public static SystemConfiguration get(final String _name)
        throws CacheReloadException
    {
        final Cache<String, SystemConfiguration> cache = InfinispanCache.get().<String, SystemConfiguration>getCache(
                        SystemConfiguration.NAMECACHE);
        if (!cache.containsKey(_name)) {
            SystemConfiguration.getSystemConfigurationFromDB(SystemConfiguration.SQL_NAME, _name);
        }
        return cache.get(_name);
    }

    /**
     * Returns for given parameter <i>_uuid</i> the instance of class
     * {@link SystemConfiguration}.
     *
     * @param _uuid uuid of the system configuration
     * @return instance of class {@link SystemConfiguration}
     * @throws CacheReloadException on error
     */
    public static SystemConfiguration get(final UUID _uuid)
        throws CacheReloadException
    {
        final Cache<UUID, SystemConfiguration> cache = InfinispanCache.get().<UUID, SystemConfiguration>getCache(
                        SystemConfiguration.UUIDCACHE);
        if (!cache.containsKey(_uuid)) {
            SystemConfiguration.getSystemConfigurationFromDB(SystemConfiguration.SQL_UUID, String.valueOf(_uuid));
        }
        return cache.get(_uuid);
    }

    /**
     * This is the getter method for the instance variable {@link #id}.
     *
     * @return value of instance variable {@link #id}
     */
    @Override
    public long getId()
    {
        return this.id;
    }

    /**
     * This is the getter method for the instance variable {@link #uuid}.
     *
     * @return value of instance variable {@link #uuid}
     */
    @Override
    public UUID getUUID()
    {
        return this.uuid;
    }

    /**
     * This is the getter method for the instance variable {@link #name}.
     *
     * @return value of instance variable {@link #name}
     */
    @Override
    public String getName()
    {
        return this.name;
    }

    /**
     * Get a value from the maps. The following logic applies:
     * <ol>
     * <li>Check if a Context exists</li>
     * <li>If a Context exist check if a company is given</li>
     * <li>If a company is given, check for a company specific map</li>
     * <li>If a company specific map is given search for the key in this map</li>
     * <li>If any of the earlier point fails the value from the default map is
     * returned</li>
     * </ol>
     *
     * @param _key key the value is wanted for
     * @param _map map the key will be search in for
     * @return String value
     * @throws EFapsException on error
     */
    private String getValue(final String _key,
                            final Map<Long, Map<String, String>> _map)
        throws EFapsException
    {
        Company company = null;
        if (Context.isThreadActive()) {
            company = Context.getThreadContext().getCompany();
        }
        final long companyId = company == null ? 0 : company.getId();
        Map<String, String> innerMap;
        if (_map.containsKey(companyId)) {
            innerMap = _map.get(companyId);
            if (!innerMap.containsKey(_key)) {
                innerMap = _map.get(new Long(0));
            }
        } else {
            innerMap = _map.get(new Long(0));
        }
        return innerMap.get(_key);
    }

    /**
     * Returns for given <code>_key</code> the related link. If no link is found
     * <code>null</code> is returned.
     *
     * @param _key key of searched link
     * @return found link; if not found <code>null</code>
     * @throws EFapsException on error
     * @see #links
     */
    public Instance getLink(final String _key)
        throws EFapsException
    {
        return Instance.get(getValue(_key, this.links));
    }

    /**
     * Returns for given <code>Instance</code> the related attribute value. If
     * no attribute value is found <code>null</code> is returned.
     *
     * @param _instance Instance of searched objectattribute
     * @return found attribute value; if not found <code>null</code>
     * @throws EFapsException on error
     * @see #objectAttributes
     */
    public String getObjectAttributeValue(final Instance _instance)
        throws EFapsException
    {
        return getObjectAttributeValue(_instance.getOid());
    }

    /**
     * Returns for given <code>OID</code> the related attribute value. If no
     * attribute value is found <code>null</code> is returned.
     *
     * @param _oid OID of searched objectattribute
     * @return found attribute value; if not found <code>null</code>
     * @throws EFapsException on error
     * @see #objectAttributes
     */
    public String getObjectAttributeValue(final String _oid)
        throws EFapsException
    {
        return getValue(_oid, this.objectAttributes);
    }

    /**
     * Returns for given <code>Instance</code> the related value as Properties.
     * If no attribute is found an empty Properties is returned.
     *
     * @param _instance Instance of searched attribute
     * @return Properties
     * @throws EFapsException on error
     * @see #objectAttributes
     */
    public Properties getObjectAttributeValueAsProperties(final Instance _instance)
        throws EFapsException
    {
        return getObjectAttributeValueAsProperties(_instance.getOid());
    }

    /**
     * Returns for given <code>OID</code> the related value as Properties. If no
     * attribute is found an empty Properties is returned.
     *
     * @param _key key of searched attribute
     * @return Properties
     * @throws EFapsException on error
     * @see #objectAttributes
     */
    public Properties getObjectAttributeValueAsProperties(final String _key)
        throws EFapsException
    {
        final Properties ret = new Properties();
        final String value = getValue(_key, this.objectAttributes);
        if (value != null) {
            try {
                ret.load(new StringReader(value));
            } catch (final IOException e) {
                throw new EFapsException(SystemConfiguration.class, "getObjectAttributeValueAsProperties", e);
            }
        }
        return ret;
    }

    /**
     * Returns for given <code>_key</code> the related attribute value. If no
     * attribute value is found <code>null</code> is returned.
     *
     * @param _key key of searched attribute
     * @return found attribute value; if not found <code>null</code>
     * @throws EFapsException on error
     * @see #attributes
     */
    public String getAttributeValue(final String _key)
        throws EFapsException
    {
        return getValue(_key, this.attributes);
    }

    /**
     * Returns for given <code>_key</code> the related boolean attribute value.
     * If no attribute value is found <i>false</i> is returned.
     *
     * @param _key key of searched attribute
     * @return found boolean attribute value; if not found <i>false</i>
     * @throws EFapsException on error
     * @see #attributes
     */
    public boolean getAttributeValueAsBoolean(final String _key)
        throws EFapsException
    {
        final String value = getAttributeValue(_key);
        return value == null ? false : Boolean.parseBoolean(value);
    }

    /**
     * Returns for given <code>_key</code> the related integer attribute value.
     * If no attribute is found <code>0</code> is returned.
     *
     * @param _key key of searched attribute
     * @return found integer attribute value; if not found <code>0</code>
     * @throws EFapsException on error
     * @see #attributes
     */
    public int getAttributeValueAsInteger(final String _key)
        throws EFapsException
    {
        final String value = getAttributeValue(_key);
        return value == null ? 0 : Integer.parseInt(value);
    }


    /**
     * Returns for given <code>_key</code> the related value as Properties. If
     * no attribute is found an empty Properties is returned.
     *
     * @param _key key of searched attribute
     * @return Properties
     * @throws EFapsException on error
     * @see #attributes
     */
    public Properties getAttributeValueAsEncryptedProperties(final String _key)
        throws EFapsException
    {
        final Properties properties = getAttributeValueAsProperties(_key, false);
        final Properties props = new EncryptableProperties(properties, SystemConfiguration.ENCRYPTOR);
        return props;
    }

    /**
     * Returns for given <code>_key</code> the related value as Properties. If
     * no attribute is found an empty Properties is returned.
     *
     * @param _key key of searched attribute
     * @param _concatenate is concatenate or not
     * @return Properties
     * @throws EFapsException on error
     * @see #attributes
     */
    public Properties getAttributeValueAsEncryptedProperties(final String _key,
                                                             final boolean _concatenate)
        throws EFapsException
    {
        final Properties properties = getAttributeValueAsProperties(_key, _concatenate);
        final StandardPBEStringEncryptor encryptor = new StandardPBEStringEncryptor();
        encryptor.setConfig(SystemConfiguration.getPBEConfig());
        final Properties props = new EncryptableProperties(properties, encryptor);
        return props;
    }

    /**
     * Returns for given <code>_key</code> the related value as Properties. If
     * no attribute is found an empty Properties is returned.
     *
     * @param _key key of searched attribute
     * @return Properties
     * @throws EFapsException on error
     * @see #attributes
     */
    public Properties getAttributeValueAsProperties(final String _key)
        throws EFapsException
    {
        return getAttributeValueAsProperties(_key, false);
    }

    /**
     * Returns for given <code>_key</code> the related value as Properties. If
     * no attribute is found an empty Properties is returned.
     * Can concatenates Properties for Keys.<br/>
     * e.b. Key, Key01, Key02, Key03
     *
     * @param _key key of searched attribute
     * @param _concatenate  concatenate or not
     * @return map with properties
     * @throws EFapsException on error
     */
    public Properties getAttributeValueAsProperties(final String _key,
                                                    final boolean _concatenate)
        throws EFapsException
    {
        final Properties ret = new Properties();
        final String value = getAttributeValue(_key);
        if (value != null) {
            try {
                ret.load(new StringReader(value));
            } catch (final IOException e) {
                throw new EFapsException(SystemConfiguration.class, "getAttributeValueAsProperties", e);
            }
        }
        if (_concatenate) {
            for (int i = 1; i < 100; i++) {
                final String keyTmp = _key + String.format("%02d", i);
                final String valueTmp = getAttributeValue(keyTmp);
                final Properties propsTmp = new Properties();
                if (valueTmp != null) {
                    try {
                        propsTmp.load(new StringReader(valueTmp));
                    } catch (final IOException e) {
                        throw new EFapsException(SystemConfiguration.class, "getAttributeValueAsPropertiesConcat", e);
                    }
                } else {
                    break;
                }
                if (propsTmp.isEmpty()) {
                    break;
                } else {
                    ret.putAll(propsTmp);
                }
            }
        }
        return ret;
    }

    /**
     * Reload the current SystemConfiguration by removing it from the Cache.
     */
    public void reload()
    {
        InfinispanCache.get().<UUID, SystemConfiguration>getCache(SystemConfiguration.UUIDCACHE).remove(this.uuid);
        InfinispanCache.get().<Long, SystemConfiguration>getCache(SystemConfiguration.IDCACHE).remove(this.id);
        InfinispanCache.get().<String, SystemConfiguration>getCache(SystemConfiguration.NAMECACHE).remove(this.name);
    }

    /**
     * Read the config.
     * @throws CacheReloadException on error
     */
    private void readConfig()
        throws CacheReloadException
    {
        ConnectionResource con = null;
        try {
            boolean closeContext = false;
            if (!Context.isThreadActive()) {
                Context.begin();
                closeContext = true;
            }
            final List<Object[]> values = new ArrayList<Object[]>();
            con = Context.getThreadContext().getConnectionResource();
            PreparedStatement stmt = null;
            try {
                stmt = con.getConnection().prepareStatement(SystemConfiguration.SQL_CONFIG);
                stmt.setObject(1, getId());
                final ResultSet rs = stmt.executeQuery();

                while (rs.next()) {
                    values.add(new Object[] {
                                    rs.getLong(1),
                                    rs.getString(2).trim(),
                                    rs.getString(3).trim(),
                                    rs.getLong(4)
                    });
                }
                rs.close();
            } finally {
                if (stmt != null) {
                    stmt.close();
                }
            }
            con.commit();
            if (closeContext) {
                Context.rollback();
            }
            for (final Object[] row : values) {
                final Long typeId = (Long) row[0];
                final String key = (String) row[1];
                final String value = (String) row[2];
                final Long companyId = (Long) row[3];
                final Type type = Type.get(typeId);
                final Map<Long, Map<String, String>> configMap;
                if (type.equals(CIAdminCommon.SystemConfigurationLink.getType())) {
                    configMap = this.links;
                } else if (type.equals(CIAdminCommon.SystemConfigurationObjectAttribute.getType())) {
                    configMap = this.objectAttributes;
                } else {
                    configMap = this.attributes;
                }
                final Map<String, String> map;
                if (configMap.containsKey(companyId)) {
                    map = configMap.get(companyId);
                } else {
                    map = new HashMap<String, String>();
                    configMap.put(companyId, map);
                }
                map.put(key, value);
            }
        } catch (final SQLException e) {
            throw new CacheReloadException("could not read SystemConfiguration attributes", e);
        } catch (final EFapsException e) {
            throw new CacheReloadException("could not read SystemConfiguration attributes", e);
        } finally {
            if ((con != null) && con.isOpened()) {
                try {
                    con.abort();
                } catch (final EFapsException e) {
                    throw new CacheReloadException("could not read SystemConfiguration attributes", e);
                }
            }
        }
    }

    /**
     * Method to initialize the {@link #CACHE cache} for the system
     * configurations.
     */
    public static void initialize()
    {
        if (InfinispanCache.get().exists(SystemConfiguration.UUIDCACHE)) {
            InfinispanCache.get().<UUID, SystemConfiguration>getCache(SystemConfiguration.UUIDCACHE).clear();
        } else {
            InfinispanCache.get().<UUID, SystemConfiguration>getCache(SystemConfiguration.UUIDCACHE)
                            .addListener(new CacheLogListener(SystemConfiguration.LOG));
        }
        if (InfinispanCache.get().exists(SystemConfiguration.IDCACHE)) {
            InfinispanCache.get().<Long, SystemConfiguration>getCache(SystemConfiguration.IDCACHE).clear();
        } else {
            InfinispanCache.get().<Long, SystemConfiguration>getCache(SystemConfiguration.IDCACHE)
                            .addListener(new CacheLogListener(SystemConfiguration.LOG));
        }
        if (InfinispanCache.get().exists(SystemConfiguration.NAMECACHE)) {
            InfinispanCache.get().<String, SystemConfiguration>getCache(SystemConfiguration.NAMECACHE).clear();
        } else {
            InfinispanCache.get().<String, SystemConfiguration>getCache(SystemConfiguration.NAMECACHE)
                            .addListener(new CacheLogListener(SystemConfiguration.LOG));
        }

        SystemConfiguration.ENCRYPTOR = new StandardPBEStringEncryptor();
        SystemConfiguration.ENCRYPTOR.setConfig(SystemConfiguration.getPBEConfig());
    }

    /**
     * @param _sysConfig SystemConfiguration to be cached
     */
    private static void cacheSytemConfig(final SystemConfiguration _sysConfig)
    {
        final Cache<UUID, SystemConfiguration> cache4UUID = InfinispanCache.get()
                        .<UUID, SystemConfiguration>getIgnReCache(SystemConfiguration.UUIDCACHE);
        cache4UUID.put(_sysConfig.getUUID(), _sysConfig);

        final Cache<String, SystemConfiguration> nameCache = InfinispanCache.get()
                        .<String, SystemConfiguration>getIgnReCache(SystemConfiguration.NAMECACHE);
        nameCache.put(_sysConfig.getName(), _sysConfig);

        final Cache<Long, SystemConfiguration> idCache = InfinispanCache.get()
                        .<Long, SystemConfiguration>getIgnReCache(SystemConfiguration.IDCACHE);
        idCache.putIfAbsent(_sysConfig.getId(), _sysConfig);
    }

    /**
     * @param _sql sql statement to be executed
     * @param _criteria filter criteria
     * @throws CacheReloadException on error
     * @return false
     */
    private static boolean getSystemConfigurationFromDB(final String _sql,
                                                        final Object _criteria)
        throws CacheReloadException
    {
        boolean ret = false;
        ConnectionResource con = null;
        try {
            boolean closeContext = false;
            if (!Context.isThreadActive()) {
                Context.begin();
                closeContext = true;
            }
            SystemConfiguration sysConfig = null;
            con = Context.getThreadContext().getConnectionResource();
            PreparedStatement stmt = null;
            try {
                stmt = con.getConnection().prepareStatement(_sql);
                stmt.setObject(1, _criteria);
                final ResultSet rs = stmt.executeQuery();
                if (rs.next()) {
                    final long id = rs.getLong(1);
                    final String name = rs.getString(2).trim();
                    final String uuid = rs.getString(3).trim();
                    SystemConfiguration.LOG.debug("read SystemConfiguration '{}' (id = {}), format = '{}'", name, id);
                    sysConfig = new SystemConfiguration(id, name, uuid);
                }
                ret = true;
                rs.close();
            } finally {
                if (stmt != null) {
                    stmt.close();
                }
            }
            con.commit();
            if (closeContext) {
                Context.rollback();
            }
            if (sysConfig != null) {
                sysConfig.readConfig();
                SystemConfiguration.cacheSytemConfig(sysConfig);
            }
        } catch (final SQLException e) {
            throw new CacheReloadException("could not read SystemConfiguration", e);
        } catch (final EFapsException e) {
            throw new CacheReloadException("could not read SystemConfiguration", e);
        } finally {
            if ((con != null) && con.isOpened()) {
                try {
                    con.abort();
                } catch (final EFapsException e) {
                    throw new CacheReloadException("could not read SystemConfiguration", e);
                }
            }
        }
        return ret;
    }

    /**
     * @return the BPE Configuration.
     */
    public static EFapsPBEConfig getPBEConfig()
    {
        return SystemConfiguration.BPECONF;
    }


    @Override
    public boolean equals(final Object _obj)
    {
        boolean ret;
        if (_obj instanceof SystemConfiguration) {
            ret = ((SystemConfiguration) _obj).getId() == getId();
        } else {
            ret = super.equals(_obj);
        }
        return ret;
    }

    @Override
    public int hashCode()
    {
        return  Long.valueOf(getId()).intValue();
    }

    /**
     * Configuration class. Currently only the password is used. For all other
     * <code>null</code>is returnred to use the default values from jasyprt.
     */
    public static final class EFapsPBEConfig
        implements StringPBEConfig
    {
        /**
         * Password.
         */
        private char[] password = null;

        /**
         * Sets the password to be used for encryption.
         * <p>
         * Determines the result of: {@link #getPassword()} and
         * {@link #getPasswordCharArray()}.
         * </p>
         *
         * @param _password the password to be used.
         */
        public void setPassword(final String _password)
        {
            if (_password == null) {
                this.password = null;
            } else {
                this.password = _password.toCharArray();
            }
        }

        @Override
        public String getPassword()
        {
            return new String(this.password);
        }

        @Override
        public String getAlgorithm()
        {
            return null;
        }

        @Override
        public Integer getKeyObtentionIterations()
        {
            return null;
        }

        @Override
        public SaltGenerator getSaltGenerator()
        {
            return null;
        }

        @Override
        public String getProviderName()
        {
            return null;
        }

        @Override
        public Provider getProvider()
        {
            return null;
        }

        @Override
        public Integer getPoolSize()
        {
            return null;
        }

        @Override
        public String getStringOutputType()
        {
            return null;
        }
    }
}