com.entrust.toolkit.roaming

Class RoamingFileUpdater

java.lang.Object

com.entrust.toolkit.roaming.RoamingFileUpdater

public class RoamingFileUpdater
extends java.lang.Object

This class is responsible for all communication with the Roaming Server which may result in modifications to the Directory. This would include creating, recovering, updating a profile for any reason, or asking the Roaming Server to remove the roaming files from the Directory (deregistering).

While this class is public, it is intended for internal use by the Toolkit only.

Since:

7.0

Field Summary

Fields

Modifier and Type	Field and Description
static byte[]	SERVER_VERSION_50 The 5.0 version
static byte[]	SERVER_VERSION_51 The 5.1 version

Constructor Summary

Constructors

Constructor and Description
RoamingFileUpdater(RoamingConfiguration configuration, User user) Creates a RoamingFileUpdater object when a logged in User object is available.
RoamingFileUpdater(RoamingConfiguration configuration, User user, X509Certificate[] certChain, java.security.PrivateKey signingKey) Creates a RoamingFileUpdater object when a User object is available but is not logged in.

Method Summary

Modifier and Type	Method and Description
void	deregister(java.lang.String roamingUserId) Requests the Roaming Server remove all of the User's roaming files from the Directory.
byte[]	getServerVersion(java.lang.String roamingUserId) Retrieves the latest version of Roaming supported by the Roaming Server.
void	setPasswordInfo(java.lang.String roamingUserId, SecureStringBuffer password, boolean includeUserId) Sets the information required to generate the shared secret.
void	update(byte[] entrustProfile) Update a roaming profile.
void	update(EntrustFiles filesToUpdate) Updates all of the given files by sending an update request to the Roaming Server.

Methods inherited from class java.lang.Object

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

Field Detail

SERVER_VERSION_50

public static final byte[] SERVER_VERSION_50

The 5.0 version

SERVER_VERSION_51

public static final byte[] SERVER_VERSION_51

The 5.1 version

Constructor Detail

RoamingFileUpdater

public RoamingFileUpdater(RoamingConfiguration configuration,
                          User user)
                   throws RoamingException,
                          UserNotLoggedInException

Creates a RoamingFileUpdater object when a logged in User object is available.

Parameters:

configuration - The Roaming configuration information.

user - A logged in User object that will be used to communicate securely with the Roaming Server

Throws:

RoamingException - if no certificate chain can be found for the user.

UserNotLoggedInException - if user is not logged in

RoamingFileUpdater

public RoamingFileUpdater(RoamingConfiguration configuration,
                          User user,
                          X509Certificate[] certChain,
                          java.security.PrivateKey signingKey)

Creates a RoamingFileUpdater object when a User object is available but is not logged in.

Parameters:

configuration - The Roaming configuration information.

user - A User object that will be used to communicate securely with the Roaming Server

certChain - The certificate chain from the user's verification certificate to the root of trust.

signingKey - The user's private signing key.

Method Detail

setPasswordInfo

public void setPasswordInfo(java.lang.String roamingUserId,
                            SecureStringBuffer password,
                            boolean includeUserId)

Sets the information required to generate the shared secret. Calling this method indicates that a new shared secret should be generated and included in the update request. This method must be called when creating, recovering, changing a password, or changing a roaming user id.

Parameters:

roamingUserId - the user's roaming user id.

password - the user's password.

includeUserId - whether or not the roaming user id should be included in update requests. Set to true when creating, recovering or changing the roaming user id of a roaming profile, and false in the case of password change.

update

public void update(byte[] entrustProfile)
            throws RoamingException,
                   java.io.IOException

Update a roaming profile. This method is good for all types of update, but setPasswordInfo(java.lang.String, com.entrust.toolkit.util.SecureStringBuffer, boolean) should be called before if anything other than a simple update is being performed.

Parameters:

entrustProfile - the bytes of the profile. These will be converted to ISO 8859-1 format.

Throws:

java.io.IOException - if any socket communication errors occur while updating the profile.

RoamingException - if any other problem occurs when updating the profile.

update

public void update(EntrustFiles filesToUpdate)
            throws RoamingException,
                   java.io.IOException

Updates all of the given files by sending an update request to the Roaming Server.

Parameters:

filesToUpdate - The roaming files to update. This could include the profile.

Throws:

java.io.IOException - if any socket communication errors occur while updating the profile.

RoamingException - if any other problem occurs when updating the profile.

deregister

public void deregister(java.lang.String roamingUserId)
                throws RoamingException,
                       java.io.IOException

Requests the Roaming Server remove all of the User's roaming files from the Directory.

Parameters:

roamingUserId - the user's roaming user id.

Throws:

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

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

getServerVersion

public byte[] getServerVersion(java.lang.String roamingUserId)
                        throws RoamingException,
                               java.io.IOException

Retrieves the latest version of Roaming supported by the Roaming Server.

Parameters:

roamingUserId - the Roaming ID of the user performing the request.

Returns:

the roaming version as a byte array

• 0x0100 for 5.0 Roaming Server
• 0x0000 for 5.1 Roaming Server
• 0x0002 for 6.0 Roaming Server

Throws:

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

RoamingException - if the query operation failed for any other reason.