com.entrust.toolkit.credentials

Class RoamingCredentialReader

java.lang.Object

com.entrust.toolkit.credentials.CredentialReader

com.entrust.toolkit.credentials.RoamingCredentialReader

public class RoamingCredentialReader
extends CredentialReader

This credential reader is designed for reading a roaming Entrust Digital Identity from an Entrust Authority Roaming Server.

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:

• RoamingCredentialWriter
• FilenameProfileWriter
• PKCS12Writer
• StreamProfileWriter

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();
 
 user.setConnections(ENTRUST_INI_FILE);

 SecureStringBuffer securePassword = new SecureStringBuffer(PASSWORD);
 CredentialReader credentialReader = new RoamingCredentialReader(ROAMING_USER_ID, ENTRUST_INI_FILE);
 CredentialWriter credentialWriter = new RoamingCredentialWriter(ROAMING_USER_ID, ENTRUST_INI_FILE);
 user.setCredentialWriter(credentialWriter);
 user.login(credentialReader, securePassword);
 

Since:

7.0

See Also:

RoamingCredentialWriter

Constructor Summary

Constructors

Constructor and Description
RoamingCredentialReader(java.lang.String roamingUserId, RoamingConfiguration configuration) Creates a RoamingCredentialReader object.
RoamingCredentialReader(java.lang.String roamingUserId, java.lang.String iniFile) Creates a RoamingCredentialReader object.
RoamingCredentialReader(java.lang.String roamingUserId, java.lang.String iniFile, boolean smProxyEnabled) Creates a RoamingCredentialReader object.

Method Summary

Methods

Modifier and Type	Method and Description
void	deregister() Requests the Roaming Server remove all of the User's roaming files from the Directory.
RoamingCredentialWriter	getRoamingCredentialWriter() Returns a RoamingCredentialWriter object that is safe for use with this reader.
java.lang.String	getType() Returns the name of this type of credential reader.

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

RoamingCredentialReader

public RoamingCredentialReader(java.lang.String roamingUserId,
                       java.lang.String iniFile)
                        throws java.io.FileNotFoundException,
                               RoamingException

Creates a RoamingCredentialReader object.

Parameters:

roamingUserId - the roaming user id to read the Digital Identity from.

iniFile - the entrust.ini file to read the roaming configuration data from.

Throws:

java.io.FileNotFoundException - if iniFile cannot be found

RoamingException - if any required configuration is missing or invalid.

RoamingCredentialReader

public RoamingCredentialReader(java.lang.String roamingUserId,
                       java.lang.String iniFile,
                       boolean smProxyEnabled)
                        throws java.io.FileNotFoundException,
                               RoamingException

Creates a RoamingCredentialReader object.

Parameters:

roamingUserId - the roaming user id to read the Digital Identity from.

iniFile - the entrust.ini file to read the roaming configuration data from.

smProxyEnabled - enables SMProxy support

Throws:

java.io.FileNotFoundException

RoamingException

RoamingCredentialReader

public RoamingCredentialReader(java.lang.String roamingUserId,
                       RoamingConfiguration configuration)

Creates a RoamingCredentialReader object.

Parameters:

roamingUserId - the roaming user id to read the Digital Identity from.

configuration - the roaming configuration data.

Method Detail

getRoamingCredentialWriter

public RoamingCredentialWriter getRoamingCredentialWriter()

Returns a RoamingCredentialWriter object that is safe for use with this reader.

Returns:

a RoamingCredentialWriter object that is safe for use with this reader.

deregister

public void deregister()
                throws UserNotLoggedInException,
                       RoamingException,
                       java.io.IOException

Requests the Roaming Server remove all of the User's roaming files from the Directory. This method can only be called after a call to User.login()

Note

Before calling this method, it is essential that the user's digital identity has been written to another location, or it will be lost, and a key recovery will be required.

Throws:

RoamingException - if removal of the user's roaming files failed.

java.io.IOException - if the operation failed due to any communication problem.

UserNotLoggedInException - if the user is not logged in.

getType

public java.lang.String getType()

Returns the name of this type of credential reader.

Specified by:

getType in class CredentialReader

Returns:

the name of this type of credential reader.