- Enclosing class:
Provider
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 instantiates 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 (JCA) Reference Guide
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.
- Since:
- 1.5
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
Return the name of the algorithm of this service.final String
getAttribute
(String name) Return the value of the specified attribute ornull
if this attribute is not set for this Service.final String
Return the name of the class implementing this service.final Provider
Return the Provider of this service.final String
getType()
Get the type of this service.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.toString()
Return aString
representation of this service.
-
Constructor Details
-
Service
public Service(Provider provider, String type, String algorithm, String className, List<String> aliases, Map<String, String> attributes) Construct a new service.- Parameters:
provider
- the provider that offers this servicetype
- the type of this servicealgorithm
- the algorithm nameclassName
- the name of the class implementing this servicealiases
- List of aliases ornull
if algorithm has no aliasesattributes
- Map of attributes ornull
if this implementation has no attributes- Throws:
NullPointerException
- if provider, type, algorithm, or className isnull
-
-
Method Details
-
getType
Get the type of this service. For example,MessageDigest
.- Returns:
- the type of this service
-
getAlgorithm
Return the name of the algorithm of this service. For example,SHA-1
.- Returns:
- the algorithm of this service
-
getProvider
Return the Provider of this service.- Returns:
- the Provider of this service
-
getClassName
Return the name of the class implementing this service.- Returns:
- the name of the class implementing this service
-
getAttribute
Return the value of the specified attribute ornull
if this attribute is not set for this Service.- Parameters:
name
- the name of the requested attribute- Returns:
- the value of the specified attribute or
null
if the attribute is not present - Throws:
NullPointerException
- if name isnull
-
newInstance
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 (JCA) Reference Guide.
- Parameters:
constructorParameter
- the value to pass to the constructor, ornull
if this type of service does not use a constructorParameter.- Returns:
- a new implementation of this service
- Throws:
InvalidParameterException
- if the value of constructorParameter is invalid for this type of service.NoSuchAlgorithmException
- if instantiation failed for any other reason.
-
supportsParameter
Test whether this Service can use the specified parameter. Returnsfalse
if this service cannot use the parameter. Returnstrue
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 (JCA) Reference Guide. Security providers can override it to implement their own test.
- Parameters:
parameter
- the parameter to test- Returns:
false
if 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
-