com.entrust.toolkit.credentials

Class FilenameProfileReader

java.lang.Object

com.entrust.toolkit.credentials.CredentialReader

com.entrust.toolkit.credentials.FilenameProfileReader

public final class FilenameProfileReader
extends CredentialReader

This credential reader is designed for reading an Entrust Digital Identity from an Entrust profile format (EPF) file.

When reading a Digital Identity store, the user may optionally have a connection to the Security Manager and Directory set. When these connections are not provided, key management operations are not possible (key update, DN change, ...). The user may also optionally have a credential writer set. The following credential writers can all be used with this credential reader:

• FilenameProfileWriter
• PKCS12Writer
• StreamProfileWriter
• TokenInitializer
• RoamingCredentialWriter

When a credential writer is not provided, the user's Digital Identity store CANNOT be written. Below is an example of how a user's Digital Identity can be logged into (all capitalized values must be provided by the user):

 User user = new User();
 
 JNDIDirectory directory = new JNDIDirectory(DIRECTORY_IP, DIRECTORY_PORT);
 ManagerTransport transport = new ManagerTransport(MANAGER_IP, MANAGER_PORT);
 user.setConnections(directory, transport);

 SecureStringBuffer securePassword = new SecureStringBuffer(PASSWORD);
 CredentialReader credentialReader = new FilenameProfileReader(EPF_FILE_NAME);
 CredentialWriter credentialWriter = new FilenameProfileWriter(EPF_FILE_NAME);
 user.setCredentialWriter(credentialWriter);
 user.login(credentialReader, securePassword);
 

Note

The file is actually read into memory in the constructor. This means that multiple reads with the same FilenameProfileReader object could result in stale information being read. This WILL happen if the Digital Identity is written (by the Toolkit or some other product) after the FilenameProfileReader instance was created, and then a subsequent read is attempted. Thus, it is best to only use this credential reader for a single read operation; subsequent reads should be done using separate instances.

Constructor Summary

Constructors

Constructor and Description
FilenameProfileReader(java.lang.String filename) Creates a FilenameProfileReader object.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getType() Returns the type (name) of this specific credential reader, which is "FilenameProfileReader".

Methods inherited from class com.entrust.toolkit.credentials.CredentialReader

checkPwd

Methods inherited from class java.lang.Object

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

Constructor Detail

FilenameProfileReader

public FilenameProfileReader(java.lang.String filename)
                      throws java.io.FileNotFoundException

Creates a FilenameProfileReader object.

When the user logs in, all Digital Identity information read from the indicated EPF file.

Parameters:

filename - the name of the EPF file that contains the user's Digital Identity (usually has a .epf filename extension)

Throws:

java.lang.IllegalArgumentException - thrown if filename is null

java.io.FileNotFoundException - thrown if the indicated EPF file could not be located

Method Detail

getType

public java.lang.String getType()

Returns the type (name) of this specific credential reader, which is "FilenameProfileReader".

Specified by:

getType in class CredentialReader

Returns:

String the type (name) of credential reader