com.entrust.toolkit.credentials

Class UALCredentialReader

java.lang.Object

com.entrust.toolkit.credentials.CredentialReader

com.entrust.toolkit.credentials.UALCredentialReader

public final class UALCredentialReader
extends CredentialReader

UALCredentialReader is a subclass of CredentialReader and reads an Entrust Digital Identity that has been bound to a computer using the Toolkit's Server Login feature.

The UALCredentialReader logs in a user, reading the password from a .ual file. This file binds a specific .epf file to a specific machine.

The UALCredentialReader relies on native code to determine the machine properties needed to read the .ual file. As a result, it requires that the Server Login DLL or shared library (ualjni.dll or libualjni) be installed on the computer in the appropriate path. Refer to the Programmer's Guide for more information.

When you use a UALCredentialReader, the password sent to the User object in the login method is ignored. The password can, therefore, be set to null.

You should use Server Login only on physically secured machines.

Constructor Summary

Constructors

Constructor and Description
UALCredentialReader(CredentialReader credentials, java.io.InputStream passwordCache) Creates a UALCredentialReader that lets you use the Server Login feature with any other type of Digital Identity store.
UALCredentialReader(CredentialReader credentials, java.io.InputStream passwordCache, java.lang.String updatedUalFileName) Instantiates a UALCredentialReader.
UALCredentialReader(java.io.InputStream credentials, java.io.InputStream passwordCache) Deprecated. use UALCredentialReader(CredentialReader, InputStream ) instead
UALCredentialReader(java.io.InputStream credentials, java.io.InputStream passwordCache, java.lang.String updatedUalFileName) Deprecated. use UALCredentialReader(CredentialReader, InputStream, String) instead

Method Summary

Modifier and Type	Method and Description
java.lang.String	getType() Returns the type (name) of the CredentialReader calling this method.

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

UALCredentialReader

public UALCredentialReader(java.io.InputStream credentials,
                           java.io.InputStream passwordCache)
                    throws Base64Exception,
                           UserFatalException,
                           java.io.IOException

Deprecated. use UALCredentialReader(CredentialReader, InputStream ) instead

Instantiates a UALCredentialReader to log in a user.

This constructor takes two arguments:

1. An input stream pointing to the user's .epf file
2. An input stream pointing to a .ual file

The constructor works in the same way as the StreamProfileReader credential reader, except that it retrieves the password from the .ual file and ignores the password specified during login.

Notes

If you use UALCredentialReader and StreamProfileWriter objects to read and write to a Digital Identity store managed by instances of the FileInputStream and FileOutputStream classes, ensure that you read from, and write to, files with different file names to prevent the destruction of the Digital Identity file when you open the output stream.

Parameters:

credentials - input stream pointing to the .epf file

passwordCache - input stream pointing to the user's .ual file

Throws:

Base64Exception

UserFatalException

java.io.IOException

UALCredentialReader

public UALCredentialReader(java.io.InputStream credentials,
                           java.io.InputStream passwordCache,
                           java.lang.String updatedUalFileName)
                    throws Base64Exception,
                           UserFatalException,
                           java.io.IOException

Deprecated. use UALCredentialReader(CredentialReader, InputStream, String) instead

Instantiates a UALCredentialReader.

This constructor takes three arguments:

1. An input stream pointing to the user's .epf file
2. An input stream pointing to the user's .ual file
3. The name of the file used to store the updated .ual file

This constructor is used when the application has to rebind the .ual file automatically after machine information has changed. In this case, the third argument should be set to the same file name pointed by passwordCache.

Parameters:

credentials - input stream used to read the user's Digital Identity store (.epf)

passwordCache - input stream used to read the user's .ual file

updatedUalFileName - a String object representing the name of the file used to store the updated .ual file. It can be set to the file name pointed to by passwordCache to rebind the user's .ual file after machine information has changed. This parameter is ignored if rebinding is not necessary.

Throws:

Base64Exception

UserFatalException

java.io.IOException

UALCredentialReader

public UALCredentialReader(CredentialReader credentials,
                           java.io.InputStream passwordCache)
                    throws Base64Exception,
                           UserFatalException,
                           java.io.IOException

Creates a UALCredentialReader that lets you use the Server Login feature with any other type of Digital Identity store.

The credential reader argument passed to the constructor is used to provide all Digital Identity data to the Toolkit. The UALCredentialReader simply serves as a thin layer responsible for retrieving the password from the .ual password file and sending it to the underlying credential reader as if it had been specified in the User.login method.

Parameters:

credentials - credential reader from which to read the user's Digital Identity

passwordCache - input stream pointing to a valid .ual file

Throws:

Base64Exception

UserFatalException

java.io.IOException

UALCredentialReader

public UALCredentialReader(CredentialReader credentials,
                           java.io.InputStream passwordCache,
                           java.lang.String updatedUalFileName)
                    throws Base64Exception,
                           UserFatalException,
                           java.io.IOException

Instantiates a UALCredentialReader.

This constructor takes three arguments:

1. A credential reader pointing to the user's .epf file
2. An input stream pointing to the user's .ual file
3. The name of the file used to store the updated .ual file

This constructor is used when the application has to rebind the .ual file automatically after machine information has changed. In this case the third argument should be the same file name pointed by passwordCache.

Parameters:

credentials - credential reader used to read the user's Digital Identity store (.epf)

passwordCache - input stream used to read the user's .ual file

updatedUalFileName - a String object representing the name of the file used to store the updated .ual file. It can be set to the file name pointed to by passwordCache to rebind the user's .ual file after machine information has changed. This parameter is ignored if rebinding is not necessary.

Throws:

Base64Exception

UserFatalException

java.io.IOException

Method Detail

getType

public java.lang.String getType()

Returns the type (name) of the CredentialReader calling this method.

Specified by:

getType in class CredentialReader

Returns:

The type (name) of the CredentialReader