|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.as400.access.User
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.
RUser
, Serialized FormConstructor 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 |
public User()
public User(AS400 system, java.lang.String name) throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, java.lang.InterruptedException, ObjectDoesNotExistException, java.io.IOException, java.io.UnsupportedEncodingException
system
- The system.name
- The user profile name.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 |
public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
listener
- The listener.public void addVetoableChangeListener(java.beans.VetoableChangeListener listener)
listener
- The listener.public java.lang.String getAccountingCode()
RUser.ACCOUNTING_CODE
public java.lang.String getAssistanceLevel()
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.
RUser.ASSISTANCE_LEVEL
public java.lang.String getAttentionKeyHandlingProgram()
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.
RUser.ATTENTION_KEY_HANDLING_PROGRAM
,
QSYSObjectPathName
public int getCCSID()
RUser.CHARACTER_CODE_SET_ID
public java.lang.String getCountryID()
SYSTEM_VALUE
- The system value QCNTRYID will be used to determine the country ID.
RUser.COUNTRY_ID
public java.lang.String getCurrentLibraryName()
CURRENT_LIBRARY_NAME_DEFAULT
- The user does not have a current library.
RUser.CURRENT_LIBRARY_NAME
public int getDaysUntilPasswordExpire()
RUser.DAYS_UNTIL_PASSWORD_EXPIRES
public java.lang.String getDescription()
RUser.TEXT_DESCRIPTION
public java.lang.String getDisplaySignOnInformation()
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.
RUser.DISPLAY_SIGN_ON_INFORMATION
public java.lang.String getGroupAuthority()
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.
RUser.GROUP_AUTHORITY
public java.lang.String getGroupAuthorityType()
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.
RUser.GROUP_AUTHORITY_TYPE
public int getGroupIDNumber()
RUser.GROUP_ID_NUMBER
public java.lang.String getGroupProfileName()
NONE
- If the user does not have a group profile.
RUser.GROUP_PROFILE_NAME
public int getHighestSchedulingPriority() throws java.lang.NumberFormatException
RUser.HIGHEST_SCHEDULING_PRIORITY
public java.lang.String getHomeDirectory()
RUser.HOME_DIRECTORY
public java.lang.String getInitialMenu()
INITIAL_MENU_SIGNOFF
RUser.INITIAL_MENU
,
QSYSObjectPathName
public java.lang.String getInitialProgram()
RUser.INITIAL_PROGRAM
,
QSYSObjectPathName
public java.lang.String getJobDescription()
RUser.JOB_DESCRIPTION
,
QSYSObjectPathName
public java.lang.String getLanguageID()
SYSTEM_VALUE
- The system value QLANGID will be used to determine the language ID.
RUser.LANGUAGE_ID
public java.lang.String getLimitCapabilities()
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.
RUser.LIMIT_CAPABILITIES
public java.lang.String getLimitDeviceSessions()
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.
RUser.LIMIT_DEVICE_SESSIONS
public java.lang.String[] getLocaleJobAttributes()
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.
RUser.LOCALE_JOB_ATTRIBUTES
public java.lang.String getLocalePathName()
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.
RUser.LOCALE_PATH_NAME
public int getMaximumStorageAllowed()
RUser.MAXIMUM_ALLOWED_STORAGE
public java.lang.String getMessageQueue()
RUser.MESSAGE_QUEUE
,
QSYSObjectPathName
public java.lang.String getMessageQueueDeliveryMethod()
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.
RUser.MESSAGE_QUEUE_DELIVERY_METHOD
public int getMessageQueueSeverity()
RUser.MESSAGE_QUEUE_SEVERITY
public java.lang.String getName()
public java.lang.String getObjectAuditingValue()
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.
RUser.OBJECT_AUDITING_VALUE
public java.lang.String getOutputQueue()
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.
RUser.OUTPUT_QUEUE
,
QSYSObjectPathName
public java.lang.String getOwner()
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.
RUser.OWNER
public java.util.Date getPasswordExpireDate()
RUser.DATE_PASSWORD_EXPIRES
public int getPasswordExpirationInterval()
RUser.PASSWORD_EXPIRATION_INTERVAL
public java.util.Date getPasswordLastChangedDate()
RUser.PASSWORD_CHANGE_DATE
public java.util.Date getPreviousSignedOnDate()
RUser.PREVIOUS_SIGN_ON
public java.lang.String getPrintDevice()
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.
RUser.PRINT_DEVICE
public int getSignedOnAttemptsNotValid()
RUser.SIGN_ON_ATTEMPTS_NOT_VALID
public java.lang.String getSortSequenceTable()
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.
RUser.SORT_SEQUENCE_TABLE
,
QSYSObjectPathName
public java.lang.String[] getSpecialAuthority()
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.
RUser.SPECIAL_AUTHORITIES
public java.lang.String getSpecialEnvironment()
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.
RUser.SPECIAL_ENVIRONMENT
public java.lang.String getStatus()
STATUS_ENABLED
- The user profile is enabled.
STATUS_NOT_ENABLED
- The user profile is not enabled.
RUser.STATUS
public int getStorageUsed()
RUser.STORAGE_USED
public java.lang.String[] getSupplementalGroups()
RUser.SUPPLEMENTAL_GROUPS
public int getSupplementalGroupsNumber()
RUser.SUPPLEMENTAL_GROUPS
public AS400 getSystem()
public java.lang.String[] getUserActionAuditLevel()
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.
RUser.USER_ACTION_AUDIT_LEVEL
public java.lang.String getUserClassName()
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.
RUser.USER_CLASS
public int getUserIDNumber()
RUser.USER_ID_NUMBER
public java.lang.String getUserProfileName()
RUser.USER_PROFILE_NAME
public boolean isGroupHasMember()
RUser.GROUP_MEMBER_INDICATOR
public boolean isNoPassword()
RUser.NO_PASSWORD_INDICATOR
public boolean isPasswordSetExpire()
RUser.SET_PASSWORD_TO_EXPIRE
public boolean isWithDigitalCertificates()
RUser.DIGITAL_CERTIFICATE_INDICATOR
public void loadUserInformation() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, java.lang.InterruptedException, ObjectDoesNotExistException, java.io.IOException, java.io.UnsupportedEncodingException
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.public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
listener
- The listener.public void removeVetoableChangeListener(java.beans.VetoableChangeListener listener)
listener
- The listener.public void setName(java.lang.String name) throws java.beans.PropertyVetoException
name
- The user profile name.java.beans.PropertyVetoException
- If the property change is vetoed.public void setSystem(AS400 system) throws java.beans.PropertyVetoException
system
- The system.java.beans.PropertyVetoException
- If the property change is vetoed.public java.lang.String toString()
toString
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |