org.craftercms.commons.crypto.impl.NoOpTextEncryptor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of crafter-commons-utilities Show documentation

Crafter Commons Utilities

There is a newer version: 4.1.8

Show newest version

/*
 * Copyright (C) 2007-2017 Crafter Software Corporation.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package org.craftercms.commons.crypto.impl;

import javax.annotation.PostConstruct;

import org.craftercms.commons.crypto.CryptoException;
import org.craftercms.commons.crypto.TextEncryptor;
import org.craftercms.commons.i10n.I10nLogger;
import org.craftercms.commons.i10n.I10nUtils;

/**
 * {@link org.craftercms.commons.crypto.TextEncryptor} that does not actually encrypt or decrypt the text at all.
 * Useful for development environments, but should completely be disregarded in production environments. That's why
 * and warning is issued during post construct
 *
 * @author avasquez
 */
public class NoOpTextEncryptor implements TextEncryptor {

    private static final I10nLogger logger = new I10nLogger(NoOpTextEncryptor.class, I10nUtils.DEFAULT_LOGGING_MESSAGE_BUNDLE_NAME);

    public static final String LOG_KEY_NOOP_USED = "crypto.textEncryptor.noOpUsed";

    @PostConstruct
    public void init() {
        logger.warn(LOG_KEY_NOOP_USED);
    }

    @Override
    public String encrypt(final String clear) throws CryptoException {
        return clear;
    }

    @Override
    public String decrypt(final String encrypted) throws CryptoException {
        return encrypted;
    }

}