com.entrust.toolkit.roaming

Class RoamingFileRetriever

java.lang.Object

com.entrust.toolkit.roaming.RoamingFileRetriever

public class RoamingFileRetriever
extends java.lang.Object

This class is responsible for communicating with the Roaming Server to retrieve the profile decryption key, and then decrypting the roaming files.

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

Since:

7.0

Constructor Summary

Constructors

Constructor and Description
RoamingFileRetriever(java.lang.String roamingUserId, RoamingConfiguration configuration) Constructs an instance of this object.

Method Summary

Methods

Modifier and Type	Method and Description
EntrustFiles	retrieveFiles(SecureStringBuffer password) Retrieve and decrypt roaming files.

Methods inherited from class java.lang.Object

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

Constructor Detail

RoamingFileRetriever

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

Constructs an instance of this object.

Parameters:

roamingUserId - the roaming user id for which to retrieve files.

configuration - configuration information containing the address of the Roaming Server.

Method Detail

retrieveFiles

public EntrustFiles retrieveFiles(SecureStringBuffer password)
                           throws RoamingException,
                                  UserBadPasswordException

Retrieve and decrypt roaming files.

Parameters:

password - the user's password

Returns:

the decrypted roaming files

Throws:

RoamingException - if there is a problem retrieving the roaming files from the Directory, or a problem communicating with the Roaming Server.

UserBadPasswordException - if the given password was not correct. Note that it is not always possible to tell for sure that the password is incorrect, so this error is thrown when a bad password is the most likely cause of an error.