public class UserAttributes
extends java.lang.Object
Modifier and Type | Method and Description |
---|---|
void |
disableLogonTimeSpan()
Disables the logon time span limitation.
|
CalendarCondition |
getCalendar()
Returns the authorization check according to the Calendar.
|
UC4ObjectName |
getDefaultLogin()
Returns the Login object for the database access of Variable objects with the source "SQL".
|
java.lang.String |
getDistinguishedName()
Returns the distinguished name of this user.
|
java.lang.String |
getEmail1()
Returns the first Email address of this user.
|
java.lang.String |
getEmail2()
Returns the second Email address of this user.
|
java.lang.String |
getFirstName() |
java.lang.String |
getLastName() |
int |
getMaxParallelSessions()
Returns the maximum number of parallel login sessions a user may have.
|
int |
getMinActivityRefresh()
Returns the User-specific minimum interval in seconds for refreshing activities (display refresh).
|
UC4TimezoneName |
getTimezone()
Returns the TimeZone to be used for this user following System logon.
|
Time |
getValidTimeFrom()
If
hasLogonTimeSpan() is true this method returns the lower limit of the allowed logon time. |
Time |
getValidTimeTo()
If
hasLogonTimeSpan() is true this method returns the upper limit of the allowed logon time. |
boolean |
hasLogonTimeSpan()
Returns
true if a logon time span has been set for this User. |
boolean |
isActive()
Returns
true if the user is active. |
boolean |
isIgnoreSSO()
Returns
true if SSO is to be ignored. |
boolean |
isLDAPConnection()
Returns
true if LDAP is enabled. |
boolean |
isLocked()
Returns
true if the user is locked. |
boolean |
isPasswordChangeRequired()
Returns
true if a password change is required for this user. |
boolean |
isPasswordNeverExpires()
Returns
true if the password never expires. |
void |
setActive(boolean active)
Changes the status of this User.
|
void |
setCalendar(CalendarCondition cond)
Sets the authorization check according to the Calendar.
|
void |
setDefaultLogin(UC4ObjectName defaultLogin)
Sets the Login object for the database access of Variable objects with the source "SQL".
|
void |
setDistinguishedName(java.lang.String distinguishedName)
Set the distinguished name for the LDAP connection.
|
void |
setEmail1(java.lang.String email1)
Sets the first Email address of this user.
|
void |
setEmail2(java.lang.String email2)
Sets the second Email address of this user.
|
void |
setFirstName(java.lang.String firstName)
Sets the first name of this user.
|
void |
setIgnoreSSO(boolean ignoreSSO)
Changes the ignore SSO setting.
|
void |
setLastName(java.lang.String lastName)
Sets the last name of the user.
|
void |
setLDAPConnection(boolean ldapConnection)
Enables or disables the LDAP Connection.
|
void |
setLocked(boolean locked)
This method can be used to lock or unlock a User.
|
void |
setLogonTimeSpan(Time from,
Time to)
Sets the time span in which a logon is allowed.
|
void |
setMaxParallelSessions(int multiLogon)
Sets the maximum number of parallel login sessions a user may have.
|
void |
setMinActivityRefresh(int refresh)
Sets the User-specific minimum interval in seconds for refreshing activities (display refresh).
|
void |
setPassword(java.lang.String pass)
Sets the password of this user.
|
void |
setPasswordChangeRequired(boolean passwordMustChange)
Changes the setting for a password change.
|
void |
setPasswordNeverExpires(boolean passwordNeverExpires)
Changes the password expiration setting.
|
void |
setTimezone(UC4TimezoneName timezone)
Sets the TimeZone to be used for this user following System logon.
|
public void setPassword(java.lang.String pass)
pass
- Passwordpublic boolean isActive()
true
if the user is active.
Active means that the user may log on to the Automation Engine.
Inactive users must not log on to the system; logically, they are no longer part of the system.true
if the user is activepublic void setActive(boolean active)
active
- true
if the user should be active, false
if the user should not be allowed to log on to the system.public boolean isLocked()
true
if the user is locked.
The repeated indication of a wrong password has the effect that a user is locked.true
if the user is lockedpublic void setLocked(boolean locked)
locked
- true
if the user should be locked, false
to unlock the userpublic java.lang.String getFirstName()
public void setFirstName(java.lang.String firstName)
firstName
- User's first name, max. 20 characterspublic java.lang.String getLastName()
public void setLastName(java.lang.String lastName)
lastName
- User's last name, max. 20 characterspublic java.lang.String getEmail1()
public void setEmail1(java.lang.String email1)
email1
- User's Email address, max. 50 characterspublic java.lang.String getEmail2()
public void setEmail2(java.lang.String email2)
email2
- User's Email address, max. 50 characterspublic UC4ObjectName getDefaultLogin()
public void setDefaultLogin(UC4ObjectName defaultLogin)
defaultLogin
- Name of the LOGIN Objectpublic boolean isPasswordNeverExpires()
true
if the password never expires.
In this case the user never has to change the password.
The password "pass" is an exception and must always be changed immediately at the next logon.true
if the password never expires, false
otherwisepublic void setPasswordNeverExpires(boolean passwordNeverExpires)
passwordNeverExpires
is true
the user never has to change the password.
The password "pass" is an exception and must always be changed immediately at the next logon.passwordNeverExpires
- true
if the password should never expires, false
otherwisepublic boolean isIgnoreSSO()
true
if SSO is to be ignored.true
if SSO is to be ignored, false
otherwisepublic void setIgnoreSSO(boolean ignoreSSO)
ignoreSSO
- true
if SSO is to be ignored, false
otherwisepublic boolean isPasswordChangeRequired()
true
if a password change is required for this user.true
if the User has to change the password at next loginpublic void setPasswordChangeRequired(boolean passwordMustChange)
passwordMustChange
- true
if the User has to change the password at next loginpublic boolean isLDAPConnection()
true
if LDAP is enabled.public void setLDAPConnection(boolean ldapConnection)
ldapConnection
- true
if LDAP should be enabled for this user.public java.lang.String getDistinguishedName()
public void setDistinguishedName(java.lang.String distinguishedName)
distinguishedName
- Distinguished namepublic UC4TimezoneName getTimezone()
public void setTimezone(UC4TimezoneName timezone)
timezone
- Name of the timezone objectpublic Time getValidTimeFrom()
hasLogonTimeSpan()
is true
this method returns the lower limit of the allowed logon time.public Time getValidTimeTo()
hasLogonTimeSpan()
is true
this method returns the upper limit of the allowed logon time.public boolean hasLogonTimeSpan()
true
if a logon time span has been set for this User.
Logon is denied when attempted outside of the defined time frame.true
if a logon time span is setpublic void setLogonTimeSpan(Time from, Time to)
from
- Lower limit of the logon timeto
- Upper limit of the logon timepublic void disableLogonTimeSpan()
public void setCalendar(CalendarCondition cond)
cond
- Name and Keyword of a UC4 calendarpublic CalendarCondition getCalendar()
null
public int getMaxParallelSessions()
public void setMaxParallelSessions(int multiLogon)
multiLogon
- Maximum number of parallel login sessions, values from 0 to 9999 are allowedpublic int getMinActivityRefresh()
public void setMinActivityRefresh(int refresh)
refresh
- Interval in seconds, values from 0 to 999 are allowed