public class User
extends java.lang.Object
implements java.io.Serializable
Note: User attribute information is cached internally in the User object, after
the first retrieval. To force an update of the cached information,
call refresh()
.
Note: Calling any of the attribute getters for the first time (for a given User
instance) will result in an implicit call to refresh()
.
If any exceptions are thrown by the implicit refresh(), they are logged under
trace category Trace.ERROR
and ignored. However, if an
exception occurs during an explicit call to refresh(), it will be thrown
to the caller.
Implementation note: This class internally calls the Retrieve User Information (QSYRUSRI) API for the methods that retrieve user profile information. In order to use those methods, the caller must have *READ authority to the user profile object. This class internally calls the Change User Profile (CHGUSRPRF) command for the methods that change user profile information. In order to use those methods, the caller must have security administrator (*SECADM) special authority, and object management (*OBJMGT) and use (*USE) authorities to the user profile being changed.
DirectoryEntry
,
UserList
,
UserGroup
,
Serialized FormModifier and Type | Field and Description |
---|---|
static java.lang.String |
NONE
Constant value representing the String "*NONE".
|
static java.lang.String |
SPECIAL_AUTHORITY_ALL_OBJECT
Constant value representing a special authority of "*ALLOBJ".
|
static java.lang.String |
SPECIAL_AUTHORITY_AUDIT
Constant value representing a special authority of "*AUDIT".
|
static java.lang.String |
SPECIAL_AUTHORITY_IO_SYSTEM_CONFIGURATION
Constant value representing a special authority of "*IOSYSCFG".
|
static java.lang.String |
SPECIAL_AUTHORITY_JOB_CONTROL
Constant value representing a special authority of "*JOBCTL".
|
static java.lang.String |
SPECIAL_AUTHORITY_SAVE_SYSTEM
Constant value representing a special authority of "*SAVSYS".
|
static java.lang.String |
SPECIAL_AUTHORITY_SECURITY_ADMINISTRATOR
Constant value representing a special authority of "*SECADM".
|
static java.lang.String |
SPECIAL_AUTHORITY_SERVICE
Constant value representing a special authority of "*SERVICE".
|
static java.lang.String |
SPECIAL_AUTHORITY_SPOOL_CONTROL
Constant value representing a special authority of "*SPLCTL".
|
Constructor and Description |
---|
User()
Constructs a User object.
|
User(AS400 system,
java.lang.String name)
Constructs a User object.
|
Modifier and Type | Method and Description |
---|---|
void |
addPropertyChangeListener(java.beans.PropertyChangeListener listener)
Adds a PropertyChangeListener.
|
void |
addVetoableChangeListener(java.beans.VetoableChangeListener listener)
Adds a VetoableChangeListener.
|
boolean |
exists()
Determines if this user profile exists on the system.
|
java.lang.String |
getAccountingCode()
Retrieves the accounting code that is associated with this user.
|
java.lang.String |
getAssistanceLevel()
Retrieves the user interface that the user will use.
|
java.lang.String |
getAttentionKeyHandlingProgram()
Retrieves the attention key handling program for this user.
|
int |
getCCSID()
Retrieves the character code set ID to be used by the system for this user.
|
java.lang.String |
getCHRIDControl()
Retrieves the character identifier control for the user.
|
java.lang.String |
getCountryID()
Retrieves the country or region ID used by the system for this user.
|
java.lang.String |
getCurrentLibraryName()
Retrieves the name of the user's current library.
|
int |
getDaysUntilPasswordExpire()
Retrieves the number of days until the password will expire.
|
java.lang.String |
getDescription()
Retrieves the descriptive text for the user profile.
|
java.lang.String |
getDetailInSTRAUTCOL() |
DirectoryEntry |
getDirectoryEntry()
Retrieves the system distribution directory entry for the user profile, if one exists.
|
java.lang.String |
getDisplaySignOnInformation()
Retrieves whether the sign-on information display is shown when the user signs on.
|
java.lang.String[] |
getDLOObjectTypesInSTRAUTCOL() |
java.lang.String[] |
getFileSystemObjectTypesInSTRAUTCOL() |
java.lang.String |
getGroupAuthority()
Retrieves the authority the user's group profile has to objects the user creates.
|
java.lang.String |
getGroupAuthorityType()
Retrieves the type of authority the user's group has to objects the user creates.
|
long |
getGroupID()
Retrieves the group ID number for the user profile.
|
int |
getGroupIDNumber()
Deprecated.
This method has been replaced by
getGroupID() which returns a long. |
java.lang.String |
getGroupProfileName()
Retrieves the name of the group profile.
|
int |
getHighestSchedulingPriority()
Retrieves the highest scheduling priority the user is allowed to have for each job submitted to the system.
|
java.lang.String |
getHomeDirectory()
Retrieves the home directory for this user profile.
|
java.lang.String[] |
getIASPNames()
Retrieves the list of independent auxiliary storage pool (IASP) names in use by this user.
|
int |
getIASPStorageAllowed(java.lang.String iaspName)
Retrieves the maximum amount of auxiliary storage in kilobytes that can be assigned to store permanent object owned by this user on the given independant ASP.
|
int |
getIASPStorageUsed(java.lang.String iaspName)
Retrieves the amount of auxiliary storage in kilobytes occupied by this user's owned objects on the given independent ASP.
|
java.lang.String |
getInitialMenu()
Retrieves the initial menu for the user.
|
java.lang.String |
getInitialProgram()
Retrieves the initial program for the user.
|
java.lang.String |
getJobDescription()
Retrieves 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 |
getKeyboardBuffering()
Retrieves the keyboard buffering value that is used when a job is initialized for this user.
|
java.lang.String |
getLanguageID()
Retrieves the language ID used by the system for this user.
|
java.lang.String[] |
getLibNameInSTRAUTCOL() |
java.lang.String |
getLimitCapabilities()
Retrieves whether the user has limited capabilites.
|
java.lang.String |
getLimitDeviceSessions()
Retrieves whether the user is limited to one device session.
|
java.lang.String[] |
getLocaleJobAttributes()
Retrieves a list of the job attributes which are set from the user's locale path name.
|
java.lang.String |
getLocalePathName()
Retrieves the locale path name that is assigned to the user profile when a job is started.
|
int |
getMaximumStorageAllowed()
Retrieves the maximum amount of auxiliary storage (in kilobytes) that can be assigned to store permanant objects owned by the user.
|
long |
getMaximumStorageAllowedInLong() |
java.lang.String |
getMessageQueue()
Retrieves the fully qualified integrated file system path name of the message queue that is used by this user.
|
java.lang.String |
getMessageQueueDeliveryMethod()
Retrieves how the messages are delivered to the message queue used by the user.
|
int |
getMessageQueueSeverity()
Retrieves 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()
Retrieves the user's object auditing value.
|
java.lang.String[] |
getObjectNamesInSTRAUTCOL() |
UserObjectsOwnedList |
getObjectsOwned()
Return an object representing the objects that this user owns.
|
java.lang.String[] |
getObjectTypesInSTRAUTCOL() |
java.lang.String[] |
getOmitLibNamesInSTRAUTCOL() |
java.lang.String |
getOutputQueue()
Retrieves the output queue used by this user.
|
java.lang.String |
getOwner()
Retrieves who is to own objects created by this user.
|
java.lang.String |
getPasswordChangeBlock()
Retrieves the time period during which a password is blocked from being changed
following the prior successful password change operation.
|
int |
getPasswordExpirationInterval()
Retrieves the number of days the user's password can remain active before it must be changed.
|
java.util.Date |
getPasswordExpireDate()
Retrieves the date the user's password expires.
|
java.util.Date |
getPasswordLastChangedDate()
Retrieves the date the user's password was last changed.
|
java.util.Date |
getPreviousSignedOnDate()
Retrieves the date and time the user last signed on.
|
java.lang.String |
getPrintDevice()
Retrieves the printer used to print for this user.
|
int |
getSignedOnAttemptsNotValid()
Retrieves the number of sign-on attempts that were not valid since the last successful sign-on.
|
java.lang.String |
getSortSequenceTable()
Retrieves the name of the sort sequence table used for string comparisons.
|
java.lang.String[] |
getSpecialAuthority()
Retrieves a list of the special authorities the user has.
|
java.lang.String |
getSpecialEnvironment()
Retrieves the special environment the user operates in after signing on.
|
java.lang.String |
getStatus()
Retrieves the status of the user profile.
|
int |
getStorageUsed()
Retrieves the amount of auxiliary storage (in kilobytes) occupied by this user's owned objects.
|
long |
getStorageUsedInLong()
Retrieves the amount of auxiliary storage (in kilobytes) occupied by this user's owned objects.
|
java.lang.String[] |
getSupplementalGroups()
Retrieves the supplemental groups for the user profile.
|
int |
getSupplementalGroupsNumber()
Retrieves the number of supplemental groups for the user profile.
|
AS400 |
getSystem()
Returns the system object representing the system on which the user profile exists.
|
java.lang.String[] |
getUserActionAuditLevel()
Retrieves a list of action audit levels for the user.
|
java.lang.String |
getUserClassName()
Retrieves the user class name.
|
java.lang.String |
getUserExpirationAction()
Retrieves the action that will occur when the user profile has expired.
|
java.util.Date |
getUserExpirationDate()
Retrieves the date when the user profile expires and is automatically disabled.
|
int |
getUserExpirationInterval()
Retrieves the number of days before the user profile is automatically disabled.
|
long |
getUserID()
Retrieves the user ID (UID) number for the user profile.
|
int |
getUserIDNumber()
Deprecated.
This method has been replaced by
getUserID() which returns a long. |
java.lang.String[] |
getUserOptions()
Retrieves a list of options for users to customize their environment.
|
java.lang.String |
getUserProfileName()
Retrieves the name of the user profile for which the information is returned.
|
boolean |
hasSpecialAuthority(java.lang.String authority)
Retrieves if this user profile has been granted the specified authority, or belongs to a group profile that has been granted the specified authority.
|
boolean |
isAuthCollectionActive() |
boolean |
isAuthCollectionDeleted() |
boolean |
isAuthCollectionRepositoryExist() |
boolean |
isGroupHasMember()
Retrieves whether this user is a group that has members.
|
boolean |
isLocalPasswordManagement()
Retrieves whether the password is managed locally.
|
boolean |
isNoPassword()
Retrieves whether *NONE is specified for the password in the user profile.
|
boolean |
isPasswordSetExpire()
Retrieves whether the user's password is set to expired, requiring the user to change the password when signing on.
|
boolean |
isUserEntitlementRequired()
Retrieves whether a user entitlement is required for this user profile.
|
boolean |
isWithDigitalCertificates()
Retrieves whether there are digital certificates associated with this user.
|
void |
loadUserInformation()
Refreshes the values for all attributes.
|
void |
refresh()
Refreshes all the attribute values for this User object by retrieving them from the system.
|
void |
removePropertyChangeListener(java.beans.PropertyChangeListener listener)
Removes the PropertyChangeListener.
|
void |
removeVetoableChangeListener(java.beans.VetoableChangeListener listener)
Removes the VetoableChangeListener.
|
void |
setAccountingCode(java.lang.String accountingCode)
Sets the accounting code that is associated with this user profile.
|
void |
setAssistanceLevel(java.lang.String assistanceLevel)
Sets which user interface to use.
|
void |
setAttentionKeyHandlingProgram(java.lang.String attentionKeyHandlingProgram)
Sets the program to be used as the Attention (ATTN) key handling program for this user.
|
void |
setCCSID(int ccsid)
Sets the character code set identifier (CCSID) to be used for this user.
|
void |
setCCSID(java.lang.String ccsid)
Sets the character code set identifier (CCSID) to be used for this user.
|
void |
setCHRIDControl(java.lang.String chridControl)
Sets the character identifier control (CHRIDCTL) for the job.
|
void |
setCountryID(java.lang.String countryID)
Sets the country or region identifier to be used for this user.
|
void |
setCurrentLibraryName(java.lang.String currentLibraryName)
Sets the name of the current library associated with the job being run.
|
void |
setDescription(java.lang.String description)
Sets the text that briefly describes the object.
|
void |
setDisplaySignOnInformation(java.lang.String displaySignOnInformation)
Sets whether the sign-on information display is shown.
|
void |
setGroupAuthority(java.lang.String groupAuthority)
Sets the specific authority given to the group profile for newly created objects.
|
void |
setGroupAuthorityType(java.lang.String groupAuthorityType)
Sets the type of authority to be granted to the group profile for newly-created objects.
|
void |
setGroupID(long groupID)
Sets the group ID number (gid number) for this user profile.
|
void |
setGroupID(java.lang.String groupID)
Sets the group ID number (gid number) for this user profile.
|
void |
setGroupProfileName(java.lang.String groupProfileName)
Sets the user's group profile name whose authority is used if no specific authority is given for the user.
|
void |
setHighestSchedulingPriority(int highestSchedulingPriority)
Sets the highest scheduling priority the user is allowed to have for each job submitted to the system.
|
void |
setHomeDirectory(java.lang.String homeDirectory)
Sets the path name of the home directory for this user profile.
|
void |
setInitialMenu(java.lang.String initialMenu)
Sets the initial menu displayed when the user signs on the system if the user's routing program is the command processor.
|
void |
setInitialProgram(java.lang.String initialProgram)
Sets, for an interactive job, the program called whenever a new routing step is started that has QCMD as the request processing program.
|
void |
setJobDescription(java.lang.String jobDescription)
Sets the fully qualified integrated file system path name of the job description used for jobs that start through subsystem work station entries.
|
void |
setKeyboardBuffering(java.lang.String keyboardBuffering)
Sets the keyboard buffering value to be used when a job is initialized for this user profile.
|
void |
setLanguageID(java.lang.String languageID)
Sets the language ID to be used for this user.
|
void |
setLimitCapabilities(java.lang.String limitCapabilities)
Sets the limit to which the user can control the program, menu, current library, and the ATTN key handling program values.
|
void |
setLimitDeviceSessions(java.lang.String limitDeviceSessions)
Sets if the number of device sessions allowed for a user is limited to 1.
|
void |
setLocaleJobAttributes(java.lang.String[] localeJobAttributes)
Sets which job attributes are to be taken from the locale specified for the Locale (LOCALE) parameter when the job is initiated.
|
void |
setLocalePathName(java.lang.String localePathName)
Sets the path name of the locale that is assigned to LANG environment variable for this user.
|
void |
setLocalPasswordManagement(boolean localPasswordManagement)
Sets whether the user profile password should be managed locally.
|
void |
setMaximumStorageAllowed(int maximumStorageAllowed)
Sets the maximum amount of auxiliary storage (in kilobytes) assigned to store permanant objects owned by this user profile (1 kilobyte equals 1024 bytes).
|
void |
setMaximumStorageAllowed(java.lang.String maximumStorageAllowed)
Sets the maximum amount of auxiliary storage (in kilobytes) assigned to store permanant objects owned by this user profile (1 kilobyte equals 1024 bytes).
|
void |
setMessageQueue(java.lang.String messageQueue)
Sets the message queue to which messages are sent.
|
void |
setMessageQueueDeliveryMethod(java.lang.String messageQueueDeliveryMethod)
Sets how the messages are sent to the message queue for this user are to be delivered.
|
void |
setMessageQueueSeverity(int messageQueueSeverity)
Sets the lowest severity code that a message can have and still be delivered to a user in break or notify mode.
|
void |
setName(java.lang.String name)
Sets the user profile name.
|
void |
setObjectAuditingValue(java.lang.String objectAuditingValue)
Sets the object auditing value for the user.
|
void |
setOutputQueue(java.lang.String outputQueue)
Sets the output queue to be used by this user profile.
|
void |
setOwner(java.lang.String owner)
Sets the user profile that is to be the owner of objects created by this user.
|
void |
setPasswordChangeBlock(java.lang.String pwdChangeBlock)
Sets the time period during which a password is blocked from being changed
following the prior successful password change operation.
|
void |
setPasswordExpirationInterval(int passwordExpirationInterval)
Sets the password expiration interval (in days).
|
void |
setPasswordExpirationInterval(java.lang.String passwordExpirationInterval)
Sets the password expiration interval (in days).
|
void |
setPasswordSetExpire(boolean passwordSetExpire)
Sets whether the password for this user is set to expired.
|
void |
setPrintDevice(java.lang.String printDevice)
Sets the default printer device for this user.
|
void |
setSortSequenceTable(java.lang.String sortSequenceTable)
Sets the sort sequence table to be used for string comparisons for this profile.
|
void |
setSpecialAuthority(java.lang.String[] specialAuthority)
Sets the special authorities given to a user.
|
void |
setSpecialEnvironment(java.lang.String specialEnvironment)
Sets the special environment in which the user operates after signing on.
|
void |
setStatus(java.lang.String status)
Sets the status of the user profile.
|
void |
setSupplementalGroups(java.lang.String[] supplementalGroups)
Sets the user's supplemental group profiles.
|
void |
setSystem(AS400 system)
Sets the system object representing the system on which the user profile exists.
|
void |
setUserActionAuditLevel(java.lang.String[] userActionAuditLevel)
Sets the level of activity that is audited for this user profile.
|
void |
setUserClassName(java.lang.String userClassName)
Sets the type of user associated with this user profile: security officer, security administrator, programmer, system operator, or user.
|
void |
setUserExpirationDate(java.util.Date expirationDate)
Sets the date when the user profile expires and is automatically disabled.
|
void |
setUserExpirationInterval(int expirationInterval)
Sets the expiration interval (in days) before the user profile is automatically disabled.
|
void |
setUserID(long userID)
Sets the user ID number (uid number) for this user profile.
|
void |
setUserOptions(java.lang.String[] userOptions)
Sets the level of help information detail to be shown and the function of the Page Up and Page Down keys by default.
|
java.lang.String |
toString()
Sets the string representation of this User object.
|
public static final java.lang.String NONE
public static final java.lang.String SPECIAL_AUTHORITY_ALL_OBJECT
getSpecialAuthority()
public static final java.lang.String SPECIAL_AUTHORITY_AUDIT
getSpecialAuthority()
public static final java.lang.String SPECIAL_AUTHORITY_IO_SYSTEM_CONFIGURATION
getSpecialAuthority()
public static final java.lang.String SPECIAL_AUTHORITY_JOB_CONTROL
getSpecialAuthority()
public static final java.lang.String SPECIAL_AUTHORITY_SAVE_SYSTEM
getSpecialAuthority()
public static final java.lang.String SPECIAL_AUTHORITY_SECURITY_ADMINISTRATOR
getSpecialAuthority()
public static final java.lang.String SPECIAL_AUTHORITY_SERVICE
getSpecialAuthority()
public static final java.lang.String SPECIAL_AUTHORITY_SPOOL_CONTROL
getSpecialAuthority()
public User()
public User(AS400 system, java.lang.String name) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException, ObjectDoesNotExistException
system
- The system object representing the system on which the user profile exists.name
- The user profile name.AS400SecurityException
- If a security or authority error occurs.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 system.ObjectDoesNotExistException
- If the object does not exist on the system.public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
propertyChange()
method will be called each time the value of any bound property is changed.listener
- The listener.removePropertyChangeListener(java.beans.PropertyChangeListener)
public void addVetoableChangeListener(java.beans.VetoableChangeListener listener)
vetoableChange()
method will be called each time the value of any constrained property is changed.listener
- The listener.removeVetoableChangeListener(java.beans.VetoableChangeListener)
public boolean exists() throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException, ObjectDoesNotExistException
The value returned by this method is not cached. That is, every time exists() is called, a call to the system is made to determine if the user profile still exists.
AS400SecurityException
- If a security or authority error occurs.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 system.ObjectDoesNotExistException
- If the object does not exist on the system.public java.lang.String getAccountingCode()
setAccountingCode(java.lang.String)
public java.lang.String getAssistanceLevel()
public java.lang.String getAttentionKeyHandlingProgram()
NONE
- No attention key handling program is used.
QSYSObjectPathName
public int getCCSID()
public java.lang.String getCHRIDControl()
setCHRIDControl(java.lang.String)
public java.lang.String getCountryID()
setCountryID(java.lang.String)
public java.lang.String getCurrentLibraryName()
setCurrentLibraryName(java.lang.String)
public int getDaysUntilPasswordExpire()
public java.lang.String getDescription()
setDescription(java.lang.String)
public DirectoryEntry getDirectoryEntry() throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException, ObjectDoesNotExistException
AS400SecurityException
- If a security or authority error occurs.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 system.ObjectDoesNotExistException
- If the object does not exist on the system.public java.lang.String getDisplaySignOnInformation()
setDisplaySignOnInformation(java.lang.String)
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.
setGroupAuthority(java.lang.String)
public java.lang.String getGroupAuthorityType()
setGroupAuthorityType(java.lang.String)
public long getGroupID()
setGroupID(long)
,
setGroupID(String)
public int getGroupIDNumber()
getGroupID()
which returns a long.public java.lang.String getGroupProfileName()
NONE
- The user does not have a group profile.
setGroupProfileName(java.lang.String)
public int getHighestSchedulingPriority()
setHighestSchedulingPriority(int)
public java.lang.String getHomeDirectory()
setHomeDirectory(java.lang.String)
public java.lang.String[] getIASPNames()
getIASPStorageAllowed(java.lang.String)
,
getIASPStorageUsed(java.lang.String)
,
AS400.getVRM()
,
AS400.generateVRM(int, int, int)
public int getIASPStorageAllowed(java.lang.String iaspName)
iaspName
- getIASPNames()
,
getIASPStorageUsed(java.lang.String)
public int getIASPStorageUsed(java.lang.String iaspName)
iaspName
- getIASPNames()
,
getIASPStorageAllowed(java.lang.String)
public java.lang.String getInitialMenu()
QSYSObjectPathName
,
setInitialMenu(java.lang.String)
public java.lang.String getInitialProgram()
NONE
- The user does not have an initial program.
QSYSObjectPathName
,
setInitialProgram(java.lang.String)
public java.lang.String getJobDescription()
QSYSObjectPathName
,
setJobDescription(java.lang.String)
public java.lang.String getKeyboardBuffering()
setKeyboardBuffering(java.lang.String)
public java.lang.String getLanguageID()
setLanguageID(java.lang.String)
public java.lang.String getLimitCapabilities()
setLimitCapabilities(java.lang.String)
public java.lang.String getLimitDeviceSessions()
setLimitDeviceSessions(java.lang.String)
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.
setLocaleJobAttributes(java.lang.String[])
public java.lang.String getLocalePathName()
NONE
- No locale path name is assigned.
setLocalePathName(java.lang.String)
public int getMaximumStorageAllowed()
setMaximumStorageAllowed(int)
,
setMaximumStorageAllowed(String)
public long getMaximumStorageAllowedInLong()
public java.lang.String getMessageQueue()
QSYSObjectPathName
,
setMessageQueue(java.lang.String)
public java.lang.String getMessageQueueDeliveryMethod()
setMessageQueueDeliveryMethod(java.lang.String)
public int getMessageQueueSeverity()
setMessageQueueSeverity(int)
public java.lang.String getName()
setName(java.lang.String)
public java.lang.String getObjectAuditingValue()
NONE
- No additional object auditing is done for the user.
setObjectAuditingValue(java.lang.String)
public UserObjectsOwnedList getObjectsOwned()
public java.lang.String getOutputQueue()
QSYSObjectPathName
,
setOutputQueue(java.lang.String)
public java.lang.String getOwner()
setOwner(java.lang.String)
public java.util.Date getPasswordExpireDate()
public java.lang.String getPasswordChangeBlock()
Note: This method should not be used when running to IBM i 5.4 or earlier releases.
NONE
- The password can be changed at any time.setPasswordChangeBlock(java.lang.String)
public int getPasswordExpirationInterval()
setPasswordExpirationInterval(int)
,
setPasswordExpirationInterval(String)
public java.util.Date getPasswordLastChangedDate()
public java.util.Date getPreviousSignedOnDate()
public java.lang.String getPrintDevice()
setPrintDevice(java.lang.String)
public int getSignedOnAttemptsNotValid()
public java.lang.String getSortSequenceTable()
QSYSObjectPathName
,
setSortSequenceTable(java.lang.String)
public java.lang.String[] getSpecialAuthority()
SPECIAL_AUTHORITY_ALL_OBJECT
- All object.
SPECIAL_AUTHORITY_SECURITY_ADMINISTRATOR
- Security administrator.
SPECIAL_AUTHORITY_JOB_CONTROL
- Job control.
SPECIAL_AUTHORITY_SPOOL_CONTROL
- Spool control.
SPECIAL_AUTHORITY_SAVE_SYSTEM
- Save system.
SPECIAL_AUTHORITY_SERVICE
- Service.
SPECIAL_AUTHORITY_AUDIT
- Audit.
SPECIAL_AUTHORITY_IO_SYSTEM_CONFIGURATION
- Input/output system configuration.
hasSpecialAuthority(java.lang.String)
,
setSpecialAuthority(java.lang.String[])
public java.lang.String getSpecialEnvironment()
NONE
- The user operates in the IBM i system environment.
setSpecialEnvironment(java.lang.String)
public java.lang.String getStatus()
setStatus(java.lang.String)
public int getStorageUsed()
public long getStorageUsedInLong()
public java.lang.String[] getSupplementalGroups()
setSupplementalGroups(java.lang.String[])
public int getSupplementalGroupsNumber()
This method simply returns getSupplementalGroups().length.
getSupplementalGroups()
public AS400 getSystem()
setSystem(com.ibm.as400.access.AS400)
public java.lang.String[] getUserActionAuditLevel()
setUserActionAuditLevel(java.lang.String[])
public java.lang.String getUserClassName()
setUserClassName(java.lang.String)
public java.lang.String getUserExpirationAction()
Note: This method should not be used when running to IBM i 6.1 or earlier releases.
NONE
- The user profile will not expire.
public java.util.Date getUserExpirationDate()
Note: This method should not be used when running to IBM i 6.1 or earlier releases.
setUserExpirationDate(java.util.Date)
public int getUserExpirationInterval()
Note: This method should not be used when running to IBM i 6.1 or earlier releases.
setUserExpirationInterval(int)
public long getUserID()
setUserID(long)
public int getUserIDNumber()
getUserID()
which returns a long.public java.lang.String[] getUserOptions()
setUserOptions(java.lang.String[])
public java.lang.String getUserProfileName()
public boolean isAuthCollectionActive()
public boolean isAuthCollectionRepositoryExist()
public boolean isAuthCollectionDeleted()
public java.lang.String getDetailInSTRAUTCOL()
public java.lang.String[] getLibNameInSTRAUTCOL()
public java.lang.String[] getObjectNamesInSTRAUTCOL()
public java.lang.String[] getObjectTypesInSTRAUTCOL()
public java.lang.String[] getDLOObjectTypesInSTRAUTCOL()
public java.lang.String[] getFileSystemObjectTypesInSTRAUTCOL()
public java.lang.String[] getOmitLibNamesInSTRAUTCOL()
public boolean hasSpecialAuthority(java.lang.String authority)
authority
- The authority to check. It must be one of the following special authority values:
getSpecialAuthority()
,
setSpecialAuthority(java.lang.String[])
public boolean isGroupHasMember()
For User objects, this should always return false. For UserGroup objects, this should return true if the group profile has members.
UserGroup
public boolean isLocalPasswordManagement()
setLocalPasswordManagement(boolean)
public boolean isNoPassword()
public boolean isPasswordSetExpire()
setPasswordSetExpire(boolean)
public boolean isUserEntitlementRequired()
public boolean isWithDigitalCertificates()
public void loadUserInformation() throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException, ObjectDoesNotExistException
refresh()
.AS400SecurityException
- If a security or authority error occurs.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 system.ObjectDoesNotExistException
- If the object does not exist on the system.public void refresh() throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException, ObjectDoesNotExistException
loadUserInformation()
.AS400SecurityException
- If a security or authority error occurs.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 system.ObjectDoesNotExistException
- If the object does not exist on the system.public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
listener
- The listener object.public void removeVetoableChangeListener(java.beans.VetoableChangeListener listener)
listener
- The listener object.public void setAccountingCode(java.lang.String accountingCode) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException
accountingCode
- The accounting code that is associated with this user profile. Possible values are:
AS400SecurityException
- If a security or authority error occurs.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 system.getAccountingCode()
public void setAssistanceLevel(java.lang.String assistanceLevel) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException
assistanceLevel
- The user interface to use. Possible values are:
AS400SecurityException
- If a security or authority error occurs.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 system.public void setAttentionKeyHandlingProgram(java.lang.String attentionKeyHandlingProgram) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException
attentionKeyHandlingProgram
- The program to be used as the Attention (ATTN) key handling program for this user. Possible values are:
NONE
- No ATTN key handling program is used by this user.
AS400SecurityException
- If a security or authority error occurs.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 system.QSYSObjectPathName
public void setCCSID(int ccsid) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException
A CCSID is a 16-bit number identifying a specific set of encoding scheme identifiers, character set identifiers, code page identifiers, and additional coding-related information that uniquely identifies the coded graphic representation used.
Note: If the value for CCSID is changed, the change does not affect job that are currently running.
ccsid
- The character code set identifier (CCSID) to be used for this user. Possible values are:
AS400SecurityException
- If a security or authority error occurs.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 system.public void setCCSID(java.lang.String ccsid) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException
A CCSID is a 16-bit number identifying a specific set of encoding scheme identifiers, character set identifiers, code page identifiers, and additional coding-related information that uniquely identifies the coded graphic representation used.
Note: If the value for CCSID is changed, the change does not affect job that are currently running.
ccsid
- The character code set identifier (CCSID) to be used for this user. Possible values are:
AS400SecurityException
- If a security or authority error occurs.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 system.public void setCHRIDControl(java.lang.String chridControl) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException
chridControl
- The character identifier control (CHRIDCTL) for the job. Possible values are:
AS400SecurityException
- If a security or authority error occurs.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 system.getCHRIDControl()
public void setCountryID(java.lang.String countryID) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException
countryID
- The country or region identifier to be used for this user. Possible values are:
AS400SecurityException
- If a security or authority error occurs.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 system.getCountryID()
public void setCurrentLibraryName(java.lang.String currentLibraryName) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException
Specifies the name of the library to be used as the current library for this user. If *PARTIAL or *YES is specified for the Limit capabilities (LMTCPB) parameter of the Create User Profile (CRTUSRPRF) or Change User Profile (CHGUSRPRF) command, the user cannot change the current library at sign-on or with the Change Profile (CHGPRF) command.
The caller must have *USE authority to the specified library.
currentLibraryName
- The name of the current library associated with the job being run. Possible values are:
AS400SecurityException
- If a security or authority error occurs.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 system.getCurrentLibraryName()
public void setDescription(java.lang.String description) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException
description
- The text that briefly describes the object. Possible values are:
AS400SecurityException
- If a security or authority error occurs.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 system.getDescription()
public void setDisplaySignOnInformation(java.lang.String displaySignOnInformation) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException
displaySignOnInformation
- Whether the sign-on information display is shown. Possible values are:
AS400SecurityException
- If a security or authority error occurs.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 system.getDisplaySignOnInformation()
public void setGroupAuthority(java.lang.String groupAuthority) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException
groupAuthority
- The specific authority given to the group profile for newly created objects. Possible values are:
NONE
- No group authority is given.
AS400SecurityException
- If a security or authority error occurs.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 system.getGroupAuthority()
public void setGroupAuthorityType(java.lang.String groupAuthorityType) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException
NONE
is specified for the Group Authority (GRPAUT) parameter, specification of this parameter is ignored.groupAuthorityType
- The type of authority to be granted to the group profile for newly-created objects. Possible values are:
NONE
, this value is ignored.
NONE
, this value is ignored.
AS400SecurityException
- If a security or authority error occurs.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 system.getGroupAuthorityType()
public void setGroupID(long groupID) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException
groupID
- The group ID number (gid number) for this user profile. Possible values are:
Note: This value cannot be specified if the user is a group profile or the primary group of an object.
AS400SecurityException
- If a security or authority error occurs.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 system.getGroupID()
public void setGroupID(java.lang.String groupID) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException
groupID
- The group ID number (gid number) for this user profile. Possible values are:
NONE
- The user does not have a gid number or an existing gid number is removed.
Note: This value cannot be specified if the user is a group profile or the primary group of an object.
AS400SecurityException
- If a security or authority error occurs.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 system.getGroupID()
public void setGroupProfileName(java.lang.String groupProfileName) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException
groupProfileName
- The user's group profile name whose authority is used if no specific authority is given for the user. Possible values are:
NONE
- The user profile has no group profile.
AS400SecurityException
- If a security or authority error occurs.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 system.getGroupProfileName()
public void setHighestSchedulingPriority(int highestSchedulingPriority) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException
highestSchedulingPriority
- The highest scheduling priority the user is allowed to have for each job submitted to the system.AS400SecurityException
- If a security or authority error occurs.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 system.getHighestSchedulingPriority()
public void setHomeDirectory(java.lang.String homeDirectory) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException
homeDirectory
- The path name of the home directory for this user profile. Possible values are:
AS400SecurityException
- If a security or authority error occurs.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 system.getHomeDirectory()
public void setInitialMenu(java.lang.String initialMenu) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException
A System/36 environment menu can be specified as the initial menu if either of the following conditions are true:
The caller must have *USE authority to the specified menu.
initialMenu
- The initial menu displayed when the user signs on the system if the user's routing program is the command processor. Possible values are:
AS400SecurityException
- If a security or authority error occurs.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 system.QSYSObjectPathName
,
getInitialMenu()
public void setInitialProgram(java.lang.String initialProgram) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException
A System/36 environment procedure name can be specified as the initial program if the procedure is a member of the file QS36PRC (in the library list or specified library) and if either of the following conditions are true:
The caller must have *USE authority to the specified program.
initialProgram
- The initial program for the user. Possible values are:
NONE
- No program is called when the user signs on. If a menu name is specified in the Initial menu (INLMNU) parameter, that menu is displayed.
AS400SecurityException
- If a security or authority error occurs.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 system.QSYSObjectPathName
,
getInitialProgram()
public void setJobDescription(java.lang.String jobDescription) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException
jobDescription
- The fully qualified integrated file system path name of the job description used for jobs that start through subsystem work station entries.AS400SecurityException
- If a security or authority error occurs.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 system.QSYSObjectPathName
,
getJobDescription()
public void setKeyboardBuffering(java.lang.String keyboardBuffering) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException
keyboardBuffering
- The keyboard buffering value to be used when a job is initialized for this user profile. Possible values are:
AS400SecurityException
- If a security or authority error occurs.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 system.getKeyboardBuffering()
public void setLanguageID(java.lang.String languageID) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException
languageID
- The language ID to be used for this user. Possible values are:
AS400SecurityException
- If a security or authority error occurs.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 system.getLanguageID()
public void setLimitCapabilities(java.lang.String limitCapabilities) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException
Note: When creating or changing other users' user profile, you cannot specify values on this parameter that grant greater capabilities to other users than your own user profile grants to you. For example, if *PARTIAL is specified for the Limit capabilities (LMTCPB) parameter in your user profile, you can specify *PARTIAL or *YES for anther user. You cannot specify *NO for another user.
limitCapabilities
- The limit to which the user can control the program, menu, current library, and the ATTN key handling program values. Possible values are:
AS400SecurityException
- If a security or authority error occurs.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 system.getLimitCapabilities()
public void setLimitDeviceSessions(java.lang.String limitDeviceSessions) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException
limitDeviceSessions
- If the number of device sessions allowed for a user is limited to 1. Possible values are:
AS400SecurityException
- If a security or authority error occurs.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 system.getLimitDeviceSessions()
public void setLocaleJobAttributes(java.lang.String[] localeJobAttributes) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException
localeJobAttributes
- 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 taken from the locale.
AS400SecurityException
- If a security or authority error occurs.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 system.getLocaleJobAttributes()
public void setLocalePathName(java.lang.String localePathName) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException
localePathName
- The locale path name that is assigned to the user profile when a job is started. Possible values are:
NONE
- No locale path name is assigned for this user.
AS400SecurityException
- If a security or authority error occurs.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 system.getLocalePathName()
public void setLocalPasswordManagement(boolean localPasswordManagement) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException
localPasswordManagement
- true if the password will be managed on the local system, false otherwise.AS400SecurityException
- If a security or authority error occurs.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 system.isLocalPasswordManagement()
public void setMaximumStorageAllowed(int maximumStorageAllowed) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException
Storage is allocated in 4K increments. Therefore, if you specify MAXSTG (9), the profile is allocated 12K of storage.
When planning maximum storage for user profiles, consider the following system actions:
maximumStorageAllowed
- The maximum amount of auxiliary storage (in kilobytes) assigned to store permanant objects owned by this user profile. Possible values are:
AS400SecurityException
- If a security or authority error occurs.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 system.getMaximumStorageAllowed()
public void setMaximumStorageAllowed(java.lang.String maximumStorageAllowed) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException
Storage is allocated in 4K increments. Therefore, if you specify MAXSTG (9), the profile is allocated 12K of storage.
When planning maximum storage for user profiles, consider the following system actions:
maximumStorageAllowed
- The maximum amount of auxiliary storage (in kilobytes) assigned to store permanant objects owned by this user profile. Possible values are:
AS400SecurityException
- If a security or authority error occurs.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 system.getMaximumStorageAllowed()
public void setMessageQueue(java.lang.String messageQueue) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException
Note: The message queue is created, if it does not exist. The user profile specified for the User profile (USRPRF) parameter is the owner of the message queue.
The caller must have *USE authority to the specified message queue.
messageQueue
- The message queue to which messages are sent. Possible values are:
AS400SecurityException
- If a security or authority error occurs.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 system.QSYSObjectPathName
,
getMessageQueue()
public void setMessageQueueDeliveryMethod(java.lang.String messageQueueDeliveryMethod) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException
messageQueueDeliveryMethod
- How the messages are sent to the message queue for this user are to be delivered. Possible values are:
AS400SecurityException
- If a security or authority error occurs.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 system.setMessageQueueDeliveryMethod(java.lang.String)
public void setMessageQueueSeverity(int messageQueueSeverity) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException
messageQueueSeverity
- A severity code ranging from 00 through 99.AS400SecurityException
- If a security or authority error occurs.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 system.getMessageQueueSeverity()
public void setName(java.lang.String name) throws java.beans.PropertyVetoException
name
- The user profile name.java.beans.PropertyVetoException
- If any of the registered listeners vetos the property change.getName()
public void setObjectAuditingValue(java.lang.String objectAuditingValue) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException
Implementation note: The method internally calls the Change User Auditing (CHGUSRAUD) command and not the Change User Profile (CHGUSRPRF) command. The caller must have audit (*AUDIT) special authority. Changes take effect the next time a job is started for this user.
objectAuditingValue
- The object auditing value for the user. Possible values are:
NONE
- The auditing value for the object determines when auditing is performed.
AS400SecurityException
- If a security or authority error occurs.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 system.getObjectAuditingValue()
public void setOutputQueue(java.lang.String outputQueue) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException
outputQueue
- The output queue to be used by this user profile. Possible values are:
Note: This assumes the defaults are specified for the Output queue (OUTQ) parameter for the printer file, job description, user profile, and workstation.
AS400SecurityException
- If a security or authority error occurs.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 system.QSYSObjectPathName
,
getOutputQueue()
public void setOwner(java.lang.String owner) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException
owner
- The user profile that is to be the owner of objects created by this user. Possible values are:
AS400SecurityException
- If a security or authority error occurs.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 system.getOwner()
public void setPasswordChangeBlock(java.lang.String pwdChangeBlock) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException
Note: This method should not be used when running to IBM i 5.4 or earlier releases.
pwdChangeBlock
- The time period during which a password is blocked from being changed. Possible values are:
NONE
- The password can be changed at any time.AS400SecurityException
- If a security or authority error occurs.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 system.getPasswordChangeBlock()
public void setPasswordExpirationInterval(int passwordExpirationInterval) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException
passwordExpirationInterval
- The number of days the user's password can remain active before it must be changed. Possible values are:
AS400SecurityException
- If a security or authority error occurs.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 system.getPasswordExpirationInterval()
public void setPasswordExpirationInterval(java.lang.String passwordExpirationInterval) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException
passwordExpirationInterval
- The number of days the user's password can remain active before it must be changed. Possible values are:
AS400SecurityException
- If a security or authority error occurs.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 system.getPasswordExpirationInterval()
public void setPasswordSetExpire(boolean passwordSetExpire) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException
passwordSetExpire
- true if the password set to expired, false otherwise.AS400SecurityException
- If a security or authority error occurs.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 system.isPasswordSetExpire()
public void setPrintDevice(java.lang.String printDevice) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException
Note: This assumes the defaults are specified for the Output queue (OUTQ) parameter for the printer file, job description, user profile, and workstation.
The caller must have *USE authority to the specified print device.
printDevice
- The default printer device for this user. Possible values are:
AS400SecurityException
- If a security or authority error occurs.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 system.getPrintDevice()
public void setSortSequenceTable(java.lang.String sortSequenceTable) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException
sortSequenceTable
- The sort sequence table to be used for string comparisons for this profile. Possible values are:
AS400SecurityException
- If a security or authority error occurs.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 system.QSYSObjectPathName
,
getSortSequenceTable()
public void setSpecialAuthority(java.lang.String[] specialAuthority) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException
The following special authorities are usually given:
Restrictions:
specialAuthority
- The special authorities given to a user. Possible values for the elements of this array are:
NONE
- No special authorities are granted to this user.
SPECIAL_AUTHORITY_ALL_OBJECT
- All object authority is given to the user. The user can access any system resource with or without private user authorizations.
SPECIAL_AUTHORITY_AUDIT
- Audit authority is granted to this user. The user is given the authority to perform auditing functions. Auditing functions include turning auditing on or off for the system and controlling the level of auditing on an object or user.
SPECIAL_AUTHORITY_JOB_CONTROL
- Job control authority is given to the user. The user has authority to change, display, hold, release, cancel, and clear all jobs that are running on the system or that are on a job queue or output queue that has OPRCTL (*YES) specified. The user also has the authority to start writers and to stop active subsystems.
SPECIAL_AUTHORITY_SAVE_SYSTEM
- Save system authority is given to the user profile. This user has the authority to save, restore, and free storage for all objects on the system, with or without object management authority.
SPECIAL_AUTHORITY_IO_SYSTEM_CONFIGURATION
- Input/output (I/O) system configuration authority is given to the user. The user has authority to change system I/O configurations.
SPECIAL_AUTHORITY_SECURITY_ADMINISTRATOR
- Security administrator authority is given to the user. The user can create, change, or delete user profiles if authorized to the Create User Profile (CRTUSRPRF), Change User Profile (CHGUSRPRF), or Delete User Profile (DLTUSRPRF) commands and is authorized to the user profile. This authority does not allow giving special authorities that this user profile does not have. To give *SECADM special authority to another user, a user must have both *ALLOBJ and *SECADM special authorities.
SPECIAL_AUTHORITY_SERVICE
- Service authority is given to this user. The user can perform service functions.
SPECIAL_AUTHORITY_SPOOL_CONTROL
- Spool control authority is given to this user. The user can perform all spool functions.
AS400SecurityException
- If a security or authority error occurs.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 system.getSpecialAuthority()
,
hasSpecialAuthority(java.lang.String)
public void setSpecialEnvironment(java.lang.String specialEnvironment) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException
specialEnvironment
- The special environment in which the user operates after signing on. Possible values are:
NONE
- The user operates in the IBM i system environment after signing on the system.
AS400SecurityException
- If a security or authority error occurs.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 system.getSpecialEnvironment()
public void setStatus(java.lang.String status) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException
The system will disable a user profile if the number of failed sign-on attempts reaches the limit specified on the QMAXSIGN system value and option 2 or 3 has been specified on the QMAXSGNACN system value.
status
- The status of the user profile. Possible values are:
AS400SecurityException
- If a security or authority error occurs.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 system.getStatus()
public void setSupplementalGroups(java.lang.String[] supplementalGroups) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException
Notes:
QAUTPROF, QCLUMGT, QCLUSTER, QCOLSRV, QDBSHR, QDBSHRDO, QDFTOWN, QDIRSRV, QDLFM, QDOC, QDSNX, QEJB, QFNC, QGATE, QIPP, QLPAUTO, QLPINSTALL, QMGTC, QMSF, QNETSPLF, QNFSANON, QNTP, QPEX, QPM400, QRJE, QSNADS, QSPL, QSPLJOB, QSRV, QSRVAGT, QSRVBAS, QSYS, QTCM, QTCP, QTFTP, QTSTRQS, QYCMCIMOM, QYPSJSVR
supplementalGroups
- The user's supplemental group profiles. Possible values for the elements of this array are:
NONE
- No supplemental group profiles are used with this user profile.AS400SecurityException
- If a security or authority error occurs.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 system.getSupplementalGroups()
public void setSystem(AS400 system) throws java.beans.PropertyVetoException
system
- The system object representing the system on which the user profile exists.java.beans.PropertyVetoException
- If any of the registered listeners vetos the property change.getSystem()
public void setUserActionAuditLevel(java.lang.String[] userActionAuditLevel) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException
NONE
.
Implementation note: The method internally calls the Change User Auditing (CHGUSRAUD) command and not the Change User Profile (CHGUSRPRF) command. The caller must have audit (*AUDIT) special authority. Changes take effect the next time a job is started for this user.
userActionAuditLevel
- The level of activity that is audited for this user profile. Possible values for the elements of this array are:
NONE
- No auditing level is specified. The auditing level for this user is taken from system values QAUDLVL and QAUDLVL2.
AS400SecurityException
- If a security or authority error occurs.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 system.getUserActionAuditLevel()
public void setUserClassName(java.lang.String userClassName) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException
userClassName
- The type of user associated with this user profile. Possible values are:
AS400SecurityException
- If a security or authority error occurs.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 system.getUserClassName()
public void setUserExpirationDate(java.util.Date expirationDate) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException, RequestNotSupportedException, ObjectDoesNotExistException
Note: Certain IBM-supplied user profiles cannot specify a user expiration date.
Note: This method should not be used when running to IBM i 6.1 or earlier releases.
expirationDate
- The date when the user profile expires and is automatically disabled. null is returned if the user profile does not have an expiration date.AS400SecurityException
- If a security or authority error occurs.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 system.RequestNotSupportedException
- If the request is not supported.ObjectDoesNotExistException
- If the object does not exist.getUserExpirationDate()
,
setUserExpirationInterval(int)
public void setUserExpirationInterval(int expirationInterval) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException, RequestNotSupportedException
Note: This method should not be used when running to IBM i 6.1 or earlier releases.
expirationInterval
- The number of days from today until the user profile is automatically disabled. Valid values range from 1 through 366. To specify that the user profile has no expiration interval, call setUserExpirationDate(null)
.AS400SecurityException
- If a security or authority error occurs.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 system.RequestNotSupportedException
- If the request is not supported.getUserExpirationInterval()
,
setUserExpirationDate(java.util.Date)
public void setUserID(long userID) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException
userID
- The uid number to be assigned to the user profile. A value from 1 to 4294967294 can be entered. The uid number assigned must not already be assigned to another user profile.AS400SecurityException
- If a security or authority error occurs.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 system.getUserID()
public void setUserOptions(java.lang.String[] userOptions) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException
userOptions
- The level of help information detail to be shown and the function of the Page Up and Page Down keys by default. Possible values include:
NONE
- Detailed information is not shown.
AS400SecurityException
- If a security or authority error occurs.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 system.getUserOptions()
public java.lang.String toString()
toString
in class java.lang.Object