com.ibm.as400.access
Class User

java.lang.Object
  |
  +--com.ibm.as400.access.User

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

UserGroup

public class User

extends java.lang.Object

implements java.io.Serializable

The User class represents an AS/400 user profile and directory entry.

Some of the attributes have associated get and set methods defined in this class. These are provided for backwards compatibility with previous versions of the AS/400 Toolbox for Java. The complete set of attribute values can be accessed using the RUser class.

See Also:

RUser, Serialized Form

Constructor Summary

User()
Constructs a User object.

User(AS400 system, java.lang.String name)
Constructs a User object.

Method Summary

void	addPropertyChangeListener(java.beans.PropertyChangeListener listener) Adds a PropertyChangeListener.
void	addVetoableChangeListener(java.beans.VetoableChangeListener listener) Adds a VetoableChangeListener.
java.lang.String	getAccountingCode() Returns the accounting code that is associated with this user.
java.lang.String	getAssistanceLevel() Returns the user interface that the user will use.
java.lang.String	getAttentionKeyHandlingProgram() Returns the fully qualified integrated file system path name of the attention key handling program for this user.
int	getCCSID() Returns the character code set ID to be used by the system for this user.
java.lang.String	getCountryID() Returns the country ID used by the system for this user.
java.lang.String	getCurrentLibraryName() Returns the name of the user's current library.
int	getDaysUntilPasswordExpire() Returns the number of days until the password will expire.
java.lang.String	getDescription() Returns the descriptive text for the user profile.
java.lang.String	getDisplaySignOnInformation() Returns whether the sign-on information display is shown when the user signs on.
java.lang.String	getGroupAuthority() Returns the authority the user's group profile has to objects the user creates.
java.lang.String	getGroupAuthorityType() Returns the type of authority the user's group has to objects the user creates.
int	getGroupIDNumber() Returns the group ID number for the user profile.
java.lang.String	getGroupProfileName() Returns the name of the group profile.
int	getHighestSchedulingPriority() Returns the highest scheduling priority the user is allowed to have for each job submitted to the system.
java.lang.String	getHomeDirectory() Returns the home directory for this user profile.
java.lang.String	getInitialMenu() Returns the fully qualified integrated file system path name of the initial menu for the user.
java.lang.String	getInitialProgram() Returns the fully qualified integrated file system path name of the initial program for the user.
java.lang.String	getJobDescription() Returns the fully qualified integrated file system path name of the job description used for jobs that start through subsystem work station entries.
java.lang.String	getLanguageID() Returns the language ID used by the system for this user.
java.lang.String	getLimitCapabilities() Indicates whether the user has limited capabilites.
java.lang.String	getLimitDeviceSessions() Indicates whether the user is limited to one device session.
java.lang.String[]	getLocaleJobAttributes() Returns a list of attributes which are set from the locale path name at the time a job is started for this user.
java.lang.String	getLocalePathName() Returns the locale path name that is assigned to the user profile when a job is started.
int	getMaximumStorageAllowed() Returns the maximum amount of auxiliary storage (in kilobytes) that can be assigned to store permanant objects owned by the user.
java.lang.String	getMessageQueue() Returns the fully qualified integrated file system path name of the message queue that is used by this user.
java.lang.String	getMessageQueueDeliveryMethod() Returns how the messages are delivered to the message queue used by the user.
int	getMessageQueueSeverity() Returns the lowest severity that a message can have and still be delivered to a user in break or notify mode.
java.lang.String	getName() Returns the user profile name.
java.lang.String	getObjectAuditingValue() Returns the user's object auditing value.
java.lang.String	getOutputQueue() Returns the fully qualified integrated file system path name of the output queue that is used by this user.
java.lang.String	getOwner() Indicates who is to own objects created by this user.
int	getPasswordExpirationInterval() Returns the number of days the user's password can remain active before it must be changed.
java.util.Date	getPasswordExpireDate() Returns the date the user's password expires.
java.util.Date	getPasswordLastChangedDate() Returns the date the user's password was last changed.
java.util.Date	getPreviousSignedOnDate() Returns the date and time the user last signed on.
java.lang.String	getPrintDevice() Returns the printer used to print for this user.
int	getSignedOnAttemptsNotValid() Returns the number of sign-on attempts that were not valid since the last successful sign-on.
java.lang.String	getSortSequenceTable() Returns the fully integrated file system path name of the sort sequence table used for string comparisons.
java.lang.String[]	getSpecialAuthority() Returns a list of special authorities that the user has.
java.lang.String	getSpecialEnvironment() Returns the special environment the user operates in after signing on.
java.lang.String	getStatus() Returns the status of the user profile.
int	getStorageUsed() Returns the amount of auxiliary storage (in kilobytes) occupied by this user's owned objects.
java.lang.String[]	getSupplementalGroups() Returns the supplemental groups for the user profile.
int	getSupplementalGroupsNumber() Returns the number of supplemental groups for the user profile.
AS400	getSystem() Returns the system.
java.lang.String[]	getUserActionAuditLevel() Returns a list of action audit levels for the user.
java.lang.String	getUserClassName() Returns the user class name.
int	getUserIDNumber() Returns the user ID number for the user profile.
java.lang.String	getUserProfileName() Returns the name of the user profile.
boolean	isGroupHasMember() Indicates whether this user is a group that has members.
boolean	isNoPassword() Indicates whether there is no password.
boolean	isPasswordSetExpire() Indicates whether the user's password is set to expire, requiring the user to change the password when signing on.
boolean	isWithDigitalCertificates() Indicates whether there are digital certificates associated with this user.
void	loadUserInformation() Refreshes the values for all attributes.
void	removePropertyChangeListener(java.beans.PropertyChangeListener listener) Removes a PropertyChangeListener.
void	removeVetoableChangeListener(java.beans.VetoableChangeListener listener) Removes a VetoableChangeListener.
void	setName(java.lang.String name) Sets the user profile name.
void	setSystem(AS400 system) Sets the system.
java.lang.String	toString() Returns the user profile name.

Methods inherited from class java.lang.Object

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

Constructor Detail

User

public User()

Constructs a User object.

User

public User(AS400 system,
            java.lang.String name)
     throws AS400Exception,
            AS400SecurityException,
            ConnectionDroppedException,
            ErrorCompletingRequestException,
            java.lang.InterruptedException,
            ObjectDoesNotExistException,
            java.io.IOException,
            java.io.UnsupportedEncodingException

Constructs a User object.

Parameters:

system - The system.

name - The user profile name.

Throws:

AS400Exception - If the AS/400 system returns an error message.

AS400SecurityException - If a security or authority error occurs.

ConnectionDroppedException - If the connection is dropped unexpectedly.

ErrorCompletingRequestException - If an error occurs before the request is completed.

java.lang.InterruptedException - If this thread is interrupted.

java.io.IOException - If an error occurs while communicating with the AS/400.

ObjectDoesNotExistException - If the AS/400 object does not exist.

java.io.UnsupportedEncodingException - If the character encoding is not supported.

Method Detail

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

Adds a PropertyChangeListener. The specified PropertyChangeListener's propertyChange() method will be called each time the value of any bound property is changed.

Parameters:

listener - The listener.

addVetoableChangeListener

public void addVetoableChangeListener(java.beans.VetoableChangeListener listener)

Adds a VetoableChangeListener. The specified VetoableChangeListener's vetoableChange() method will be called each time the value of any constrained property is changed.

Parameters:

listener - The listener.

getAccountingCode

public java.lang.String getAccountingCode()

Returns the accounting code that is associated with this user.

Returns:

The accounting code that is associated with this user.

See Also:

RUser.ACCOUNTING_CODE

getAssistanceLevel

public java.lang.String getAssistanceLevel()

Returns the user interface that the user will use.

Returns:

The user interface that the user will use. Possible values are:

• SYSTEM_VALUE - The system value QASTLVL determines which user interface the user is using.
• ASSISTANCE_LEVEL_BASIC - The Operational Assistant user interface.
• ASSISTANCE_LEVEL_INTERMEDIATE - The system user interface.
• ASSISTANCE_LEVEL_ADVANCED - The expert system user interface.

See Also:

RUser.ASSISTANCE_LEVEL

getAttentionKeyHandlingProgram

public java.lang.String getAttentionKeyHandlingProgram()

Returns the fully qualified integrated file system path name of the attention key handling program for this user.

Returns:

The fully qualified integrated file system path name of the attention key handling program for this user. Possible values are:

• SYSTEM_VALUE - The system value QATNPGM determines the user's attention key handling program.
• NONE - No attention key handling program is used.
• ATTENTION_KEY_HANDLING_PROGRAM_ASSIST - The Operational Assistant attention key handling program.
• The attention key handling program name.

See Also:

RUser.ATTENTION_KEY_HANDLING_PROGRAM, QSYSObjectPathName

getCCSID

public int getCCSID()

Returns the character code set ID to be used by the system for this user.

Returns:

The character code set ID to be used by the system for this user.

See Also:

RUser.CHARACTER_CODE_SET_ID

getCountryID

public java.lang.String getCountryID()

Returns the country ID used by the system for this user.

Returns:

The country ID used by the system for this user. Possible values are:

• SYSTEM_VALUE - The system value QCNTRYID will be used to determine the country ID.
• A country ID.

See Also:

RUser.COUNTRY_ID

getCurrentLibraryName

public java.lang.String getCurrentLibraryName()

Returns the name of the user's current library.

Returns:

The name of the user's current library. Possible values are:

• CURRENT_LIBRARY_NAME_DEFAULT - The user does not have a current library.
• A library name.

See Also:

RUser.CURRENT_LIBRARY_NAME

getDaysUntilPasswordExpire

public int getDaysUntilPasswordExpire()

Returns the number of days until the password will expire.

Returns:

The number of days until the password will expire. Possible values are:

• 0 - The password is expired.
• 1-7 - The number of days until the password expires.
• -1 - The password will not expire in the next 7 days.

See Also:

RUser.DAYS_UNTIL_PASSWORD_EXPIRES

getDescription

public java.lang.String getDescription()

Returns the descriptive text for the user profile.

Returns:

The descriptive text for the user profile.

See Also:

RUser.TEXT_DESCRIPTION

getDisplaySignOnInformation

public java.lang.String getDisplaySignOnInformation()

Returns whether the sign-on information display is shown when the user signs on.

Returns:

Whether the sign-on information display is shown when the user signs on. Possible values are:

• SYSTEM_VALUE - The system value QDSPSGNINF determines if the sign-on information display is shown when the user signs on.
• YES - The sign-on information display is shown when the user signs on.
• NO - The sign-on information display is not shown when the user signs on.

See Also:

RUser.DISPLAY_SIGN_ON_INFORMATION

getGroupAuthority

public java.lang.String getGroupAuthority()

Returns the authority the user's group profile has to objects the user creates.

Returns:

The authority the user's group profile has to objects the user creates. Possible values are:

• NONE - The group profile has no authority to the objects the user creates, or the user does not have a group profile.
• GROUP_AUTHORITY_ALL - The group profile has all authority to the objects the user creates.
• GROUP_AUTHORITY_CHANGE - The group profile has change authority to the objects the user creates.
• GROUP_AUTHORITY_USE - The group profile has use authority to the objects the user creates.
• GROUP_AUTHORITY_EXCLUDE - The group profile has exclude authority to the objects the user creates.

See Also:

RUser.GROUP_AUTHORITY

getGroupAuthorityType

public java.lang.String getGroupAuthorityType()

Returns the type of authority the user's group has to objects the user creates.

Returns:

The type of authority the user's group has to objects the user creates. Possible values are:

• GROUP_AUTHORITY_TYPE_PRIVATE - The group profile has a private authority to the objects the user creates, or the user does not have a group profile.
• GROUP_AUTHORITY_TYPE_PGP - The group profile will be the primary group for objects the user creates.

See Also:

RUser.GROUP_AUTHORITY_TYPE

getGroupIDNumber

public int getGroupIDNumber()

Returns the group ID number for the user profile. The group ID number is used to identify the user when it is a group and a member of the group is using the integrated file system.

Returns:

The group ID number for the user profile. This will be 0 if the user does not have a group ID.

See Also:

RUser.GROUP_ID_NUMBER

getGroupProfileName

public java.lang.String getGroupProfileName()

Returns the name of the group profile.

Returns:

The name of the group profile. Possible values are:

• NONE - If the user does not have a group profile.
• The group profile name.

See Also:

RUser.GROUP_PROFILE_NAME

getHighestSchedulingPriority

public int getHighestSchedulingPriority()
                                 throws java.lang.NumberFormatException

Returns the highest scheduling priority the user is allowed to have for each job submitted to the system.

Returns:

The highest scheduling priority the user is allowed to have for each job submitted to the system. The priority is a value from 0 to 9, with 0 being the highest priority.

See Also:

RUser.HIGHEST_SCHEDULING_PRIORITY

getHomeDirectory

public java.lang.String getHomeDirectory()

Returns the home directory for this user profile.

Returns:

The home directory for this user profile.

See Also:

RUser.HOME_DIRECTORY

getInitialMenu

public java.lang.String getInitialMenu()

Returns the fully qualified integrated file system path name of the initial menu for the user.

Returns:

The fully qualified integrated file system path name of the initial menu for the user. Possible values are:

• INITIAL_MENU_SIGNOFF
• The initial menu name.

See Also:

RUser.INITIAL_MENU, QSYSObjectPathName

getInitialProgram

public java.lang.String getInitialProgram()

Returns the fully qualified integrated file system path name of the initial program for the user.

Returns:

The fully qualified integrated file system path name of the initial program for the user.

See Also:

RUser.INITIAL_PROGRAM, QSYSObjectPathName

getJobDescription

public java.lang.String getJobDescription()

Returns the fully qualified integrated file system path name of the job description used for jobs that start through subsystem work station entries.

Returns:

The fully qualified integrated file system path name of the job description used for jobs that start through subsystem work station entries.

See Also:

RUser.JOB_DESCRIPTION, QSYSObjectPathName

getLanguageID

public java.lang.String getLanguageID()

Returns the language ID used by the system for this user.

Returns:

The language ID used by the system for this user. Possible values are:

• SYSTEM_VALUE - The system value QLANGID will be used to determine the language ID.
• The language ID.

See Also:

RUser.LANGUAGE_ID

getLimitCapabilities

public java.lang.String getLimitCapabilities()

Indicates whether the user has limited capabilites.

Returns:

Whether the user has limited capabilites. Possible values are:

• LIMIT_CAPABILITIES_PARTIAL - The user cannot change the initial program or current library.
• YES - The user cannot change the initial menu, initial program, or current library. The user cannot run commands from the command line.
• NO - The user is not limited.

See Also:

RUser.LIMIT_CAPABILITIES

getLimitDeviceSessions

public java.lang.String getLimitDeviceSessions()

Indicates whether the user is limited to one device session.

Returns:

Whether the user is limited to one device session. Possible values are:

• SYSTEM_VALUE - The system value QLMTDEVSSN determines if the user is limited to one device session.
• YES - The user is limited to one session.
• NO - The user is not limited to one device session.

See Also:

RUser.LIMIT_DEVICE_SESSIONS

getLocaleJobAttributes

public java.lang.String[] getLocaleJobAttributes()

Returns a list of attributes which are set from the locale path name at the time a job is started for this user.

Returns:

A list of attributes which are set from the locale path name at the time a job is started for this user. Possible values for the elements of this array are:

• NONE - No job attributes are used from the locale path name at the time a job is started for this user profile.
• SYSTEM_VALUE - The job attributes assigned from the locale path name are determined by the system value QSETJOBATR at the time a job is started for this user profile.
• LOCALE_JOB_ATTRIBUTES_CCSID - The coded character set identifier is set from the locale path name at the time a job is started for this user profile.
• LOCALE_JOB_ATTRIBUTES_DATE_FORMAT - The date format is set from the locale path name at the time a job is started for this user profile.
• LOCALE_JOB_ATTRIBUTES_DATE_SEPARATOR - The date separator is set from the locale path name at the time a job is started for this user profile.
• LOCALE_JOB_ATTRIBUTES_SORT_SEQUENCE - The sort sequence is set from the locale path name at the time a job is started for this user profile.
• LOCALE_JOB_ATTRIBUTES_TIME_SEPARATOR - The time separator is set from the locale path name at the time a job is started for this user profile.
• LOCALE_JOB_ATTRIBUTES_DECIMAL_FORMAT - The decimal format is set from the locale path name at the time a job is started for this user profile.

See Also:

RUser.LOCALE_JOB_ATTRIBUTES

getLocalePathName

public java.lang.String getLocalePathName()

Returns the locale path name that is assigned to the user profile when a job is started.

Returns:

The locale path name that is assigned to the user profile when a job is started. Possible values are:

• SYSTEM_VALUE - The QLOCALE system value is used to determine the locale path name.
• NONE - No locale path name is assigned.
• LOCALE_PATH_NAME_C - The C locale path name is assigned.
• LOCALE_PATH_NAME_POSIX - The POSIX locale path name is assigned.

See Also:

RUser.LOCALE_PATH_NAME

getMaximumStorageAllowed

public int getMaximumStorageAllowed()

Returns the maximum amount of auxiliary storage (in kilobytes) that can be assigned to store permanant objects owned by the user.

Returns:

The maximum amount of auxiliary storage (in kilobytes) that can be assigned to store permanant objects owned by the user. If the user does not have a maximum amount of allowed storage, this will be -1.

See Also:

RUser.MAXIMUM_ALLOWED_STORAGE

getMessageQueue

public java.lang.String getMessageQueue()

Returns the fully qualified integrated file system path name of the message queue that is used by this user.

Returns:

The fully qualified integrated file system path name of the message queue that is used by this user.

See Also:

RUser.MESSAGE_QUEUE, QSYSObjectPathName

getMessageQueueDeliveryMethod

public java.lang.String getMessageQueueDeliveryMethod()

Returns how the messages are delivered to the message queue used by the user.

Returns:

How the messages are delivered to the message queue used by the user. Possible values are:

• MESSAGE_QUEUE_DELIVERY_METHOD_BREAK - The job to which the message queue is assigned is interrupted when a message arrives on the message queue.
• MESSAGE_QUEUE_DELIVERY_METHOD_DEFAULT - Messages requiring replies are answered with their default reply.
• MESSAGE_QUEUE_DELIVERY_METHOD_HOLD - The messages are held in the message queue until they are requested by the user or program.
• MESSAGE_QUEUE_DELIVERY_METHOD_NOTIFY - The job to which the message queue is assigned is notified when a message arrives on the message queue.

See Also:

RUser.MESSAGE_QUEUE_DELIVERY_METHOD

getMessageQueueSeverity

public int getMessageQueueSeverity()

Returns the lowest severity that a message can have and still be delivered to a user in break or notify mode.

Returns:

The lowest severity that a message can have and still be delivered to a user in break or notify mode.

See Also:

RUser.MESSAGE_QUEUE_SEVERITY

getName

public java.lang.String getName()

Returns the user profile name.

Returns:

The user profile name.

getObjectAuditingValue

public java.lang.String getObjectAuditingValue()

Returns the user's object auditing value.

Returns:

The user's object auditing value. Possible values are:

• NONE - No additional object auditing is done for the user.
• OBJECT_AUDITING_VALUE_CHANGE - Object changes are audited for the user if the object's auditing value is *USRPRF.
• OBJECT_AUDITING_VALUE_ALL - Object read and change operations are audited for the user if the object's auditing value is *USRPRF.

See Also:

RUser.OBJECT_AUDITING_VALUE

getOutputQueue

public java.lang.String getOutputQueue()

Returns the fully qualified integrated file system path name of the output queue that is used by this user.

Returns:

The fully qualified integrated file system path name of the output queue that is used by this user. Possible values are:

• OUTPUT_QUEUE_WORK_STATION - The output queue assigned to the user's work station is used.
• OUTPUT_QUEUE_DEVICE - An output queue with the same name as the device specified in the printer device parameter is used.
• The output queue name.

See Also:

RUser.OUTPUT_QUEUE, QSYSObjectPathName

getOwner

public java.lang.String getOwner()

Indicates who is to own objects created by this user.

Returns:

Who is to own objects created by this user. Possible values are:

• OWNER_USER_PROFILE - The user owns any objects the user creates. If the user does not have a group profile, the field contains this value.
• OWNER_GROUP_PROFILE - The user's group profile owns any objects the user creates.

See Also:

RUser.OWNER

getPasswordExpireDate

public java.util.Date getPasswordExpireDate()

Returns the date the user's password expires.

Returns:

The date the user's password expires.

See Also:

RUser.DATE_PASSWORD_EXPIRES

getPasswordExpirationInterval

public int getPasswordExpirationInterval()

Returns the number of days the user's password can remain active before it must be changed.

Returns:

The number of days the user's password can remain active before it must be changed. Possible values are:

• 0 - The system value QPWDEXPITV is used to determine the user's password expiration interval.
• -1 - The user's password does not expire.
• The number of days the user's password can remain active before it must be changed.

See Also:

RUser.PASSWORD_EXPIRATION_INTERVAL

getPasswordLastChangedDate

public java.util.Date getPasswordLastChangedDate()

Returns the date the user's password was last changed.

Returns:

The date the user's password was last changed.

See Also:

RUser.PASSWORD_CHANGE_DATE

getPreviousSignedOnDate

public java.util.Date getPreviousSignedOnDate()

Returns the date and time the user last signed on.

Returns:

The date and time the user last signed on.

See Also:

RUser.PREVIOUS_SIGN_ON

getPrintDevice

public java.lang.String getPrintDevice()

Returns the printer used to print for this user.

Returns:

The printer used to print for this user. Possible values are:

• PRINT_DEVICE_WORK_STATION - The printer assigned to the user's work station is used.
• SYSTEM_VALUE - The default system printer specified in the system value QPRTDEV is used.
• The print device.

See Also:

RUser.PRINT_DEVICE

getSignedOnAttemptsNotValid

public int getSignedOnAttemptsNotValid()

Returns the number of sign-on attempts that were not valid since the last successful sign-on.

Returns:

The number of sign-on attempts that were not valid since the last successful sign-on.

See Also:

RUser.SIGN_ON_ATTEMPTS_NOT_VALID

getSortSequenceTable

public java.lang.String getSortSequenceTable()

Returns the fully integrated file system path name of the sort sequence table used for string comparisons.

Returns:

The fully integrated file system path name of the sort sequence table used for string comparisons. Possible values are:

• SORT_SEQUENCE_TABLE_HEX - The hexadecimal values of the characters are used to determine the sort sequence.
• SORT_SEQUENCE_TABLE_UNIQUE - A unique-weight sort table associated with the language specified.
• SORT_SEQUENCE_TABLE_SHARED - A shared-weight sort table associated with the language specified.
• SYSTEM_VALUE - The system value QSRTSEQ.
• The sort sequence table name.

See Also:

RUser.SORT_SEQUENCE_TABLE, QSYSObjectPathName

getSpecialAuthority

public java.lang.String[] getSpecialAuthority()

Returns a list of special authorities that the user has.

Returns:

A list of special authorities that the user has. Possible values for the elements of this array are:

• SPECIAL_AUTHORITIES_ALL_OBJECT - All object.
• SPECIAL_AUTHORITIES_SECURITY_ADMINISTRATOR - Security administrator.
• SPECIAL_AUTHORITIES_JOB_CONTROL - Job control.
• SPECIAL_AUTHORITIES_SPOOL_CONTROL - Spool control.
• SPECIAL_AUTHORITIES_SAVE_SYSTEM - Save system.
• SPECIAL_AUTHORITIES_SERVICE - Service.
• SPECIAL_AUTHORITIES_AUDIT - Audit.
• SPECIAL_AUTHORITIES_IO_SYSTEM_CONFIGURATION - Input/output system configuration.

See Also:

RUser.SPECIAL_AUTHORITIES

getSpecialEnvironment

public java.lang.String getSpecialEnvironment()

Returns the special environment the user operates in after signing on.

Returns:

The special environment the user operates in after signing on. Possible values are:

• SYSTEM_VALUE - The system value QSPCENV is used to determine the user's special environment.
• NONE - The user operates in the OS/400 environment.
• SPECIAL_ENVIRONMENT_SYSTEM_36 - The user operates in the System/36 environment.

See Also:

RUser.SPECIAL_ENVIRONMENT

getStatus

public java.lang.String getStatus()

Returns the status of the user profile.

Returns:

The status of the user profile. Possible values are:

• STATUS_ENABLED - The user profile is enabled.
• STATUS_NOT_ENABLED - The user profile is not enabled.

See Also:

RUser.STATUS

getStorageUsed

public int getStorageUsed()

Returns the amount of auxiliary storage (in kilobytes) occupied by this user's owned objects.

Returns:

The amount of auxiliary storage (in kilobytes) occupied by this user's owned objects.

See Also:

RUser.STORAGE_USED

getSupplementalGroups

public java.lang.String[] getSupplementalGroups()

Returns the supplemental groups for the user profile.

Returns:

The supplemental groups for the user profile.

See Also:

RUser.SUPPLEMENTAL_GROUPS

getSupplementalGroupsNumber

public int getSupplementalGroupsNumber()

Returns the number of supplemental groups for the user profile.

Returns:

The number of supplemental groups for the user profile.

See Also:

RUser.SUPPLEMENTAL_GROUPS

getSystem

public AS400 getSystem()

Returns the system.

Returns:

The system.

getUserActionAuditLevel

public java.lang.String[] getUserActionAuditLevel()

Returns a list of action audit levels for the user.

Returns:

A list of action audit levels for the user. Possible values for the elements of this array are:

• USER_ACTION_AUDIT_LEVEL_COMMAND - The user has the *CMD audit value specified in the user profile.
• USER_ACTION_AUDIT_LEVEL_CREATE - The user has the *CREATE audit value specified in the user profile.
• USER_ACTION_AUDIT_LEVEL_DELETE - The user has the *DELETE audit value specified in the user profile.
• USER_ACTION_AUDIT_LEVEL_JOB_DATA - The user has the *JOBDTA audit value specified in the user profile.
• USER_ACTION_AUDIT_LEVEL_OBJECT_MANAGEMENT - The user has the *OBJMGT audit value specified in the user profile.
• USER_ACTION_AUDIT_LEVEL_OFFICE_SERVICES - The user has the *OFCSRV audit value specified in the user profile.
• USER_ACTION_AUDIT_LEVEL_OPTICAL - The user has the *OPTICAL audit value specified in the user profile.
• USER_ACTION_AUDIT_LEVEL_PROGRAM_ADOPTION - The user has the *PGMADP audit value specified in the user profile.
• USER_ACTION_AUDIT_LEVEL_SAVE_RESTORE - The user has the *SAVRST audit value specified in the user profile.
• USER_ACTION_AUDIT_LEVEL_SECURITY - The user has the *SECURITY audit value specified in the user profile.
• USER_ACTION_AUDIT_LEVEL_SERVICE - The user has the *SERVICE audit value specified in the user profile.
• USER_ACTION_AUDIT_LEVEL_SPOOLED_FILE_DATA - The user has the *SPLFDTA audit value specified in the user profile.
• USER_ACTION_AUDIT_LEVEL_SYSTEM_MANAGEMENT - The user has the *SYSMGT audit value specified in the user profile.

See Also:

RUser.USER_ACTION_AUDIT_LEVEL

getUserClassName

public java.lang.String getUserClassName()

Returns the user class name.

Returns:

The user class name. Possible values are:

• USER_CLASS_SECURITY_OFFICER - The user has a class of security officer.
• USER_CLASS_SECURITY_ADMINISTRATOR - The user has a class of security administrator.
• USER_CLASS_PROGRAMMER - The user has a class of programmer.
• USER_CLASS_SYSTEM_OPERATOR - The user has a class of system operator.
• USER_CLASS_USER - The user has a class of end user.

See Also:

RUser.USER_CLASS

getUserIDNumber

public int getUserIDNumber()

Returns the user ID number for the user profile. This is used to identify the user when using the integrated file system.

Returns:

The user ID number for the user profile.

See Also:

RUser.USER_ID_NUMBER

getUserProfileName

public java.lang.String getUserProfileName()

Returns the name of the user profile.

Returns:

The name of the user profile.

See Also:

RUser.USER_PROFILE_NAME

isGroupHasMember

public boolean isGroupHasMember()

Indicates whether this user is a group that has members.

Returns:

true if the user is a group that has members, false otherwise.

See Also:

RUser.GROUP_MEMBER_INDICATOR

isNoPassword

public boolean isNoPassword()

Indicates whether there is no password.

Returns:

true if there is no password, false otherwise.

See Also:

RUser.NO_PASSWORD_INDICATOR

isPasswordSetExpire

public boolean isPasswordSetExpire()

Indicates whether the user's password is set to expire, requiring the user to change the password when signing on.

Returns:

true if the password set to expire, false otherwise.

See Also:

RUser.SET_PASSWORD_TO_EXPIRE

isWithDigitalCertificates

public boolean isWithDigitalCertificates()

Indicates whether there are digital certificates associated with this user.

Returns:

true if there are digital certificates associated with this user, false otherwise.

See Also:

RUser.DIGITAL_CERTIFICATE_INDICATOR

loadUserInformation

public void loadUserInformation()
                         throws AS400Exception,
                                AS400SecurityException,
                                ConnectionDroppedException,
                                ErrorCompletingRequestException,
                                java.lang.InterruptedException,
                                ObjectDoesNotExistException,
                                java.io.IOException,
                                java.io.UnsupportedEncodingException

Refreshes the values for all attributes. This does not cancel uncommitted changes.

Throws:

AS400Exception - If the AS/400 system returns an error message.

AS400SecurityException - If a security or authority error occurs.

ConnectionDroppedException - If the connection is dropped unexpectedly.

ErrorCompletingRequestException - If an error occurs before the request is completed.

java.lang.InterruptedException - If this thread is interrupted.

java.io.IOException - If an error occurs while communicating with the AS/400.

ObjectDoesNotExistException - If the AS/400 object does not exist.

java.io.UnsupportedEncodingException - If the character encoding is not supported.

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

Removes a PropertyChangeListener.

Parameters:

listener - The listener.

removeVetoableChangeListener

public void removeVetoableChangeListener(java.beans.VetoableChangeListener listener)

Removes a VetoableChangeListener.

Parameters:

listener - The listener.

setName

public void setName(java.lang.String name)
             throws java.beans.PropertyVetoException

Sets the user profile name. This does not change the user profile on the AS/400. Instead, it changes the user profile to which this User object references. This cannot be changed if the object has established a connection to the AS/400.

Parameters:

name - The user profile name.

Throws:

java.beans.PropertyVetoException - If the property change is vetoed.

setSystem

public void setSystem(AS400 system)
               throws java.beans.PropertyVetoException

Sets the system. This cannot be changed if the object has established a connection to the AS/400.

Parameters:

system - The system.

Throws:

java.beans.PropertyVetoException - If the property change is vetoed.

toString

public java.lang.String toString()

Returns the user profile name.

Overrides:

toString in class java.lang.Object

Returns:

The user profile name.