org.ejbca.core.protocol.ws.client.gen
Class UserDataVOWS

java.lang.Object
  org.ejbca.core.protocol.ws.client.gen.UserDataVOWS

All Implemented Interfaces:

java.io.Serializable

public class UserDataVOWS
extends java.lang.Object
implements java.io.Serializable

Class used to represent userdata in the WebService API. Is used instead of UserDataVO because of profilenames is used instead of id's.
Example code:

   UserDataVOWS user = new UserDataVOWS ();
   user.setUsername ("tester");
   user.setPassword ("foo123");
   user.setClearPwd (false);
   user.setSubjectDN ("CN=Tester,C=SE");
   user.setCaName ("AdminCA1");
   user.setEmail (null);
   user.setSubjectAltName (null);
   user.setStatus (UserDataVOWS.STATUS_NEW);
   user.setTokenType (UserDataVOWS.TOKEN_TYPE_USERGENERATED);
   user.setEndEntityProfileName ("EMPTY");
   user.setCertificateProfileName ("ENDUSER");
   
   List ei = new ArrayList ();
   ei.add(new ExtendedInformationWS (ExtendedInformation.CUSTOMDATA+ExtendedInformation.CUSTOM_REVOCATIONREASON,
                                     Integer.toString(RevokedCertInfo.REVOKATION_REASON_CERTIFICATEHOLD)));
   ei.add(new ExtendedInformationWS (ExtendedInformation.SUBJECTDIRATTRIBUTES, "DATEOFBIRTH=19761123"));
   user.setExtendedInformation(ei);

Version:

$Id: UserDataVOWS.java 10720 2010-11-27 09:16:51Z anatom $

Author:

Philip Vendil

See Also:

Serialized Form

Field Summary

static int	STATUS_FAILED
static int	STATUS_GENERATED
static int	STATUS_HISTORICAL
static int	STATUS_INITIALIZED
static int	STATUS_INPROCESS
static int	STATUS_KEYRECOVERY
static int	STATUS_NEW
static int	STATUS_REVOKED
static java.lang.String	TOKEN_TYPE_JKS
static java.lang.String	TOKEN_TYPE_P12
static java.lang.String	TOKEN_TYPE_PEM
static java.lang.String	TOKEN_TYPE_USERGENERATED

Constructor Summary

UserDataVOWS()
Emtpy constructor used by internally by web services

UserDataVOWS(java.lang.String username, java.lang.String password, boolean clearPwd, java.lang.String subjectDN, java.lang.String caName, java.lang.String subjectAltName, java.lang.String email, int status, java.lang.String tokenType, java.lang.String endEntityProfileName, java.lang.String certificateProfileName, java.lang.String hardTokenIssuerName)
Constructor used when creating a new UserDataVOWS.

Method Summary

java.lang.String	getCaName()
java.lang.String	getCertificateProfileName()
java.math.BigInteger	getCertificateSerialNumber()
java.lang.String	getEmail()
java.lang.String	getEndEntityProfileName()
java.lang.String	getEndTime()
java.util.List<ExtendedInformationWS>	getExtendedInformation()
java.lang.String	getHardTokenIssuerName()
java.lang.String	getPassword() Observe when sending userdata to clients outside EJBCA will the password always be null.
java.lang.String	getStartTime()
int	getStatus()
java.lang.String	getSubjectAltName()
java.lang.String	getSubjectDN()
java.lang.String	getTokenType()
int	getType()
java.lang.String	getUsername()
boolean	isClearPwd() Observe sending usedata to clients outside EJBCA will always return false
boolean	isKeyRecoverable()
boolean	isSendNotification() If true notifications will be sent to the user
void	setCaName(java.lang.String name)
void	setCertificateProfileName(java.lang.String certificateProfileName)
void	setCertificateSerialNumber(java.math.BigInteger sn)
void	setClearPwd(boolean clearPwd)
void	setEmail(java.lang.String email)
void	setEndEntityProfileName(java.lang.String endEntityProfileName)
void	setEndTime(java.lang.String endTime)
void	setExtendedInformation(java.util.List<ExtendedInformationWS> extendedInformation) Generic setter for extendedInformation.
void	setHardTokenIssuerName(java.lang.String hardTokenIssuerName)
void	setKeyRecoverable(boolean keyrecoverable) indicates if the users keys should be keyrecoverable
void	setPassword(java.lang.String password)
void	setSendNotification(boolean sendnotification) set to true if notifications should be sent to the user.
void	setStartTime(java.lang.String startTime)
void	setStatus(int status)
void	setSubjectAltName(java.lang.String subjectAltName)
void	setSubjectDN(java.lang.String subjectDN)
void	setTokenType(java.lang.String tokenType)
void	setUsername(java.lang.String username)

Methods inherited from class java.lang.Object

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

Field Detail

STATUS_FAILED

public static final int STATUS_FAILED

See Also:

Constant Field Values

STATUS_GENERATED

public static final int STATUS_GENERATED

See Also:

Constant Field Values

STATUS_HISTORICAL

public static final int STATUS_HISTORICAL

See Also:

Constant Field Values

STATUS_INITIALIZED

public static final int STATUS_INITIALIZED

See Also:

Constant Field Values

STATUS_INPROCESS

public static final int STATUS_INPROCESS

See Also:

Constant Field Values

STATUS_KEYRECOVERY

public static final int STATUS_KEYRECOVERY

See Also:

Constant Field Values

STATUS_NEW

public static final int STATUS_NEW

See Also:

Constant Field Values

STATUS_REVOKED

public static final int STATUS_REVOKED

See Also:

Constant Field Values

TOKEN_TYPE_JKS

public static final java.lang.String TOKEN_TYPE_JKS

See Also:

Constant Field Values

TOKEN_TYPE_P12

public static final java.lang.String TOKEN_TYPE_P12

See Also:

Constant Field Values

TOKEN_TYPE_PEM

public static final java.lang.String TOKEN_TYPE_PEM

See Also:

Constant Field Values

TOKEN_TYPE_USERGENERATED

public static final java.lang.String TOKEN_TYPE_USERGENERATED

See Also:

Constant Field Values

Constructor Detail

UserDataVOWS

public UserDataVOWS()

Emtpy constructor used by internally by web services

UserDataVOWS

public UserDataVOWS(java.lang.String username,
                    java.lang.String password,
                    boolean clearPwd,
                    java.lang.String subjectDN,
                    java.lang.String caName,
                    java.lang.String subjectAltName,
                    java.lang.String email,
                    int status,
                    java.lang.String tokenType,
                    java.lang.String endEntityProfileName,
                    java.lang.String certificateProfileName,
                    java.lang.String hardTokenIssuerName)

Constructor used when creating a new UserDataVOWS.

Parameters:

username - the unique username if the user, used internally in EJBCA

password - password u sed to lock the keystore

clearPwd - true if password should be in clear

subjectDN - of

caName - the name of the CA used in the EJBCA web gui.

subjectAltName -

email -

status - one of the STATUS_ constants

tokenType - type of token, one of TOKEN_TYPE constants for soft tokens, for hard ones use hardtokenprofilename

endEntityProfileName -

certificateProfileName -

hardTokenIssuerName - if no hardTokenIssuer should be used then use null.

Method Detail

getCaName

public java.lang.String getCaName()

Returns:

Returns the cAName.

getCertificateProfileName

public java.lang.String getCertificateProfileName()

Returns:

Returns the certificateProfileName.

getCertificateSerialNumber

public java.math.BigInteger getCertificateSerialNumber()

Returns:

certificate serial number.

getEmail

public java.lang.String getEmail()

Returns:

Returns the email.

getEndEntityProfileName

public java.lang.String getEndEntityProfileName()

Returns:

Returns the endEntityProfileName.

getEndTime

public java.lang.String getEndTime()

Returns:

the endTime

getExtendedInformation

public java.util.List<ExtendedInformationWS> getExtendedInformation()

Returns:

optional extended information list

getHardTokenIssuerName

public java.lang.String getHardTokenIssuerName()

Returns:

Returns the hardTokenIssuerName.

getPassword

public java.lang.String getPassword()

Observe when sending userdata to clients outside EJBCA will the password always be null.

Returns:

Returns the password.

getStartTime

public java.lang.String getStartTime()

Returns:

the startTime

getStatus

public int getStatus()

Returns:

Returns the status.

getSubjectAltName

public java.lang.String getSubjectAltName()

Returns:

Returns the subjectAltName.

getSubjectDN

public java.lang.String getSubjectDN()

Returns:

Returns the subjecDN.

getTokenType

public java.lang.String getTokenType()

Returns:

Returns the tokenType. One of TOKEN_TYPE constants for soft tokens, for hard ones use hardtokenprofilename

getType

public int getType()

Returns:

Returns the type.

getUsername

public java.lang.String getUsername()

Returns:

Returns the username.

isClearPwd

public boolean isClearPwd()

Observe sending usedata to clients outside EJBCA will always return false

Returns:

Returns the clearpwd.

isKeyRecoverable

public boolean isKeyRecoverable()

Returns:

true if the user is keyrecoverable

isSendNotification

public boolean isSendNotification()

If true notifications will be sent to the user

setCaName

public void setCaName(java.lang.String name)

Parameters:

name - The caName to set.

setCertificateProfileName

public void setCertificateProfileName(java.lang.String certificateProfileName)

Parameters:

certificateProfileName - The certificateProfileName to set.

setCertificateSerialNumber

public void setCertificateSerialNumber(java.math.BigInteger sn)

Parameters:

sn - Serial number of the certificate to be generated. Only used if 'Allow certificate serial number override' in used certificate profile is enabled.

setClearPwd

public void setClearPwd(boolean clearPwd)

Parameters:

clearPwd - The clearpwd to set.

setEmail

public void setEmail(java.lang.String email)

Parameters:

email - The email to set.

setEndEntityProfileName

public void setEndEntityProfileName(java.lang.String endEntityProfileName)

Parameters:

endEntityProfileName - The endEntityProfileName to set.

setEndTime

public void setEndTime(java.lang.String endTime)

Parameters:

endTime - the endTime to set

setExtendedInformation

public void setExtendedInformation(java.util.List<ExtendedInformationWS> extendedInformation)

Generic setter for extendedInformation. Set with values from ExtendedInformation such as: ExtendedInformation.CUSTOM_REVOCATIONREASON, Integer.toString(RevokedCertInfo.REVOKATION_REASON_CERTIFICATEHOLD)

Parameters:

extendedInformation -

setHardTokenIssuerName

public void setHardTokenIssuerName(java.lang.String hardTokenIssuerName)

Parameters:

hardTokenIssuerName - The hardTokenIssuerName to set.

setKeyRecoverable

public void setKeyRecoverable(boolean keyrecoverable)

indicates if the users keys should be keyrecoverable

Parameters:

keyrecoverable -

setPassword

public void setPassword(java.lang.String password)

Parameters:

password - The password to set.

setSendNotification

public void setSendNotification(boolean sendnotification)

set to true if notifications should be sent to the user.

setStartTime

public void setStartTime(java.lang.String startTime)

Parameters:

startTime - the startTime to set

setStatus

public void setStatus(int status)

Parameters:

status - The status to set.

setSubjectAltName

public void setSubjectAltName(java.lang.String subjectAltName)

Parameters:

subjectAltName - The subjectAltName to set.

setSubjectDN

public void setSubjectDN(java.lang.String subjectDN)

Parameters:

subjectDN - The subjectDN to set.

setTokenType

public void setTokenType(java.lang.String tokenType)

Parameters:

tokenType - The tokenType to set.

setUsername

public void setUsername(java.lang.String username)

Parameters:

username - The username to set.