Top Description Inners Fields Constructors Methods
sun.security.pkcs11

pack-priv final Class TemplateManager

extends Object
Class Inheritance
Imports
java.util.*, java.util.concurrent.*, sun.security.pkcs11.wrapper.*

TemplateManager class. Not all PKCS#11 tokens are created equal. One token may require that one value is specified when creating a certain type of object. Another token may require a different value. Yet another token may only work if the attribute is not specified at all. In order to allow an application to work unmodified with all those different tokens, the SunPKCS11 provider makes the attributes that are specified and their value configurable. Hence, only the SunPKCS11 configuration file has to be tweaked at deployment time to allow all existing applications to be used. The template manager is responsible for reading the attribute configuration information and to make it available to the various internal components of the SunPKCS11 provider.
Author
Andreas Sterbenz
Since
1.5

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
private static class
TemplateManager.Template

Nested class representing template attributes.

private static class
TemplateManager.TemplateKey

Nested class representing a template identifier.

Field Summary

Modifier and TypeField and Description
private final Map<TemplateManager.TemplateKey, TemplateManager.Template>
private static final boolean
pack-priv static final String
pack-priv static final String
pack-priv static final String
private final List<TemplateManager.KeyAndTemplate>

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Modifier and TypeMethod and Description
pack-priv void
addTemplate(String op, long objectClass, long keyAlgorithm, CK_ATTRIBUTE[] attrs)

private TemplateManager.Template
pack-priv CK_ATTRIBUTE[]
getAttributes(String op, long type, long alg, CK_ATTRIBUTE[] attrs)

private TemplateManager.Template
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

compositeTemplatesback to summary
private final Map<TemplateManager.TemplateKey, TemplateManager.Template> compositeTemplates
DEBUGback to summary
private static final boolean DEBUG
O_ANYback to summary
pack-priv static final String O_ANY
O_GENERATEback to summary
pack-priv static final String O_GENERATE
O_IMPORTback to summary
pack-priv static final String O_IMPORT
primitiveTemplatesback to summary
private final List<TemplateManager.KeyAndTemplate> primitiveTemplates

Constructor Detail

TemplateManagerback to summary
pack-priv TemplateManager()

Method Detail

addTemplateback to summary
pack-priv void addTemplate(String op, long objectClass, long keyAlgorithm, CK_ATTRIBUTE[] attrs)
buildCompositeTemplateback to summary
private TemplateManager.Template buildCompositeTemplate(TemplateManager.TemplateKey key)
getAttributesback to summary
pack-priv CK_ATTRIBUTE[] getAttributes(String op, long type, long alg, CK_ATTRIBUTE[] attrs)
getTemplateback to summary
private TemplateManager.Template getTemplate(TemplateManager.TemplateKey key)
sun.security.pkcs11 back to summary

private Class TemplateManager.KeyAndTemplate

extends Object
Class Inheritance

Field Summary

Modifier and TypeField and Description
pack-priv final TemplateManager.TemplateKey
pack-priv final TemplateManager.Template

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

keyback to summary
pack-priv final TemplateManager.TemplateKey key
templateback to summary
pack-priv final TemplateManager.Template template

Constructor Detail

KeyAndTemplateback to summary
pack-priv KeyAndTemplate(TemplateManager.TemplateKey key, TemplateManager.Template template)
sun.security.pkcs11 back to summary

private final Class TemplateManager.Template

extends Object
Class Inheritance

Nested class representing template attributes.

Field Summary

Modifier and TypeField and Description
private static final CK_ATTRIBUTE[]
private CK_ATTRIBUTE[]

Constructor Summary

AccessConstructor and Description
pack-priv
pack-priv
Template(CK_ATTRIBUTE[] attributes)

Method Summary

Modifier and TypeMethod and Description
pack-priv void
private static CK_ATTRIBUTE[]
combine(CK_ATTRIBUTE[] attrs1, CK_ATTRIBUTE[] attrs2)

Combine two sets of attributes.

pack-priv CK_ATTRIBUTE[]
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

A0back to summary
private static final CK_ATTRIBUTE[] A0
attributesback to summary
private CK_ATTRIBUTE[] attributes

Constructor Detail

Templateback to summary
pack-priv Template()
Templateback to summary
pack-priv Template(CK_ATTRIBUTE[] attributes)

Method Detail

addback to summary
pack-priv void add(TemplateManager.Template template)
combineback to summary
private static CK_ATTRIBUTE[] combine(CK_ATTRIBUTE[] attrs1, CK_ATTRIBUTE[] attrs2)

Combine two sets of attributes. The second set has precedence over the first and overrides its settings.

getAttributesback to summary
pack-priv CK_ATTRIBUTE[] getAttributes(CK_ATTRIBUTE[] attrs)
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object

sun.security.pkcs11 back to summary

private final Class TemplateManager.TemplateKey

extends Object
Class Inheritance

Nested class representing a template identifier.

Field Summary

Modifier and TypeField and Description
pack-priv final long
pack-priv final long
pack-priv final String

Constructor Summary

AccessConstructor and Description
pack-priv
TemplateKey(String operation, long keyType, long keyAlgorithm)

Method Summary

Modifier and TypeMethod and Description
pack-priv boolean
public boolean
equals(Object
the reference object with which to compare.
obj
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

keyAlgorithmback to summary
pack-priv final long keyAlgorithm
keyTypeback to summary
pack-priv final long keyType
operationback to summary
pack-priv final String operation

Constructor Detail

TemplateKeyback to summary
pack-priv TemplateKey(String operation, long keyType, long keyAlgorithm)

Method Detail

appliesToback to summary
pack-priv boolean appliesTo(TemplateManager.TemplateKey key)
equalsback to summary
public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object