gnu.java.security.key

Class KeyPairCodecFactory


public class KeyPairCodecFactory
extends Object

A Factory class to instantiate key encoder/decoder instances.

Method Summary

static IKeyPairCodec
getInstance(String name)
Returns the appropriate codec given a composed key-pair generator algorithm and an encoding format.
static IKeyPairCodec
getInstance(String name, int formatID)
Returns an instance of a keypair codec given the canonical name of the key-pair algorithm, and the identifier of the format to use when externalizing the keys.
static IKeyPairCodec
getInstance(String name, String format)
Returns an instance of a keypair codec given the canonical name of the key-pair algorithm, and the name of the encoding format to use when externalizing the keys.
static IKeyPairCodec
getInstance(Key key)
Returns an instance of a keypair codec given a key.
static Set<E>
getNames()
Returns a Set of supported key-pair codec names.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getInstance

public static IKeyPairCodec getInstance(String name)
Returns the appropriate codec given a composed key-pair generator algorithm and an encoding format. A composed name is formed by the concatenation of the canonical key-pair algorithm name, the forward slash character / and the canonical name of the encoding format.

IMPORTANT: For backward compatibility, when the encoding format name is missing, the Raw encoding format is assumed. When this is the case the trailing forward slash is discarded from the name.

Parameters:
name - the case-insensitive key codec name.
Returns:
an instance of the keypair codec, or null if none found.

getInstance

public static IKeyPairCodec getInstance(String name,
                                        int formatID)
Returns an instance of a keypair codec given the canonical name of the key-pair algorithm, and the identifier of the format to use when externalizing the keys.
Parameters:
name - the case-insensitive key-pair algorithm name.
formatID - the identifier of the format to use when externalizing the keys generated by the key-pair algorithm.
Returns:
an instance of the key-pair codec, or null if none found.

getInstance

public static IKeyPairCodec getInstance(String name,
                                        String format)
Returns an instance of a keypair codec given the canonical name of the key-pair algorithm, and the name of the encoding format to use when externalizing the keys.
Parameters:
name - the case-insensitive key-pair algorithm name.
format - the name of the encoding format to use when externalizing the keys generated by the key-pair algorithm.
Returns:
an instance of the key-pair codec, or null if none found.

getInstance

public static IKeyPairCodec getInstance(Key key)
Returns an instance of a keypair codec given a key.
Parameters:
key - the key to encode.
Returns:
an instance of the keypair codec, or null if none found.

getNames

public static final Set<E> getNames()
Returns a Set of supported key-pair codec names.
Returns:
a Set of the names of supported key-pair codec (Strings).

KeyPairCodecFactory.java -- Copyright 2001, 2002, 2006 Free Software Foundation, Inc. This file is a part of GNU Classpath. GNU Classpath 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 2 of the License, or (at your option) any later version. GNU Classpath 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 GNU Classpath; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.