Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

gnu.java.security

Class Engine

public final class Engine
extends Object
Generic implementation of the getInstance methods in the various engine classes in java.security.

These classes (Signature for example) can be thought of as the "chrome, upholstery, and steering wheel", and the SPI (service provider interface, e.g. SignatureSpi) classes can be thought of as the "engine" -- providing the actual functionality of whatever cryptographic algorithm the instance represents.

See Also:
Provider

Method Summary

static Object
getInstance(String service, String algorithm, Provider provider)
Return the implementation for algorithm for service service from provider.
static Object
getInstance(String service, String algorithm, Provider provider, Object[] initArgs)
Return the implementation for algorithm for service service from provider, passing initArgs to the SPI class's constructor (which cannot be null; pass a zero-length array if the SPI takes no arguments).

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 Object getInstance(String service,
                                 String algorithm,
                                 Provider provider)
            throws InvocationTargetException,
                   NoSuchAlgorithmException
Return the implementation for algorithm for service service from provider. The service is e.g. "Signature", and the algorithm "DSA".
Parameters:
service - The service name.
algorithm - The name of the algorithm to get.
provider - The provider to get the implementation from.
Returns:
The engine class for the specified algorithm; the object returned is typically a subclass of the SPI class for that service, but callers should check that this is so.
Throws:
NoSuchAlgorithmException - If the implementation cannot be found or cannot be instantiated.
InvocationTargetException - If the SPI class's constructor throws an exception.
IllegalArgumentException - If any of the three arguments is null.

getInstance

public static Object getInstance(String service,
                                 String algorithm,
                                 Provider provider,
                                 Object[] initArgs)
            throws InvocationTargetException,
                   NoSuchAlgorithmException
Return the implementation for algorithm for service service from provider, passing initArgs to the SPI class's constructor (which cannot be null; pass a zero-length array if the SPI takes no arguments). The service is e.g. "Signature", and the algorithm "DSA".
Parameters:
service - The service name.
algorithm - The name of the algorithm to get.
provider - The provider to get the implementation from.
initArgs - The arguments to pass to the SPI class's constructor (cannot be null).
Returns:
The engine class for the specified algorithm; the object returned is typically a subclass of the SPI class for that service, but callers should check that this is so.
Throws:
NoSuchAlgorithmException - If the implementation cannot be found or cannot be instantiated.
InvocationTargetException - If the SPI class's constructor throws an exception.
IllegalArgumentException - If any of the four arguments is null or if either service, or algorithm is an empty string.
Engine -- generic getInstance method. Copyright (C) 2003, 2006 Free Software Foundation, Inc. This file is 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, 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; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, 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.

Overview Package Class Use Source Tree Index Deprecated About