com.entrust.toolkit.roaming

Class CombinedUpdateRegReq

java.lang.Object

com.entrust.toolkit.roaming.CombinedUpdateRegReq

All Implemented Interfaces:

ASN1Type

public class CombinedUpdateRegReq
extends java.lang.Object
implements ASN1Type

The CombinedUpdateRegReq class implements the ASN1 type CombinedUpdateregReq for Roaming support.

This request is sent when a client either wishes to update a Roaming file, or to register as a Roaming user.

       CombinedUpdateRegReq ::= SEQUENCE
       {
               userid          RoamingUserID OPTIONAL,
               sharedSecret        OCTET STRING OPTIONAL,
               fileEncKeyType      AlgorithmIdentifier,
               files           SEQUENCE OF EntrustFileDesc
       }
 

userid is the user's Roaming ID, uniquely identifying the user. If userid is present, the Roaming Server assumes the user is either registering for Roaming, or recovering his or her profile. If userid is absent, the Roaming Server assumes the user wishes to update one or more of his or her roaming files.

sharedSecret is the secret to be used during the PAKE negotiation at login time. If userid is supplied, then sharedSecret must also be supplied. sharedSecret can be supplied without the userid when the user wishes to change his or her password.

fileEncKeyType is the type of key to be used when encrypting the user's Roaming files. fileEncKeyType is used only during registration, when userid is supplied.

files is a list of files whose contents are to be either updated or added to the Directory.

Constructor Summary

Constructors

Constructor and Description
CombinedUpdateRegReq() The default constructor.

Method Summary

Modifier and Type	Method and Description
void	decode(ASN1Object object) Parses the given ASN1Object into a CombinedUpdateRegReq object.
AlgorithmID	getFileEncKeyType() Returns the fileEncKeyType component.
EntrustFiles	getFiles() Returns the files component.
OCTET_STRING	getSharedSecret() Returns the sharedSecret component.
BMPString	getUserId() Returns the userid component.
void	setFileEncKeyType(AlgorithmID keyType) Sets the fileEncKeyType component.
void	setFiles(EntrustFiles files) Sets the files component.
void	setSharedSecret(OCTET_STRING secret) Sets the sharedSecret component.
void	setUserId(BMPString userid) Sets the userid component.
ASN1Object	toASN1Object() Returns the ASN1Object of CombinedUpdateRegReq type.

Methods inherited from class java.lang.Object

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

Constructor Detail

CombinedUpdateRegReq

public CombinedUpdateRegReq()

The default constructor.

Method Detail

decode

public void decode(ASN1Object object)
            throws CodingException

Parses the given ASN1Object into a CombinedUpdateRegReq object.

Specified by:

decode in interface ASN1Type

Parameters:

object - the ASN1Object to be parsed.

Throws:

CodingException - if the ASN1Object could not be parsed

toASN1Object

public ASN1Object toASN1Object()

Returns the ASN1Object of CombinedUpdateRegReq type.

Specified by:

toASN1Object in interface ASN1Type

Returns:

the ASN1Object of CombinedUpdateRegReq type.

setUserId

public void setUserId(BMPString userid)

Sets the userid component.

Parameters:

userid - the user's roaming ID as a BMPString object.

setSharedSecret

public void setSharedSecret(OCTET_STRING secret)

Sets the sharedSecret component.

Parameters:

secret - the shared secret as an OCTET_STRING.

setFileEncKeyType

public void setFileEncKeyType(AlgorithmID keyType)

Sets the fileEncKeyType component.

Parameters:

keyType - the fileEncKeyType component as an AlgorithmIdentifier object.

setFiles

public void setFiles(EntrustFiles files)

Sets the files component.

Parameters:

files - the files component as an EntrustFiles object.

getUserId

public BMPString getUserId()

Returns the userid component.

Returns:

the user's roaming ID as a BMPString object.

getSharedSecret

public OCTET_STRING getSharedSecret()

Returns the sharedSecret component.

Returns:

the shared secret as an OCTET_STRING.

getFileEncKeyType

public AlgorithmID getFileEncKeyType()

Returns the fileEncKeyType component.

Returns:

the fileEncKeyType component as an AlgorithmID type.

getFiles

public EntrustFiles getFiles()

Returns the files component.

Returns:

the files component as an EntrustFiles type.