com.entrust.toolkit.credentials

Class RoamingCredentialWriter

java.lang.Object

com.entrust.toolkit.credentials.CredentialWriter

com.entrust.toolkit.credentials.RoamingCredentialWriter

public class RoamingCredentialWriter
extends CredentialWriter

This Credential Writer is designed for writing a roaming Entrust Digital Identity to an Entrust Authority Roaming Server.

The following credential readers can all be used with this credential writer:

• RoamingCredentialReader
• CredentialCreator
• CredentialRecoverer
• FilenameProfileReader
• StreamProfileReader

Below is an example of how a user's Digital Identity can be logged into and then written (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);
 user.write();
 

Note

The current Roaming Server SSL connection supports only RSA, so this class can only be used to write credentials that use an RSA signing key.

Since:

7.0

See Also:

RoamingCredentialReader

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getType() Returns the name of this type of Credential Writer.

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

addConfiguration, writePossible

Methods inherited from class java.lang.Object

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

Constructor Detail

RoamingCredentialWriter

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

Creates a RoamingCredentialWriter object.

Parameters:

roamingUserId - the roaming user id for the digital identity being written. If this writer is being used with a RoamingCredentialReader, and the user ids are different, this will result in a roaming user id change. If it is being used with any other reader type, this will become the user's roaming user id.

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.

RoamingCredentialWriter

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

Creates a RoamingCredentialWriter object.

Parameters:

roamingUserId - the roaming user id for the digital identity being written. If this writer is being used with a RoamingCredentialReader, and the user ids are different, this will result in a roaming user id change. If it is being used with any other reader type, this will become the user's roaming user id.

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

smProxyEnabled - enables SMProxy support

Throws:

java.io.FileNotFoundException - if iniFile cannot be found

RoamingException - if any required configuration is missing or invalid.

RoamingCredentialWriter

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

Creates a RoamingCredentialWriter object.

Parameters:

roamingUserId - the roaming user id for the digital identity being written. If this writer is being used with a RoamingCredentialReader, and the user ids are different, this will result in a roaming user id change. If it is being used with any other reader type, this will become the user's roaming user id.

configuration - the roaming configuration data.

Method Detail

getType

public java.lang.String getType()

Returns the name of this type of Credential Writer.

Specified by:

getType in class CredentialWriter

Returns:

the name of this type of Credential Writer.