Skip to content

Most visited

Recently visited

navigation

Provider.Service

public static class Provider.Service
extends Object

java.lang.Object
   ↳ java.security.Provider.Service


The description of a security service. It encapsulates the properties of a service and contains a factory method to obtain new implementation instances of this service.

Each service has a provider that offers the service, a type, an algorithm name, and the name of the class that implements the service. Optionally, it also includes a list of alternate algorithm names for this service (aliases) and attributes, which are a map of (name, value) String pairs.

This class defines the methods supportsParameter() and newInstance() which are used by the Java security framework when it searches for suitable services and instantes them. The valid arguments to those methods depend on the type of service. For the service types defined within Java SE, see the Java Cryptography Architecture API Specification & Reference for the valid values. Note that components outside of Java SE can define additional types of services and their behavior.

Instances of this class are immutable.

Summary

Public constructors

Provider.Service(Provider provider, String type, String algorithm, String className, List<String> aliases, Map<StringString> attributes)

Construct a new service.

Public methods

final String getAlgorithm()

Return the name of the algorithm of this service.

final String getAttribute(String name)

Return the value of the specified attribute or null if this attribute is not set for this Service.

final String getClassName()

Return the name of the class implementing this service.

final Provider getProvider()

Return the Provider of this service.

final String getType()

Get the type of this service.

Object newInstance(Object constructorParameter)

Return a new instance of the implementation described by this service.

boolean supportsParameter(Object parameter)

Test whether this Service can use the specified parameter.

String toString()

Return a String representation of this service.

Inherited methods

From class java.lang.Object

Public constructors

Provider.Service

Added in API level 1
Provider.Service (Provider provider, 
                String type, 
                String algorithm, 
                String className, 
                List<String> aliases, 
                Map<StringString> attributes)

Construct a new service.

Parameters
provider Provider: the provider that offers this service
type String: the type of this service
algorithm String: the algorithm name
className String: the name of the class implementing this service
aliases List: List of aliases or null if algorithm has no aliases
attributes Map: Map of attributes or null if this implementation has no attributes
Throws
NullPointerException if provider, type, algorithm, or className is null

Public methods

getAlgorithm

Added in API level 1
String getAlgorithm ()

Return the name of the algorithm of this service. For example, SHA-1.

Returns
String the algorithm of this service

getAttribute

Added in API level 1
String getAttribute (String name)

Return the value of the specified attribute or null if this attribute is not set for this Service.

Parameters
name String: the name of the requested attribute
Returns
String the value of the specified attribute or null if the attribute is not present
Throws
NullPointerException if name is null

getClassName

Added in API level 1
String getClassName ()

Return the name of the class implementing this service.

Returns
String the name of the class implementing this service

getProvider

Added in API level 1
Provider getProvider ()

Return the Provider of this service.

Returns
Provider the Provider of this service

getType

Added in API level 1
String getType ()

Get the type of this service. For example, MessageDigest.

Returns
String the type of this service

newInstance

Added in API level 1
Object newInstance (Object constructorParameter)

Return a new instance of the implementation described by this service. The security provider framework uses this method to construct implementations. Applications will typically not need to call it.

The default implementation uses reflection to invoke the standard constructor for this type of service. Security providers can override this method to implement instantiation in a different way. For details and the values of constructorParameter that are valid for the various types of services see the Java Cryptography Architecture API Specification & Reference.

Parameters
constructorParameter Object: the value to pass to the constructor, or null if this type of service does not use a constructorParameter.
Returns
Object a new implementation of this service
Throws
InvalidParameterException if the value of constructorParameter is invalid for this type of service.
NoSuchAlgorithmException if instantation failed for any other reason.

supportsParameter

Added in API level 1
boolean supportsParameter (Object parameter)

Test whether this Service can use the specified parameter. Returns false if this service cannot use the parameter. Returns true if this service can use the parameter, if a fast test is infeasible, or if the status is unknown.

The security provider framework uses this method with some types of services to quickly exclude non-matching implementations for consideration. Applications will typically not need to call it.

For details and the values of parameter that are valid for the various types of services see the top of this class and the Java Cryptography Architecture API Specification & Reference. Security providers can override it to implement their own test.

Parameters
parameter Object: the parameter to test
Returns
boolean false if this this service cannot use the specified parameter; true if it can possibly use the parameter
Throws
InvalidParameterException if the value of parameter is invalid for this type of service or if this method cannot be used with this type of service

toString

Added in API level 1
String toString ()

Return a String representation of this service.

Returns
String a String representation of this service.
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.