Class Provider.Service
- 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 SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionfinal StringReturn the name of the algorithm of this service.final StringgetAttribute(String name) Return the value of the specified attribute ornullif this attribute is not set for this Service.final StringReturn the name of the class implementing this service.final ProviderReturn the Provider of this service.final StringgetType()Get the type of this service.newInstance(Object constructorParameter) Return a new instance of the implementation described by this service.booleansupportsParameter(Object parameter) Test whether this Service can use the specified parameter.toString()Return aStringrepresentation of this service.
- 
Constructor Details- 
Servicepublic 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 service
- type- the type of this service
- algorithm- the algorithm name
- className- the name of the class implementing this service
- aliases- List of aliases or- nullif algorithm has no aliases
- attributes- Map of attributes or- nullif this implementation has no attributes
- Throws:
- NullPointerException- if provider, type, algorithm, or className is- null
 
 
- 
- 
Method Details- 
getTypeGet the type of this service. For example,MessageDigest.- Returns:
- the type of this service
 
- 
getAlgorithmReturn the name of the algorithm of this service. For example,SHA-1.- Returns:
- the algorithm of this service
 
- 
getProviderReturn the Provider of this service.- Returns:
- the Provider of this service
 
- 
getClassNameReturn the name of the class implementing this service.- Returns:
- the name of the class implementing this service
 
- 
getAttributeReturn the value of the specified attribute ornullif this attribute is not set for this Service.- Parameters:
- name- the name of the requested attribute
- Returns:
- the value of the specified attribute or nullif the attribute is not present
- Throws:
- NullPointerException- if name is- null
 
- 
newInstanceReturn 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, or- nullif 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.
 
- 
supportsParameterTest whether this Service can use the specified parameter. Returnsfalseif this service cannot use the parameter. Returnstrueif 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:
- falseif this service cannot use the specified parameter;- trueif 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
 
-