org.jasypt.registry.AlgorithmRegistry Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of jasypt Show documentation
Java library which enables encryption in java apps with minimum effort.
There is a newer version: 1.9.4
/*
 * =============================================================================
 * 
 *   Copyright (c) 2007-2010, The JASYPT team (http://www.jasypt.org)
 * 
 *   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.
 * 
 * =============================================================================
 */
package org.jasypt.registry;

import java.security.Security;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Iterator;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Set;


/**
 * 
 * Utility class for retrieving the names of all the digest or encryption
 * algorithms available to Jasypt.
 * 
 * 
 * This class is thread-safe.
 * 
 * 
 * @since 1.7
 * 
 * @author Daniel Fernández
 * 
 */
public final class AlgorithmRegistry {

    
    /**
     * 
     * Returns a set with the names of all the registered digest algorithms.
     * This set will also include algorithms from any third-party (non-JVM) registered
     * providers.
     * 
     * 
     * @since 1.7
     * 
     * @return a Set of Strings with the names of all the registered
     *         digest algorithms.
     */
    public static Set getAllDigestAlgorithms() {
        final List algos = new ArrayList(Security.getAlgorithms("MessageDigest"));
        Collections.sort(algos);
        return Collections.unmodifiableSet(new LinkedHashSet(algos));
    }

    
    /**
     * 
     * Returns a set with the names of all the registered PBE (Password-Based
     * Encryption) algorithms.
     * This set will also include algorithms from any third-party (non-JVM) registered
     * providers.
     * 
     * 
     * @since 1.7
     * 
     * @return a Set of Strings with the names of all the registered
     *         PBE algorithms.
     */
    public static Set getAllPBEAlgorithms() {
        final List algos = new ArrayList(Security.getAlgorithms("Cipher"));
        Collections.sort(algos);
        final LinkedHashSet pbeAlgos = new LinkedHashSet();
        final Iterator algosIter = algos.iterator();
        while (algosIter.hasNext()) {
            final String algo = (String) algosIter.next();
            if (algo != null && algo.startsWith("PBE")) {
                pbeAlgos.add(algo);
            }
        }
        return Collections.unmodifiableSet(pbeAlgos);
    }
    
    
    
    private AlgorithmRegistry() {
        super();
    }
    
}