com.netflix.msl.keyx.DiffieHellmanParameters Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of msl-core Show documentation

msl-core

There is a newer version: 1.2226.0

/**
 * Copyright (c) 2014 Netflix, Inc.  All rights reserved.
 * 
 * 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 com.netflix.msl.keyx;

import java.util.Map;

import javax.crypto.spec.DHParameterSpec;

import com.netflix.msl.MslKeyExchangeException;

/**
 * Diffie-Hellman parameters by parameter ID.
 * 
 * @author Wesley Miaw 
 */
public interface DiffieHellmanParameters {
    /**
     * @return the map of Diffie-Hellman parameters by parameter ID.
     * @throws MslKeyExchangeException if there is an error accessing the
     *         parameters.
     */
    public Map getParameterSpecs() throws MslKeyExchangeException;
    
    /**
     * Returns the Diffie-Hellman parameter specification identified by the
     * parameters ID.
     * 
     * @param id the parameters ID.
     * @return the parameter specification or null if the parameters ID is
     *         not recognized.
     * @throws MslKeyExchangeException if there is an error accessing the
     *         parameter specification.
     */
    public DHParameterSpec getParameterSpec(final String id) throws MslKeyExchangeException;
}