com.starbase.starteam
Class UserAccount

java.lang.Object
  |
  +--com.starbase.starteam.CacheRef
        |
        +--com.starbase.starteam.UserAccount

All Implemented Interfaces:

java.lang.Cloneable

public class UserAccount

extends CacheRef

Represents a StarTeam user account. That is, an active user account on a StarTeam Server. This is not to be confused with a User object which simply represents a user that does participate or has participated in operations on the items in the repository.

Field Summary

static int	DAY_FRIDAY A constant value specifying the day of the week "Friday".
static int	DAY_MONDAY A constant value specifying the day of the week "Monday".
static int	DAY_SATURDAY A constant value specifying the day of the week "Saturday".
static int	DAY_SUNDAY A constant value specifying the day of the week "Sunday".
static int	DAY_THURSDAY A constant value specifying the day of the week "Thursday".
static int	DAY_TUESDAY A constant value specifying the day of the week "Tuesday".
static int	DAY_WEDNESDAY A constant value specifying the day of the week "Wednesday".
static int	LICENSE_TYPE_LICENSE_SERVER A license managed by the Borland License Server.
static int	LICENSE_TYPE_STARTEAM A license managed by the StarTeam server.
static int	LICENSE_TYPE_UNASSIGNED An unassigned license.
static int	POLICY_ALWAYS A constant value for specifying an account access policy where the user is always allowed to log on.
static int	POLICY_CUSTOM A constant value for specifying an account access policy where the user is only allowed to log on during specified time ranges during different days of the week.
static int	POLICY_STANDARD A constant value for specifying an account access policy where the user is only allowed to log on during business hours ( 8am - 5pm ).
static int	STATUS_LOCKED_OUT A constant value representing a "locked out" account.
static int	STATUS_NORMAL A constant value representing a "normal" account status.
static int	STATUS_PASSWORD_CHANGE_NOTIFIED A constant value representing an account that has been notified of a required password change.
static int	STATUS_PASSWORD_CHANGE_REQUIRED A constant value representing an account that requires a password change.
static int	STATUS_SUSPENDED A constant value representing a "suspended" account.

Constructor Summary

UserAccount(Server server)
Creates a new user account to be activated on the server.

Method Summary

void	addToGroupAccount(GroupAccount groupAccount) Adds this user to the specified group account.
UserAccount	copy() Creates a copy of this UserAccount object.
boolean	equals(java.lang.Object source) returns true if this object instance is equal to the source
void	forceLogoff() Forces this user account to be logged off from the server.
void	forcePasswordChange() Forces a password change for this user account.
int	getAccessEndTime1(int dayOfWeek) Returns the end time for the specified day for the first custom access policy.
int	getAccessEndTime2(int dayOfWeek) Returns the end time for the specified day for the second custom access policy.
int	getAccessPolicy() Return's this account's access policy.
int	getAccessStartTime1(int dayOfWeek) Returns the start time for the specified day for the first custom access policy.
int	getAccessStartTime2(int dayOfWeek) Returns the start time for the specified day for the second custom access policy.
int	getAccountStatus() Returns this account's status.
int	getBLSSlipGuid() Gets the Slip ID assigned to this license.
OLEDate	getCreatedTime() Gets the time at which this UserAccount was created.
java.lang.String	getDistinguishedName() Gets the Distinguished Name for Directory Service.
java.lang.String	getEmailAddress() Returns the user's email address.
java.lang.String	getFaxNumber() Returns the user's fax number.
GroupAccount[]	getGroupAccounts() Returns all of the group accounts to which this user belongs.
boolean	getHasFixedLicense() Determines whether this user has a fixed ( named-user ) license or a floating ( concurrent ) license.
int	getID() Returns an integer ID that represents this user account.
int	getLicenseType() Gets the type of license assigned to this user.
int	getLogOnCount() Returns the number of times this user is logged in to the server.
java.lang.String	getLogOnName() Returns the logon name or identifier for this account.
java.lang.String	getName() Returns the full name that this user goes by.
java.lang.String	getPagerNumber() Returns the user's pager number.
java.lang.String	getPhoneNumber() Returns the user's phone number.
int	getPolicyTimeZoneShift() Return's the timezone shift for this account's access policy.
java.lang.String	getPostalAddress() Returns the user's postal address.
boolean	getValidateThroughDirectoryService() Indicates whether the user validates through Directory Service.
java.lang.String	getVoiceMailNumber() Returns the user's voice mail number.
java.lang.String[]	getWorkstations() Currently unused.
int	hashCode() returns a unique hash for all instances of this type
boolean	isEqualTo(UserAccount account) Compares two UserAccount objects.
boolean	isNew() Tells if this user account has been created on the server yet.
void	reactivate() Reactivates this user account.
void	remove() Removes this user account from the server, and from any group of which it is a member.
void	removeFromGroupAccount(GroupAccount groupAccount) Removes this user from the specified group account.
void	setAccessPolicy(int policy) Changes this account's access policy.
void	setAccessTimes(int dayOfWeek, int start1, int end1, int start2, int end2) Changes the custom access policy start and end times for the specified day of the week.
void	setAccountStatus(int status) Modify this account's status.
void	setBLSSlipGuid(int nSlipGuid) Sets the Slip ID assigned to this license.
void	setDistinguishedName(java.lang.String distinguishedName) Sets the Distinguished Name for Directory Service.
void	setEmailAddress(java.lang.String emailAddress) Changes the user's email address.
void	setFaxNumber(java.lang.String faxNumber) Changes the user's fax number.
void	setHasFixedLicense(boolean bFixed) Sets the license type for this user.
void	setLicenseType(int nLicenseType) Sets the type of license assigned to this user.
void	setLogOnName(java.lang.String logOnName) Changes the logon name for this account.
void	setName(java.lang.String name) Changes the user's full name.
void	setPagerNumber(java.lang.String pagerNumber) Changes the user's pager number.
void	setPassword(java.lang.String password) Sets the password for this account.
void	setPhoneNumber(java.lang.String phoneNumber) Changes the user's phone number.
void	setPolicyTimeZoneShift(int shift) Changes timezone shift for this account's access policy.
void	setPostalAddress(java.lang.String postalAddress) Changes the user's postal address.
void	setValidateThroughDirectoryService(boolean bValidateThroughDirectoryService) Sets whether user validates through Directory Service.
void	setVoiceMailNumber(java.lang.String voiceMailNumber) Changes the user's voice mail number.
void	suspend() Suspend this user account.
java.lang.String	toString() Returns the name of this user account.
void	unlock() Unlocks this user account.
void	update() Create or modify this UserAccount in the StarTeam Server.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

LICENSE_TYPE_STARTEAM

public static final int LICENSE_TYPE_STARTEAM

A license managed by the StarTeam server.

See Also:

UserAccount.getLicenseType(), Constant Field Values

LICENSE_TYPE_LICENSE_SERVER

public static final int LICENSE_TYPE_LICENSE_SERVER

A license managed by the Borland License Server.

See Also:

UserAccount.getLicenseType(), Constant Field Values

LICENSE_TYPE_UNASSIGNED

public static final int LICENSE_TYPE_UNASSIGNED

An unassigned license.

See Also:

UserAccount.getLicenseType(), Constant Field Values

STATUS_NORMAL

public static final int STATUS_NORMAL

A constant value representing a "normal" account status.

See Also:

UserAccount.getAccountStatus(), UserAccount.setAccountStatus(int), Constant Field Values

STATUS_LOCKED_OUT

public static final int STATUS_LOCKED_OUT

A constant value representing a "locked out" account.

See Also:

UserAccount.getAccountStatus(), UserAccount.setAccountStatus(int), Constant Field Values

STATUS_SUSPENDED

public static final int STATUS_SUSPENDED

A constant value representing a "suspended" account.

See Also:

UserAccount.getAccountStatus(), UserAccount.setAccountStatus(int), Constant Field Values

STATUS_PASSWORD_CHANGE_REQUIRED

public static final int STATUS_PASSWORD_CHANGE_REQUIRED

A constant value representing an account that requires a password change.

See Also:

UserAccount.getAccountStatus(), UserAccount.setAccountStatus(int), Constant Field Values

STATUS_PASSWORD_CHANGE_NOTIFIED

public static final int STATUS_PASSWORD_CHANGE_NOTIFIED

A constant value representing an account that has been notified of a required password change.

See Also:

UserAccount.getAccountStatus(), UserAccount.setAccountStatus(int), Constant Field Values

POLICY_ALWAYS

public static final int POLICY_ALWAYS

A constant value for specifying an account access policy where the user is always allowed to log on.

See Also:

UserAccount.getAccessPolicy(), UserAccount.setAccessPolicy(int), Constant Field Values

POLICY_STANDARD

public static final int POLICY_STANDARD

A constant value for specifying an account access policy where the user is only allowed to log on during business hours ( 8am - 5pm ).

See Also:

UserAccount.getAccessPolicy(), UserAccount.setAccessPolicy(int), Constant Field Values

POLICY_CUSTOM

public static final int POLICY_CUSTOM

A constant value for specifying an account access policy where the user is only allowed to log on during specified time ranges during different days of the week.

See Also:

UserAccount.getAccessPolicy(), UserAccount.setAccessPolicy(int), UserAccount.getAccessStartTime1(int), UserAccount.getAccessEndTime1(int), UserAccount.getAccessStartTime2(int), UserAccount.getAccessEndTime2(int), UserAccount.setAccessTimes(int, int, int, int, int), UserAccount.getPolicyTimeZoneShift(), UserAccount.setPolicyTimeZoneShift(int), Constant Field Values

DAY_SUNDAY

public static final int DAY_SUNDAY

A constant value specifying the day of the week "Sunday".

See Also:

Constant Field Values

DAY_MONDAY

public static final int DAY_MONDAY

A constant value specifying the day of the week "Monday".

See Also:

Constant Field Values

DAY_TUESDAY

public static final int DAY_TUESDAY

A constant value specifying the day of the week "Tuesday".

See Also:

Constant Field Values

DAY_WEDNESDAY

public static final int DAY_WEDNESDAY

A constant value specifying the day of the week "Wednesday".

See Also:

Constant Field Values

DAY_THURSDAY

public static final int DAY_THURSDAY

A constant value specifying the day of the week "Thursday".

See Also:

Constant Field Values

DAY_FRIDAY

public static final int DAY_FRIDAY

A constant value specifying the day of the week "Friday".

See Also:

Constant Field Values

DAY_SATURDAY

public static final int DAY_SATURDAY

A constant value specifying the day of the week "Saturday".

See Also:

Constant Field Values

Constructor Detail

UserAccount

public UserAccount(Server server)

Creates a new user account to be activated on the server. The new account will not actually be created until update() is called.

Parameters:

server - the server where the new account is to be created

Method Detail

copy

public UserAccount copy()

Creates a copy of this UserAccount object. Useful to applications that want to save a snapshot of the account information in a given state, for example, before calling ServerAdministration.refreshAccounts().

Returns:

A new copy of this UserAccount object.

See Also:

UserAccount.isEqualTo(com.starbase.starteam.UserAccount)

getID

public int getID()

Returns an integer ID that represents this user account.

Returns:

an integer ID that represents this user account.

getName

public java.lang.String getName()

Returns the full name that this user goes by.

Returns:

the full name that this user goes by.

setName

public void setName(java.lang.String name)

Changes the user's full name.

Parameters:

name - the new name for this user

getEmailAddress

public java.lang.String getEmailAddress()

Returns the user's email address.

Returns:

the user's email address.

setEmailAddress

public void setEmailAddress(java.lang.String emailAddress)

Changes the user's email address.

Parameters:

emailAddress - the new email address for this user

getPostalAddress

public java.lang.String getPostalAddress()

Returns the user's postal address.

Returns:

the user's postal address.

setPostalAddress

public void setPostalAddress(java.lang.String postalAddress)

Changes the user's postal address.

Parameters:

postalAddress - the user's new postal address

getFaxNumber

public java.lang.String getFaxNumber()

Returns the user's fax number.

Returns:

the user's fax number.

setFaxNumber

public void setFaxNumber(java.lang.String faxNumber)

Changes the user's fax number.

Parameters:

faxNumber - the user's new fax number.

getPagerNumber

public java.lang.String getPagerNumber()

Returns the user's pager number.

Returns:

the user's pager number.

setPagerNumber

public void setPagerNumber(java.lang.String pagerNumber)

Changes the user's pager number.

Parameters:

pagerNumber - the user's new pager number.

getPhoneNumber

public java.lang.String getPhoneNumber()

Returns the user's phone number.

Returns:

the user's phone number.

setPhoneNumber

public void setPhoneNumber(java.lang.String phoneNumber)

Changes the user's phone number.

Parameters:

phoneNumber - the user's new phone number.

getVoiceMailNumber

public java.lang.String getVoiceMailNumber()

Returns the user's voice mail number.

Returns:

the user's voice mail number.

setVoiceMailNumber

public void setVoiceMailNumber(java.lang.String voiceMailNumber)

Changes the user's voice mail number.

Parameters:

voiceMailNumber - the user's new voice mail number.

getLogOnName

public java.lang.String getLogOnName()

Returns the logon name or identifier for this account.

Returns:

the logon name or identifier for this account.

setLogOnName

public void setLogOnName(java.lang.String logOnName)

Changes the logon name for this account.

Parameters:

logOnName - the new logon name for this account

setPassword

public void setPassword(java.lang.String password)

Sets the password for this account. The password should be passed in as clear text.

Parameters:

password - the new password for this account

getAccountStatus

public int getAccountStatus()

Returns this account's status.

Returns:

this account's status.

See Also:

UserAccount.STATUS_NORMAL, UserAccount.STATUS_LOCKED_OUT, UserAccount.STATUS_SUSPENDED, UserAccount.STATUS_PASSWORD_CHANGE_REQUIRED, UserAccount.STATUS_PASSWORD_CHANGE_NOTIFIED

setAccountStatus

public void setAccountStatus(int status)

Modify this account's status.

Parameters:

status - this account's new status.

See Also:

UserAccount.STATUS_NORMAL, UserAccount.STATUS_LOCKED_OUT, UserAccount.STATUS_SUSPENDED, UserAccount.STATUS_PASSWORD_CHANGE_REQUIRED, UserAccount.STATUS_PASSWORD_CHANGE_NOTIFIED

getAccessPolicy

public int getAccessPolicy()

Return's this account's access policy. The access policy specifies when a user is allowed to connect to the server.

Returns:

this account's access policy

See Also:

UserAccount.POLICY_ALWAYS, UserAccount.POLICY_STANDARD, UserAccount.POLICY_CUSTOM

setAccessPolicy

public void setAccessPolicy(int policy)

Changes this account's access policy.

Parameters:

policy - this account's new access policy

See Also:

UserAccount.POLICY_ALWAYS, UserAccount.POLICY_STANDARD, UserAccount.POLICY_CUSTOM

getPolicyTimeZoneShift

public int getPolicyTimeZoneShift()

Return's the timezone shift for this account's access policy. This value only applies if the policy is other than POLICY_ALWAYS. The value is in hours from GMT.

Returns:

this timezone shift for this account's access policy.

See Also:

UserAccount.setPolicyTimeZoneShift(int)

setPolicyTimeZoneShift

public void setPolicyTimeZoneShift(int shift)

Changes timezone shift for this account's access policy.

Parameters:

shift - the new timezone shift for this account's access policy.

See Also:

UserAccount.getPolicyTimeZoneShift()

getLogOnCount

public int getLogOnCount()

Returns the number of times this user is logged in to the server.

Returns:

the number of times this user is logged in to the server.

getWorkstations

public java.lang.String[] getWorkstations()

Currently unused.

Returns:

a list of workstation names.

getValidateThroughDirectoryService

public boolean getValidateThroughDirectoryService()

Indicates whether the user validates through Directory Service. This property is supported by server release 6.0 and later; ignored for earlier releases.

Returns:

true if the user validates through Directory Service, otherwise false. This property is supported by server release 6.0 and later; ignored for earlier releases. Note that when setting this value to false, a valid password must also be set.

setValidateThroughDirectoryService

public void setValidateThroughDirectoryService(boolean bValidateThroughDirectoryService)

Sets whether user validates through Directory Service. Note that when setting this value to false, a valid password must also be set. This property is supported by server release 6.0 and later; ignored for earlier releases.

Parameters:

bValidateThroughDirectoryService - whether or not to validate through Directory Service

getDistinguishedName

public java.lang.String getDistinguishedName()

Gets the Distinguished Name for Directory Service. This property is supported by server release 6.0 and later; ignored for earlier releases.

Returns:

the Distinguished Name for Directory Service. This property is supported by server release 6.0 and later; ignored for earlier releases.

setDistinguishedName

public void setDistinguishedName(java.lang.String distinguishedName)

Sets the Distinguished Name for Directory Service. This property is supported by server release 6.0 and later; ignored for earlier releases.

Parameters:

distinguishedName - the Distinguished Name for Directory Service.

getHasFixedLicense

public boolean getHasFixedLicense()

Determines whether this user has a fixed ( named-user ) license or a floating ( concurrent ) license.

Returns:

True if this user has a fixed ( named-user ) license; false if this user has a floating ( concurrent ) license. Note that if the StarTeam Server does not support floating licenses, then every user has a fixed license.

setHasFixedLicense

public void setHasFixedLicense(boolean bFixed)

Sets the license type for this user.

Parameters:

bFixed - True if this user has a fixed ( named-user ) license; false if this user has a floating ( concurrent ) license. Note that it is an error to set a floating license if the StarTeam Server does not support them.

See Also:

SupportedFeatures.hasConcurrentLicensing()

getAccessStartTime1

public int getAccessStartTime1(int dayOfWeek)

Returns the start time for the specified day for the first custom access policy. The time is expressed in minutes from midnight. A value of -1 indicates access is denied on the specified day for the first custom access policy.

Parameters:

dayOfWeek - must be a valid day of the week

Returns:

the start time for the specified day for the first custom access policy.

See Also:

UserAccount.DAY_SUNDAY, UserAccount.DAY_MONDAY, UserAccount.DAY_TUESDAY, UserAccount.DAY_WEDNESDAY, UserAccount.DAY_THURSDAY, UserAccount.DAY_FRIDAY, UserAccount.DAY_SATURDAY

getAccessStartTime2

public int getAccessStartTime2(int dayOfWeek)

Returns the start time for the specified day for the second custom access policy. The time is expressed in minutes from midnight. A value of -1 indicates access is denied on the specified day for the second custom access policy.

Parameters:

dayOfWeek - must be a valid day of the week

Returns:

the start time for the specified day for the second custom access policy.

See Also:

UserAccount.DAY_SUNDAY, UserAccount.DAY_MONDAY, UserAccount.DAY_TUESDAY, UserAccount.DAY_WEDNESDAY, UserAccount.DAY_THURSDAY, UserAccount.DAY_FRIDAY, UserAccount.DAY_SATURDAY

getAccessEndTime1

public int getAccessEndTime1(int dayOfWeek)

Returns the end time for the specified day for the first custom access policy. The time is expressed in minutes from midnight. A value of -1 indicates access is denied on the specified day for the first custom access policy.

Parameters:

dayOfWeek - must be a valid day of the week

Returns:

the end time for the specified day for the first custom access policy.

See Also:

UserAccount.DAY_SUNDAY, UserAccount.DAY_MONDAY, UserAccount.DAY_TUESDAY, UserAccount.DAY_WEDNESDAY, UserAccount.DAY_THURSDAY, UserAccount.DAY_FRIDAY, UserAccount.DAY_SATURDAY

getAccessEndTime2

public int getAccessEndTime2(int dayOfWeek)

Returns the end time for the specified day for the second custom access policy. The time is expressed in minutes from midnight. A value of -1 indicates access is denied on the specified day for the second custom access policy.

Parameters:

dayOfWeek - a valid day of the week, e.g. DAY_SUNDAY

Returns:

the end time for the specified day for the second custom access policy.

See Also:

UserAccount.DAY_SUNDAY, UserAccount.DAY_MONDAY, UserAccount.DAY_TUESDAY, UserAccount.DAY_WEDNESDAY, UserAccount.DAY_THURSDAY, UserAccount.DAY_FRIDAY, UserAccount.DAY_SATURDAY

setAccessTimes

public void setAccessTimes(int dayOfWeek,
                           int start1,
                           int end1,
                           int start2,
                           int end2)

Changes the custom access policy start and end times for the specified day of the week.

Parameters:

dayOfWeek - a valid day of the week, e.g. DAY_SUNDAY

start1 - start time in minutes from midnight

end1 - end time in minutes from midnight

start2 - start time in minutes from midnight

end2 - end time in minutes from midnight

isNew

public boolean isNew()

Tells if this user account has been created on the server yet.

Returns:

true is this user account has not yet been created in the server.

toString

public java.lang.String toString()

Returns the name of this user account.

Overrides:

toString in class java.lang.Object

Returns:

the name of this user account.

addToGroupAccount

public void addToGroupAccount(GroupAccount groupAccount)

Adds this user to the specified group account. The group account cannot be null, must be from the same server at the user account and the group account must have already been created on the server. You must call update() to save the changes on the server.

Parameters:

groupAccount - the group account to which this user will be added.

removeFromGroupAccount

public void removeFromGroupAccount(GroupAccount groupAccount)

Removes this user from the specified group account. The group account cannot be null, must be from the same server at the user account and the group account must have already been created on the server. You must call update() to save the changes on the server.

Parameters:

groupAccount - the group account from which this user will be removed.

getGroupAccounts

public GroupAccount[] getGroupAccounts()

Returns all of the group accounts to which this user belongs.

Returns:

all of the group accounts to which this user belongs.

update

public void update()

Create or modify this UserAccount in the StarTeam Server. If the account is new it will be created otherwise the account information will be modified.

remove

public void remove()

Removes this user account from the server, and from any group of which it is a member.

unlock

public void unlock()

Unlocks this user account. The effect is immediate ( no need to call the update() method ).

Throws:

java.lang.IllegalStateException - if the UserAccount has not yet been created on the server

reactivate

public void reactivate()

Reactivates this user account. The effect is immediate ( no need to call the update() method ).

Throws:

java.lang.IllegalStateException - if the UserAccount has not yet been created on the server

suspend

public void suspend()

Suspend this user account. The effect is immediate ( no need to call the update() method ).

Throws:

java.lang.IllegalStateException - if the UserAccount has not yet been created on the server

forcePasswordChange

public void forcePasswordChange()

Forces a password change for this user account. The effect is immediate ( no need to call the update() method ).

Throws:

java.lang.IllegalStateException - if the UserAccount has not yet been created on the server

forceLogoff

public void forceLogoff()

Forces this user account to be logged off from the server. The effect is immediate ( no need to call the update() method ).

Throws:

java.lang.IllegalStateException - if the UserAccount has not yet been created on the server

isEqualTo

public boolean isEqualTo(UserAccount account)

Compares two UserAccount objects.

Parameters:

account - The UserAccount to be compared with this one.

Returns:

true if no differences were found.

See Also:

UserAccount.copy()

getCreatedTime

public OLEDate getCreatedTime()

Gets the time at which this UserAccount was created.

Returns:

The time at which this UserAccount was created.

getLicenseType

public int getLicenseType()

Gets the type of license assigned to this user.

Returns:

The type of license assigned to this user.

See Also:

UserAccount.LICENSE_TYPE_STARTEAM, UserAccount.LICENSE_TYPE_LICENSE_SERVER, UserAccount.LICENSE_TYPE_UNASSIGNED, SupportedFeatures.hasBLSLicensing()

setLicenseType

public void setLicenseType(int nLicenseType)

Sets the type of license assigned to this user.

Parameters:

nLicenseType - The type of license assigned to this user.

getBLSSlipGuid

public int getBLSSlipGuid()

Gets the Slip ID assigned to this license.

Returns:

The Slip ID assigned to this license, or 0 if this user does not have a license managed by the Borland License Server.

See Also:

SupportedFeatures.hasBLSLicensing()

setBLSSlipGuid

public void setBLSSlipGuid(int nSlipGuid)

Sets the Slip ID assigned to this license.

Parameters:

nSlipGuid - The Slip ID assigned to this license.

See Also:

ServerLicenseInfo.getBLSLicenses(), SupportedFeatures.hasBLSLicensing()

equals

public boolean equals(java.lang.Object source)

returns true if this object instance is equal to the source

Overrides:

equals in class java.lang.Object

Parameters:

source - Object the source to comapre with

Returns:

boolean true if this object is equal to the source

hashCode

public int hashCode()

returns a unique hash for all instances of this type

Overrides:

hashCode in class java.lang.Object

Returns:

int a unique hash for all instances of this type