com.entrust.toolkit.credentials

Class GenericIdentities

java.lang.Object

java.util.AbstractCollection<GenericIdentity>

com.entrust.toolkit.credentials.GenericIdentities

All Implemented Interfaces:

TokenIdentityFilter, java.lang.Iterable<GenericIdentity>, java.util.Collection<GenericIdentity>

public class GenericIdentities
extends java.util.AbstractCollection<GenericIdentity>
implements TokenIdentityFilter

GenericIdentities is a utility class used by InternalGenericTokenReader. Its purpose is to read certificates from an PKCS#11 device, organize them into identities and allow a caller to filter through the identities to find ones of interest. From an identity, the caller can access the certificates associated to that identity.

The definition of an Identity is configurable via the use of TokenIdentityFilter.

The identity of interest is configurable via the use of GenericIdentityFilter.

Finally, the certificates of interest from an identity are accessible via the use of GenericCertificateFilter.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GenericIdentities() The protected constructor used to initialize the List.

Method Summary

Modifier and Type	Method and Description
static java.util.List<Identity>	findAcceptableIdentities(JNIPKCS11 jnip11, long sessionId, GenericIdentityFilter identityFilter, TokenIdentityFilter tokenIdentityFilter) This method is a starting point for finding all identities on a PKCS#11 device.
protected GenericIdentity	findFirstMatchingIdentity(GenericCertificateAndKeyInfo caki, TokenIdentityFilter filter) Finds the first identity to which the given GenericCertificateAndKeyInfo matches by calling the TokenIdentityFilter.matchIdentity(Identity, CertificateAndKeyInfo) method.
static java.util.List<GenericCertificateAndKeyInfo>	getCertificateAndKeyInfos(GenericIdentity identity, GenericCertificateFilter filter) This is a convenience method to filter an identity for certificates of interest.
java.util.Iterator<GenericIdentity>	iterator() Returns an Iterator that can be used to iterate through all identities stored in this list.
boolean	matchIdentity(Identity identity, CertificateAndKeyInfo ccaki) Check if the passed in GenericCertificateAndKeyInfo belongs to the specified GenericIdentity.
int	size() Returns the number of identities in this collection.

Methods inherited from class java.util.AbstractCollection

add, addAll, clear, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

equals, hashCode, parallelStream, removeIf, spliterator, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

GenericIdentities

protected GenericIdentities()

The protected constructor used to initialize the List.

Method Detail

matchIdentity

public boolean matchIdentity(Identity identity,
                             CertificateAndKeyInfo ccaki)

Check if the passed in GenericCertificateAndKeyInfo belongs to the specified GenericIdentity.

Specified by:

matchIdentity in interface TokenIdentityFilter

Parameters:

identity - The GenericIdentity

ccaki - The GenericCertificateAndKeyInfo

Returns:

true if the GenericCertificateAndKeyInfo belong to the GenericIdentity, false if GenericCertificateAndKeyInfo do not belong.

iterator

public java.util.Iterator<GenericIdentity> iterator()

Returns an Iterator that can be used to iterate through all identities stored in this list. The object returned by calling the next() method of the iterator should be cast to a GenericIdentity.

Specified by:

iterator in interface java.lang.Iterable<GenericIdentity>

Specified by:

iterator in interface java.util.Collection<GenericIdentity>

Specified by:

iterator in class java.util.AbstractCollection<GenericIdentity>

Returns:

an Iterator that can be used to iterate through all identities stored in this set.

size

public int size()

Returns the number of identities in this collection.

Specified by:

size in interface java.util.Collection<GenericIdentity>

Specified by:

size in class java.util.AbstractCollection<GenericIdentity>

Returns:

the number of identities in this collection.

findFirstMatchingIdentity

protected GenericIdentity findFirstMatchingIdentity(GenericCertificateAndKeyInfo caki,
                                                    TokenIdentityFilter filter)

Finds the first identity to which the given GenericCertificateAndKeyInfo matches by calling the TokenIdentityFilter.matchIdentity(Identity, CertificateAndKeyInfo) method.

Parameters:

caki - The GenericCertificateAndKeyInfo which will be used to find certificates and key that belong to this identity.

filter - The TokenIdentityFilter used to find the certificates and keys that belong to this identity.

Returns:

The identity matching the container, or null if no matching identity is found.

findAcceptableIdentities

public static java.util.List<Identity> findAcceptableIdentities(JNIPKCS11 jnip11,
                                                                long sessionId,
                                                                GenericIdentityFilter identityFilter,
                                                                TokenIdentityFilter tokenIdentityFilter)
                                                         throws UserFatalException

This method is a starting point for finding all identities on a PKCS#11 device. The GenericIdentityFilter and TokenIdentityFilter allows you to narrow down which identities are returned from the store.

Parameters:

jnip11 -

sessionId -

identityFilter -

Returns:

list of all identities on the device

Throws:

UserFatalException

getCertificateAndKeyInfos

public static java.util.List<GenericCertificateAndKeyInfo> getCertificateAndKeyInfos(GenericIdentity identity,
                                                                                     GenericCertificateFilter filter)

This is a convenience method to filter an identity for certificates of interest. The caller constructs a GenericCertificateFilter specifying what criteria they are looking for, the filter is applied to the identity returning certificates that the filter accepts

Parameters:

identity -

filter -

Returns:

List