psdi.app.signature

Class MaxUser

java.lang.Object

psdi.mbo.Mbo

psdi.mbo.StatefulMbo

psdi.app.signature.MaxUser

All Implemented Interfaces:

java.rmi.Remote, MaxUserRemote, UpgConstants, MboConstants, MboRemote, StatefulMboRemote, MaxRemoteProxy

public class MaxUser
extends StatefulMbo
implements MaxUserRemote, UpgConstants

Mbo object to represent MaxUser, a person who is allowed to establish client connections to MXServer (depending on status). A user is associated with one or more security groups via the GroupUser table.

This mbo contains non-persistent attributes.

See Signature Package description.

This is a system level object.

The key attribute for this object is UserID.

The attributes in this object are as follows:

Attribute Name	Description
DatabaseUserID	The username for connecting to the native database. This will usually be null, and is not required for Maximo.
DbPassword	Non-persistent attribute. The user's native database password (if databaseuserid is not null).
DbPasswordCheck	Non-persistent attribute. The user's new native database password, which is entered twice when changing password. It must be entered twice to try to ensure there was not a data entry error.
DefSite	The user's default site. Foreign key to Site. (There is no relation between DefSite and StoreroomSite.)
DefStoreroom	The user's default storeroom. DefStoreroom + StoreroomSite are foreign key to Locations table.
EmailPswd	Non-persistent attribute. When user is added or password is changed, indicates whether the user should be force to change password at the next login.
FailedLogins	The number of times in succession that the user tried unsuccessfully to log in. This is tracked only if maxvar LOGINTRACKING is True. It is reset to null when the user successfully logs in or the user status is changed.
ForceExpiration	True to force the user to change password on the next login. False to use the normal expiration date logic.
GeneratedPswd	Non-persistent attribute. Populated via the "Generate Now" button, this is the new password that is randomly generated and displayed on the screen.
InactiveSites	True to allow the user to access inactive sites and organizations in Maximo applications.
LoginID	This is the username used to log in to Maximo. This defaults to the value of UserID, but they do not have to be equal.
Password	The user's Maximo password (stored as encrypted on database).
PasswordCheck	Non-persistent attribute. The user's new Maximo password, which is entered twice when changing password. It must be entered twice to try to ensure there was not a data entry error.
PasswordInput	Non-persistent attribute. The user's new Maximo password.
PasswordOld	Non-persistent attribute. The user's original Maximo password, used when changing password.
PersonID	This users's person identifier. Foreign key to Person.
Expiration	The expiration date of this user's password. Will be non-null only if the group's PASSWORDDURATION is non-null.
PwHintAnswer	The correct answer to the PwHintQuestion, used to verify the identity of a user who is requesting a new password.
PwHintQuestion	The user's password hint question, defined in valuelist PWHINTQUESTION.
QueryWithSite	If True, then the Site or Organization field on any application's Search page will be defaulted based on DefSite. For site-level applications, Site will default to DefSite. For organization-level applications, Organization will default to the organization of DefSite. If this attribute is False, there is no default.
Status	The user's current status, defined in valuelist MAXUSERSTATUS. Status history is in the MaxUserStatus table.
StoreroomSite	Needed to define the default storeroom (DefStoreroom). DefStoreroom + StoreroomSite are foreign key to Locations table. (There is no relation between DefSite and StoreroomSite.)
SynchPasswords	Non-persistent attribute; indicates whether Maximo and native database passwords should be set to the same value (when passwords are being added or changed). Defaults to False.
Type	The user's type, defined in valuelist USERTYPE. This attribute will assist the client in managing their license. Clients can define the license type for each user. A report will describe the types and numbers of users a client has for comparison to their license agreement.
UserID	Unique identifier for the user. This is cached in UserInfo and is also used as the value in the "createdby" and "changedby" fields on many tables.
WFActive	Identifies whether Workflow is active for this user.
WFID	If Workflow is active, this identifies the Workflow ID. See Workflow Package description.

See Also:

MaxGroup, GroupUser

Field Summary

Fields inherited from class psdi.mbo.StatefulMbo

onListTab, statusChangeButtonSigoption, targetStatusOption

Fields inherited from class psdi.mbo.Mbo

MULTILANGCOPY, phantomList, phantomQueue

Fields inherited from interface psdi.app.signature.MaxUserRemote

ACTIVE, BLOCKED, DELETED, INACTIVE

Fields inherited from interface psdi.configure.UpgConstants

DB2, doNotUpdateACTION, doNotUpdateALNDOMAIN, doNotUpdateAPPLICATIONAUTH, doNotUpdateAUTOKEY, doNotUpdateCONDITION, doNotUpdateCONTRACTPROPERTY, doNotUpdateCONTRACTTYPE, doNotUpdateCROSSOVERDOMAIN, doNotUpdateDOCTYPES, doNotUpdateLANGUAGE, doNotUpdateMAXAPPS, doNotUpdateMAXCONDDETAIL, doNotUpdateMAXCONTROLVALUE, doNotUpdateMAXDOMAIN, doNotUpdateMAXLOGAPPENDER, doNotUpdateMAXLOGGER, doNotUpdateMAXMENU, doNotUpdateMAXMESSAGES, doNotUpdateMAXMODULES, doNotUpdateMAXPROP, doNotUpdateMAXPROPVALUE, doNotUpdateMAXROLE, doNotUpdateMAXSEQUENCE, doNotUpdateMAXSERSECURITY, doNotUpdateMAXSERVICE, doNotUpdateMAXTABLEDOMAIN, doNotUpdateMAXVARS, doNotUpdateMAXVARTYPE, doNotUpdateMXCOLLAB, doNotUpdateMXCOLLABREF, doNotUpdateNUMERICDOMAIN, doNotUpdateNUMRANGEDOMAIN, doNotUpdatePORTLET, doNotUpdatePRICALC, doNotUpdateSECURITYRESTRICT, doNotUpdateSIGOPTION, doNotUpdateSYNONYMDOMAIN, doNotUpdateTAXTYPE, doNotUpdateWORKPRIORITY, doNotUpdateWORKTYPE, doNotUpdateWPEDITSETTING, messageCache, NEWONLY, OLDANDNEW, OLDONLY, ORACLE, SQLINET, SQLMICROSOFT, SQLSERVER, SYSDATATABLES, SYSTEMTABLES, UNKNOWN

Fields inherited from interface psdi.mbo.MboConstants

ALLROWS, CHANGEDBY_USER, COUNT_ADDITIONS, COUNT_AFTERSAVE, COUNT_DATABASE, COUNT_DELETED, COUNT_EXISTING, DBCONFIG, DELAYVALIDATION, DELAYVALIDATIONONLY, DISCARDABLE, GOTCOMPLETEWHERE, HIDDEN, NO_RELATEDMBOS_OF_OWNERSCHILDREN_FETCH, NOACCESSCHECK, NOACTION, NOADD, NOCOMMIT, NODELETE, NONE, NOOVERWRITE, NOSAVE, NOSETVALUE, NOUPDATE, NOVALIDATION, NOVALIDATION_AND_NOACTION, NOVALIDATION_AND_NOACTION_ALLOWCROSSOVER, READONLY, REBUILD, REQUIRED, SAMEVALUEVALIDATION, SETBYPARENT, USER

Constructor Summary

Constructors

Constructor and Description
MaxUser(MboSet ms) Construct the MaxUser object.

Method Summary

Modifier and Type	Method and Description
void	add() Add a mbo, defaulting the attributes shown below.
void	addDBUser(java.lang.String dbuserid) Perform the database-specific calls needed to add a user (databaseuserid).
void	addGroupUser() Add default rows to GroupUser when new User is being added.
void	addGrpReassignAuthForUserInsert() When user is added to a group that has USER-INSERT privilege, or that privilege is added to a group, then all users in that group need privilege to add people to the default group and the "everyone" group.
void	addLoginTracking(boolean attemptResult) Deprecated. See Harrier Esig spec
void	addLoginTracking(boolean attemptResult, java.lang.String app, java.lang.String reason, java.lang.String transid, java.lang.String[] keyvalue) Deprecated. See Harrier Esig spec
void	addLoginTracking(boolean attemptResult, java.lang.String app, java.lang.String reason, java.lang.String transid, java.lang.String[] keyvalue, java.lang.String ownerTable, java.lang.String ownerId) Deprecated. See Harrier Esig spec
MboRemote	addLoginTracking(java.lang.String attemptResult) Call addLoginTracking with second param true.
MboRemote	addLoginTracking(java.lang.String attemptResult, boolean updateStatus) Add mbo to LoginTracking reflecting the successful or unsuccessful login.
MboRemote	addMaxSession() Add a row to MaxSession when user is logging in.
void	addServerSession() Add a row to MaxSession when user is logging in.
void	appValidate() Pre-save validation method.
void	authorizeGroups(MboSetRemote groupSet, java.lang.String relationship) For multiselect of groups for GrpReassignAuth or GroupUser.
void	cancelMainRecordDialog(java.lang.String id) Cancel the dialog "grpassign", "chgperson", or "pwhint".
boolean	canChangePassword() Can this session user change the password of this MaxUser mbo? Starting with Merlin, this always returns True (unless using LDAP).
void	canDelete() If maxvar LOGINTRACKING is True, then MaxUser can NEVER be deleted.
void	changeDBPassword() Perform the database-specific calls needed to change a native database password (for databaseuserid, dbpassword).
void	clearGenPswdInfo() Clear values for passwordinput, passwordcheck, and generatedpswd.
void	clearUserProfileHierarchySet()
protected void	commit()
MboRemote	createPersonMbo(java.lang.String personID, MboSetRemote personSet) Deprecated. Use createPersonMbo.
MboRemote	createPersonMbo(java.lang.String personID, MboSetRemote personSet, boolean doAutokey) Called only when adding a user, to create a Person mbo.
void	delete(long accessModifier) Delete this mbo.
void	deleteDBUser(java.lang.String deleteID) Perform the database-specific calls needed to drop a user (databaseuserid).
boolean	deleteThisUser() Calls deleteThisUser with param NONE.
boolean	deleteThisUser(long accessModifier) Convenience method to delete a user instead of calling the regular delete.
MboRemote	duplicate() Call copy.
java.lang.String	encryptEsigPassword(java.lang.String esigPass)
void	generatePassword()
int	getDbIn() Return native database platform (dbIn)
java.lang.String	getOldLoginID()
java.lang.String	getProcess() Return the name of the work flow process (USERSTATUS).
protected StatusHandler	getStatusHandler() Return a status handler (MaxUserStatusHandler) to change the user status.
protected MboSetRemote	getStatusHistory() Return the user status object (MAXUSERSTATUS).
java.lang.String	getStatusListName() Return MAXUSERSTATUS, name of valuelist for user statuses.
void	init() Since the business objects are not supposed to check privilege, it is incumbent upon the UI to check privilege for the following: ADDUSERS -- If toBeAdded and no privilege for ADDUSERS, then group name should be readonly.
void	initFieldFlagsOnMbo(java.lang.String attrName) The logic of setting the readonly and required field flags to the mbo.
boolean	isActive() Is this user Active?
boolean	isBlocked() Is this user Blocked?
void	isDBPasswordValid() Is the native database password valid? Throws system/notvalid if the dbpassword is not valid.
boolean	isDeleted() Is this user Deleted?
boolean	isInactive() Is this user Inactive?
boolean	isPasswordValid() Is the Maximo password valid? Compares password to passwordCheck to ensure they are equal.
void	maxUserCanDelete() Similar to canDelete, for remote interface.
void	openMainRecordDialog(java.lang.String id) Open the dialog "grpassign", "chgperson", or "pwhint".
void	recheckPasswordAuthority() Recheck password change authority.
void	resetNativeEsigKey()
void	save() Perform any processing re: changing native dbpassword; then save the mbo.
protected void	sendEsigResetNotf()
void	setBlocked(java.lang.String memo) Set this user's status to BLOCKED.
void	setLoginIdDefault() Called from FldMaxUserUserID when adding a new user.
void	setOldLoginID(java.lang.String oldLoginID)
void	setValue(java.lang.String attributeName, java.lang.String val, long accessModifier) Set value for the specified attribute.
boolean	showProfileWarning() If any info was changed via My Profile app that did not update the cached user profile, and there is more than one active session for this UserID, then return True.
protected boolean	skipCopyField(MboValueInfo mvi) Fields to skip when copying mbo.
boolean	toBeSaved() Does the object need to be saved to persistent storage ? This will also check for change of Maximo and native password.
void	undelete() Unmark the Mbo for deletion.
void	undeleteThisUser()
boolean	userExistsOnDB(java.sql.Connection con, java.lang.String checkID) Determine whether this user already exists on the native DB (databaseuserid).
boolean	userWasDuplicated() Identifies whether we're in the process of duplicating a user, there this is the new user.

Methods inherited from class psdi.mbo.StatefulMbo

canChangeMaxStatus, canChangeStatus, canChangeStatus, canChangeStatus, canDeleteAttachedDocs, changeMaxStatus, changeMaxStatus, changeStatus, changeStatus, changeStatus, checkForOpenStatus, checkStatusChangeAuthorization, filterByValidStatusList, fireEvent, getInternalStatus, getOnListTab, getOverridePVStatusException, getStatusChangeButtonSigoption, getStatusList, getTargetStatusOption, getValidStatusList, setOnListTab, setOverridePVStatusException, setStatusChangeButtonSigoption, setTargetStatusOption, statusToOptionName

Methods inherited from class psdi.mbo.Mbo

addMboSetForRequiredCheck, addToDeleteForInsertList, andEvaluateConditions, blindCopy, checkFieldAccess, checkMethodAccess, checkMethodAccess, checkQualifiedRestriction, checkRecordLock, checkSiteOrgAccessForSave, clear, clearRelatedSets, clearRelatedSets, copy, copy, copy, copyFake, copyValue, copyValue, createComm, delete, deleteDoclinks, determineRequiredFieldsFromERM, enableMethod, evaluateCondition, evaluateCondition, evaluateCtrlConditions, evaluateCtrlConditions, evaluateRestriction, excludeObjectForPropagate, findAllNullRequiredFields, generateAutoKey, generateContentUID, getAlwaysFlags, getAttrRestrictionFlag, getAttrRestrictions, getBoolean, getByte, getBytes, getCheckpoint, getClientLocale, getClientTimeZone, getCommLogOwnerNameAndUniqueId, getCondition, getDatabaseValue, getDate, getDeleteForInsertList, getDocLinksCount, getDomainFilterWhere, getDomainIDs, getDouble, getESId, getExistingMboSet, getFetchIndex, getFieldExceptions, getFlags, getFloat, getIgnoreLockCheck, getInitialValue, getInsertCompanySetId, getInsertItemSetId, getInsertOrganization, getInsertOrgForSite, getInsertSite, getInstanciatedMboSet, getInstanciatedMboValue, getInt, getIntegrationService, getKeyValue, getLanguageRecordRowStamp, getLinesRelationship, getList, getLockedByDisplayName, getLockedByUserID, getLong, getMatchingAttr, getMatchingAttr, getMatchingAttrs, getMaxMessage, getMboCtx, getMboData, getMboDataSet, getMboForAttribute, getMboForAttributeStatic, getMboInitialValue, getMboList, getMboLogger, getMboRecordData, getMboServer, getMboSet, getMboSet, getMboSet, getMboSetInfo, getMboSetInfo, getMboValue, getMboValueData, getMboValueData, getMboValueData, getMboValueDataForDownload, getMboValueInfoStatic, getMboValueInfoStatic, getMessage, getMessage, getMessage, getMessage, getMXTransaction, getName, getOrgForGL, getOrgSiteForMaxvar, getOwner, getProfile, getPropagateKeyFlag, getProxy, getRecordIdentifer, getRecordMboName, getRecordType, getRelatedSets, getRelatedWhere, getRelatedWhere, getRelationshipNameToLangTable, getResourceName, getRowRestrictionFlag, getRowStamp, getRowStampObject, getSecurityLogger, getSiteOrg, getSqlLogger, getString, getString, getStringInBaseLanguage, getStringInSpecificLocale, getStringTransparent, getSynonymValueWhere, getTenantId, getTenantIdForNoMboRecordData, getThisMboSet, getTranslator, getUniqueIdentifer, getUniqueIDName, getUniqueIDValue, getUniqueLanguageIDRecord, getUserInfo, getUserName, getValidateOrder, hasFieldAccess, hasHierarchyLink, hasLockSaveRights, hasRelatedQbe, hasUniqueID, initRelationship, isApiBatchError, isAppLockEnabled, isAutoKeyed, isBasedOn, isChangeByUserWhenSetFromLookup, isDuringInit, isEAuditFieldModified, isESigFieldModified, isFlagSet, isForDM, isLocked, isLocked, isLockedByMe, isMasterTenant, isMboLockedByMe, isModified, isModified, isNew, isNoSql, isNull, isOptionGranted, isSelected, isSkipCopyField, isValid, isZombie, lock, modify, moveFieldFlagsToMboValue, needCallInitFieldFlag, orEvaluateConditions, propagateKeyValue, removeCtx, removeRelatedSet, resolveNoSqlWhere, rollbackToCheckpoint, select, setAppDefaultValue, setApplicationError, setApplicationRequired, setAutokeyFields, setCopyDefaults, setDatabaseDefaultValues, setDatabaseDefaultValues, setDefaultValue, setDefaultValues, setDeleted, setDuringInit, setEAuditFieldModified, setESId, setESigFieldModified, setFetchIndex, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlags, setFlag, setFlag, setFlags, setForDM, setHierarchyLink, setIgnoreRecordLockCheck, setLangCodeDefault, setMboCtx, setMLValue, setModified, setModifiedForIntegrationOnly, setNewMbo, setNoSql, setPropagateKeyFlag, setPropagateKeyFlag, setProxy, setReadonlyWhenParentIsReadonly, setRecordType, setReferencedMbo, setReferencedMbo, setResolveNoSqlWhere, setResourceName, setTenantIdForNoMboRecordData, setUniqueIDValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueFromSequence, setValueNull, setValueNull, sigopGranted, sigopGranted, sigopGranted, sigopGranted, sigOptionAccessAuthorized, smartFill, smartFind, smartFind, smartFind, smartFindByObjectName, smartFindByObjectName, smartFindByObjectNameDirect, startCheckpoint, thisToBeUpdated, throwRequiredException, toBeAdded, toBeDeleted, toBeUpdated, toBeValidated, undeleteDoclinks, unlock, unselect, useDataSecurity, validate, validateAttributes, validateKeyUniqueness, valueChanged

Methods inherited from class java.lang.Object

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

Methods inherited from interface psdi.mbo.StatefulMboRemote

canChangeMaxStatus, canChangeStatus, canChangeStatus, canDeleteAttachedDocs, changeMaxStatus, changeMaxStatus, changeStatus, changeStatus, changeStatus, checkForOpenStatus, getInternalStatus, getOnListTab, getOverridePVStatusException, getStatusChangeButtonSigoption, getStatusList, getTargetStatusOption, getValidStatusList, setOnListTab, setOverridePVStatusException, setStatusChangeButtonSigoption, setTargetStatusOption

Methods inherited from interface psdi.mbo.MboRemote

addMboSetForRequiredCheck, addToDeleteForInsertList, blindCopy, checkMethodAccess, clear, copy, copy, copy, copyFake, copyValue, copyValue, createComm, delete, evaluateCondition, evaluateCtrlConditions, evaluateCtrlConditions, excludeObjectForPropagate, generateAutoKey, getBoolean, getByte, getBytes, getCommLogOwnerNameAndUniqueId, getDatabaseValue, getDate, getDeleteForInsertList, getDocLinksCount, getDomainIDs, getDouble, getExistingMboSet, getFlags, getFloat, getIgnoreLockCheck, getInitialValue, getInsertCompanySetId, getInsertItemSetId, getInsertOrganization, getInsertSite, getInt, getKeyValue, getLinesRelationship, getList, getLockedByDisplayName, getLong, getMatchingAttr, getMatchingAttr, getMatchingAttrs, getMaxMessage, getMboData, getMboDataSet, getMboInitialValue, getMboList, getMboSet, getMboSet, getMboSet, getMboValueData, getMboValueData, getMboValueData, getMboValueDataForDownload, getMboValueInfoStatic, getMboValueInfoStatic, getMessage, getMessage, getMessage, getMessage, getMXTransaction, getName, getOrgForGL, getOrgSiteForMaxvar, getOwner, getPropagateKeyFlag, getRecordIdentifer, getSiteOrg, getString, getString, getStringInBaseLanguage, getStringInSpecificLocale, getStringTransparent, getThisMboSet, getUniqueIDName, getUniqueIDValue, getUserInfo, getUserName, hasHierarchyLink, hasLockSaveRights, isAutoKeyed, isBasedOn, isFlagSet, isForDM, isLocked, isLocked, isMasterTenant, isMboLockedByMe, isModified, isModified, isNew, isNull, isOptionGranted, isSelected, isZombie, lock, propagateKeyValue, rollbackToCheckpoint, select, setApplicationError, setApplicationRequired, setAutokeyFields, setCopyDefaults, setDeleted, setESigFieldModified, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlags, setFlag, setFlag, setFlags, setForDM, setIgnoreRecordLockCheck, setMLValue, setModified, setNewMbo, setPropagateKeyFlag, setPropagateKeyFlag, setReferencedMbo, setReferencedMbo, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueNull, setValueNull, sigopGranted, sigopGranted, sigopGranted, sigOptionAccessAuthorized, smartFill, smartFind, smartFind, smartFind, smartFindByObjectName, smartFindByObjectName, smartFindByObjectNameDirect, startCheckpoint, thisToBeUpdated, toBeAdded, toBeDeleted, toBeUpdated, toBeValidated, unlock, unselect, validate, validateAttributes

Constructor Detail

MaxUser

public MaxUser(MboSet ms)
        throws java.rmi.RemoteException

Construct the MaxUser object.

Throws:

java.rmi.RemoteException

Method Detail

getProcess

public java.lang.String getProcess()

Return the name of the work flow process (USERSTATUS).

getStatusHistory

protected MboSetRemote getStatusHistory()
                                 throws MXException,
                                        java.rmi.RemoteException

Return the user status object (MAXUSERSTATUS). Required for statefulness.

Specified by:

getStatusHistory in class StatefulMbo

Throws:

MXException

java.rmi.RemoteException

getStatusHandler

protected StatusHandler getStatusHandler()

Return a status handler (MaxUserStatusHandler) to change the user status.

Specified by:

getStatusHandler in class StatefulMbo

getStatusListName

public java.lang.String getStatusListName()

Return MAXUSERSTATUS, name of valuelist for user statuses.

Specified by:

getStatusListName in interface StatefulMboRemote

Specified by:

getStatusListName in class StatefulMbo

init

public void init()
          throws MXException

Since the business objects are not supposed to check privilege, it is incumbent upon the UI to check privilege for the following:

1. ADDUSERS -- If toBeAdded and no privilege for ADDUSERS, then group name should be readonly. This should force the use of the default value for group name when adding a user. If toBeAdded and there IS privilege for ADDUSERS, then group name can be changed.
2. REASSIGN -- If not adding, and no privilege for REASSIGN, then group name should be readonly.

Overrides:

init in class Mbo

Throws:

MXException

See Also:

MXServer.getDatabaseProductName()

getDbIn

public int getDbIn()

Return native database platform (dbIn)

add

public void add()
         throws MXException,
                java.rmi.RemoteException

Add a mbo, defaulting the attributes shown below.

Attribute Name	Attribute Value
ForceExpiration	True
Status	from valuelistMAXUSERSTATUS, maxvalue ACTIVE
SynchPasswords	False
SysUser	False
Type	from valuelistUSERTYPE, maxvalue TYPE 1

Specified by:

add in interface MboRemote

Overrides:

add in class Mbo

Throws:

MXException

java.rmi.RemoteException

delete

public void delete(long accessModifier)
            throws MXException,
                   java.rmi.RemoteException

Delete this mbo. Calls deleteChildren.

The preferred way to initiate deleting a user is by calling deleteThisUser.

Specified by:

delete in interface MboRemote

Overrides:

delete in class Mbo

Parameters:

accessModifier - The bitwise flag specified to determine if certain normal security checks are to be bypassed for this delete request. For example: if the accessModifer is NOACCESSCHECK, then the check for the object's NODELETE flag and the call to the object's canDelete() method will not be performed. If the accessModifer is NONE, then all the access checks are performed before this object is marked delete.

Throws:

MXException

java.rmi.RemoteException

See Also:

Mbo.delete(long)

undelete

public void undelete()
              throws MXException,
                     java.rmi.RemoteException

Description copied from class: Mbo

Unmark the Mbo for deletion. Can only be called after a delete() and before the save() has been performed. This method will also unmark associated Long Description and Translation Mbos.

Specified by:

undelete in interface MboRemote

Overrides:

undelete in class Mbo

Throws:

MXException

java.rmi.RemoteException

deleteThisUser

public boolean deleteThisUser()
                       throws MXException,
                              java.rmi.RemoteException

Calls deleteThisUser with param NONE.

Specified by:

deleteThisUser in interface MaxUserRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

MaxUser.deleteThisUser

undeleteThisUser

public void undeleteThisUser()
                      throws MXException,
                             java.rmi.RemoteException

Specified by:

undeleteThisUser in interface MaxUserRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

MaxUser.undeleteThisUser()

deleteThisUser

public boolean deleteThisUser(long accessModifier)
                       throws MXException,
                              java.rmi.RemoteException

Convenience method to delete a user instead of calling the regular delete.

If LoginTracking maxvar is False, this method calls delete.
If LoginTracking maxvar is True, this method calls deleteChildren and sets this user status to Inactive.
This method also sets the variable deleteThisUser to True.

Returns:

True if user was deleted, False if cancelled from the yes/no/cancel dialog

Throws:

MXException

java.rmi.RemoteException

maxUserCanDelete

public void maxUserCanDelete()
                      throws MXException,
                             java.rmi.RemoteException

Similar to canDelete, for remote interface.

Specified by:

maxUserCanDelete in interface MaxUserRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

MaxUser.activeWorkflowAssignment()

canDelete

public void canDelete()
               throws MXException,
                      java.rmi.RemoteException

If maxvar LOGINTRACKING is True, then MaxUser can NEVER be deleted. However, see deleteThisUser. Also, if active workflow assignment exists, user cannot be deleted.

Overrides:

canDelete in class Mbo

Throws:

MXException

java.rmi.RemoteException

See Also:

MaxUser.maxUserCanDelete()

toBeSaved

public boolean toBeSaved()
                  throws java.rmi.RemoteException

Does the object need to be saved to persistent storage ? This will also check for change of Maximo and native password.

Specified by:

toBeSaved in interface MboRemote

Overrides:

toBeSaved in class Mbo

Throws:

java.rmi.RemoteException

userWasDuplicated

public boolean userWasDuplicated()

Identifies whether we're in the process of duplicating a user, there this is the new user.

Specified by:

userWasDuplicated in interface MaxUserRemote

Returns:

True if in the process of duplication

See Also:

MaxUser.dupMbo

duplicate

public MboRemote duplicate()
                    throws MXException,
                           java.rmi.RemoteException

Call copy.

Specified by:

duplicate in interface MboRemote

Overrides:

duplicate in class Mbo

Throws:

MXException

java.rmi.RemoteException

resetNativeEsigKey

public void resetNativeEsigKey()
                        throws java.rmi.RemoteException,
                               MXException

Throws:

java.rmi.RemoteException

MXException

skipCopyField

protected boolean skipCopyField(MboValueInfo mvi)
                         throws java.rmi.RemoteException,
                                MXException

Fields to skip when copying mbo.

Overrides:

skipCopyField in class Mbo

Parameters:

mvi - The MboValueInfo describing this attribute

Returns:

True to skip this attribute

Throws:

java.rmi.RemoteException

MXException

appValidate

public void appValidate()
                 throws MXException,
                        java.rmi.RemoteException

Pre-save validation method.

The framework will ensure that Laborcode is not null.

The UI should ensure that if adding a user and there is no privilege for ADDUSERS (i.e. the user is self-registering), the group name must equal the default group (see getNewUserGroup.

Overrides:

appValidate in class Mbo

Throws:

MXException

java.rmi.RemoteException

See Also:

MaxUser.recheckPasswordAuthority(), MaxUser.isPasswordValid(), MaxUser.userExistsOnDB(java.sql.Connection, java.lang.String), MaxUser.canChangePassword(), MaxUser.setExpiration(java.util.Date), MaxUser.writePasswordHistory(), MaxUser.isDBPasswordValid()

sendEsigResetNotf

protected void sendEsigResetNotf()
                          throws MXException,
                                 java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

recheckPasswordAuthority

public void recheckPasswordAuthority()
                              throws MXException,
                                     java.rmi.RemoteException

Recheck password change authority.

Throws:

MXException

java.rmi.RemoteException

encryptEsigPassword

public java.lang.String encryptEsigPassword(java.lang.String esigPass)

save

public void save()
          throws MXException,
                 java.rmi.RemoteException

Perform any processing re: changing native dbpassword; then save the mbo. Fredrik 8/10, Added MT functionality. Check to see if we are changing password for any of the users in the Maximo.property and if so, update it.

Overrides:

save in class StatefulMbo

Throws:

MXException

java.rmi.RemoteException

See Also:

MaxUser.changeDBPassword()

commit

protected void commit()

Overrides:

commit in class Mbo

isActive

public boolean isActive()
                 throws MXException,
                        java.rmi.RemoteException

Is this user Active?

Specified by:

isActive in interface MaxUserRemote

Returns:

True if active, else False

Throws:

MXException

java.rmi.RemoteException

See Also:

MaxUser.isActive()

isInactive

public boolean isInactive()
                   throws MXException,
                          java.rmi.RemoteException

Is this user Inactive?

Specified by:

isInactive in interface MaxUserRemote

Returns:

True if inactive, else False

Throws:

MXException

java.rmi.RemoteException

See Also:

MaxUser.isInactive()

isBlocked

public boolean isBlocked()
                  throws MXException,
                         java.rmi.RemoteException

Is this user Blocked?

Specified by:

isBlocked in interface MaxUserRemote

Returns:

True if blocked, else False

Throws:

MXException

java.rmi.RemoteException

See Also:

MaxUser.isBlocked()

setBlocked

public void setBlocked(java.lang.String memo)
                throws MXException,
                       java.rmi.RemoteException

Set this user's status to BLOCKED.

Parameters:

memo - Freeform comment; can be null.

Throws:

MXException

java.rmi.RemoteException

isDeleted

public boolean isDeleted()
                  throws MXException,
                         java.rmi.RemoteException

Is this user Deleted?

Specified by:

isDeleted in interface MaxUserRemote

Returns:

True if deleted, else False

Throws:

MXException

java.rmi.RemoteException

See Also:

MaxUser.isDeleted()

addLoginTracking

@Deprecated
public void addLoginTracking(boolean attemptResult)
                                  throws MXException,
                                         java.rmi.RemoteException

Deprecated. See Harrier Esig spec

Add mbo to LoginTracking reflecting the successful or unsuccessful login. Calls addLoginTracking.

Specified by:

addLoginTracking in interface MaxUserRemote

Parameters:

attemptResult - True for successful login, else False

Throws:

MXException

java.rmi.RemoteException

See Also:

MaxUser.addLoginTracking(boolean)

addLoginTracking

@Deprecated
public void addLoginTracking(boolean attemptResult,
                                         java.lang.String app,
                                         java.lang.String reason,
                                         java.lang.String transid,
                                         java.lang.String[] keyvalue)
                                  throws MXException,
                                         java.rmi.RemoteException

Deprecated. See Harrier Esig spec

Add mbo to LoginTracking reflecting the successful or unsuccessful login. May also update MaxUser.failedlogins and MaxUser.status.

Do NOT update anything if Maxvar LOGINTRACKING is False.

Called from MaxUserSet addLoginTracking.

Specified by:

addLoginTracking in interface MaxUserRemote

Parameters:

attemptResult - True for successful login, else False

app - The application name (optional). Used for ESIG.

reason - The reason code (optional). Used for ESIG.

transid - The transaction ID (optional). Used for ESIG.

keyvalue - Array of up to seven key values (optional). Used for ESIG to identify a mbo in the main set for the app.

Throws:

MXException

java.rmi.RemoteException

See Also:

MaxUser.addLoginTracking(boolean, String, String, String, String[])

addLoginTracking

@Deprecated
public void addLoginTracking(boolean attemptResult,
                                         java.lang.String app,
                                         java.lang.String reason,
                                         java.lang.String transid,
                                         java.lang.String[] keyvalue,
                                         java.lang.String ownerTable,
                                         java.lang.String ownerId)
                                  throws MXException,
                                         java.rmi.RemoteException

Deprecated. See Harrier Esig spec

Add mbo to LoginTracking reflecting the successful or unsuccessful login. May also update MaxUser.failedlogins and MaxUser.status.

Do NOT update anything if Maxvar LOGINTRACKING is False.

Called from MaxUserSet addLoginTracking.

Specified by:

addLoginTracking in interface MaxUserRemote

Parameters:

attemptResult - True for successful login, else False

app - The application name (optional). Used for ESIG.

reason - The reason code (optional). Used for ESIG.

transid - The transaction ID (optional). Used for ESIG.

keyvalue - Array of up to seven key values (optional). Used for ESIG to identify a mbo in the main set for the app.

ownerTable - Owner table for esig

ownerId - unique id for the esig record

Throws:

MXException

java.rmi.RemoteException

See Also:

MaxUser.addLoginTracking(boolean, String, String, String, String[],String, String)

addLoginTracking

public MboRemote addLoginTracking(java.lang.String attemptResult)
                           throws MXException,
                                  java.rmi.RemoteException

Call addLoginTracking with second param true.

Specified by:

addLoginTracking in interface MaxUserRemote

Parameters:

attemptResult - From domain ATTEMPTRESULT.

Returns:

The new LoginTracking mbo.

Throws:

MXException

java.rmi.RemoteException

See Also:

MaxUser.addLoginTracking(String, boolean)

addLoginTracking

public MboRemote addLoginTracking(java.lang.String attemptResult,
                                  boolean updateStatus)
                           throws MXException,
                                  java.rmi.RemoteException

Add mbo to LoginTracking reflecting the successful or unsuccessful login. May also update MaxUser.failedlogins and MaxUser.status.

Do NOT update anything if Maxvar LOGINTRACKING is False.

Specified by:

addLoginTracking in interface MaxUserRemote

Parameters:

attemptResult - From domain ATTEMPTRESULT.

updateStatus - True if user status should be updated when called for by the business rules (for example, block the user if excessive number of bad logins). This param should normally be true except for certain situations in SecurityService.

Returns:

The new LoginTracking mbo.

Throws:

MXException

java.rmi.RemoteException

See Also:

MaxUser.addLoginTracking(String, boolean)

addMaxSession

public MboRemote addMaxSession()
                        throws MXException,
                               java.rmi.RemoteException

Add a row to MaxSession when user is logging in. Called from SecurityService.

Specified by:

addMaxSession in interface MaxUserRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

MaxUser.addMaxSession()

addServerSession

public void addServerSession()
                      throws MXException,
                             java.rmi.RemoteException

Add a row to MaxSession when user is logging in. Called from SecurityService.

Specified by:

addServerSession in interface MaxUserRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

MaxUser.addServerSession()

isPasswordValid

public boolean isPasswordValid()
                        throws MXException,
                               java.rmi.RemoteException

Is the Maximo password valid? Compares password to passwordCheck to ensure they are equal. Also does other validations. Throws various errors if the password is not valid. Called from appValidate.

Returns:

true = password is valid; false = not valid.

Throws:

MXException

java.rmi.RemoteException

See Also:

SignatureService.validatePassword(String, String, UserInfo, MboRemote)

isDBPasswordValid

public void isDBPasswordValid()
                       throws MXException,
                              java.rmi.RemoteException

Is the native database password valid? Throws system/notvalid if the dbpassword is not valid. Called from appValidate.

Throws:

MXException

java.rmi.RemoteException

See Also:

MaxUser.deleteDBUser(java.lang.String), MaxUser.addDBUser(java.lang.String)

addDBUser

public final void addDBUser(java.lang.String dbuserid)
                     throws MXException

Perform the database-specific calls needed to add a user (databaseuserid).

For Oracle, if the user doesn't exist, do the following:

• Create user
• Grant create session

For SQLServer, do the following:

• If no login, call sp_addlogin.
• If no user, call sp_adduser.

For Oracle, the "schema owner" is used to obtain the names of the default and temporary tablespaces.

Throws:

MXException

See Also:

MaxUser.userExistsOnDB(java.sql.Connection, java.lang.String), AppService.getSchemaOwner(), MaxUserSet.getSystemUserInfo(), UserInfo.getConnectionKey()

deleteDBUser

public final void deleteDBUser(java.lang.String deleteID)
                        throws MXException

Perform the database-specific calls needed to drop a user (databaseuserid).

For Oracle, this executes drop user.
For SQLServer, this executes both sp_dropuser and sp_droplogin.

Called from save.

Parameters:

deleteID - The userID to be deleted.

Throws:

MXException

See Also:

MaxUser.userExistsOnDB(java.sql.Connection, java.lang.String), MaxUserSet.getSystemUserInfo(), UserInfo.getConnectionKey()

canChangePassword

public boolean canChangePassword()
                          throws MXException,
                                 java.rmi.RemoteException

Can this session user change the password of this MaxUser mbo? Starting with Merlin, this always returns True (unless using LDAP).

Specified by:

canChangePassword in interface MaxUserRemote

Returns:

True = can change password; False = cannot change password

Throws:

MXException

java.rmi.RemoteException

See Also:

MXServerInfo.useAppServerSecurity

changeDBPassword

public final void changeDBPassword()
                            throws MXException

Perform the database-specific calls needed to change a native database password (for databaseuserid, dbpassword).

Throws:

MXException

See Also:

MaxUserSet.getSystemUserInfo(), UserInfo.getConnectionKey()

userExistsOnDB

public final boolean userExistsOnDB(java.sql.Connection con,
                                    java.lang.String checkID)
                             throws MXException,
                                    java.rmi.RemoteException

Determine whether this user already exists on the native DB (databaseuserid). This check should be performed prior to attempting to save a new MaxUser!

For Oracle, this method selects from all_users.
For SQLServer, this method selects from syslogins.

Parameters:

con - Connection. Can be null. If null, it is created and closed within this method.

checkID - The database user ID to be checked for.

Returns:

True = user already exists on this native DB.

Throws:

MXException

java.rmi.RemoteException

See Also:

MaxUserSet.getSystemUserInfo(), UserInfo.getConnectionKey()

addGroupUser

public void addGroupUser()
                  throws MXException,
                         java.rmi.RemoteException

Add default rows to GroupUser when new User is being added.

Specified by:

addGroupUser in interface MaxUserRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

SignatureService.getNewUserGroup(psdi.security.UserInfo), SignatureService.getEveryoneGroup(psdi.security.UserInfo)

createPersonMbo

@Deprecated
public MboRemote createPersonMbo(java.lang.String personID,
                                             MboSetRemote personSet)
                                      throws MXException,
                                             java.rmi.RemoteException

Deprecated. Use createPersonMbo.

Specified by:

createPersonMbo in interface MaxUserRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

MaxUser.createPersonMbo(String, MboSetRemote)

createPersonMbo

public MboRemote createPersonMbo(java.lang.String personID,
                                 MboSetRemote personSet,
                                 boolean doAutokey)
                          throws MXException,
                                 java.rmi.RemoteException

Called only when adding a user, to create a Person mbo. Since the PersonID can be changed multiple times before saving, this method has to clean out any previously-added and now obsolete Person mbos.

Specified by:

createPersonMbo in interface MaxUserRemote

Parameters:

personID - The personID to use on the Person mbo (unless autokeying).

personSet - This MaxUser mbo owns set of Person, MaxUserSetRemote.PERSON.

doAutokey - If true and if the PersonID attribute allows autokeying, then use the autokey value rather than the value of personID param.

Returns:

The Person mbo just created for the specified personID.

Throws:

MXException

java.rmi.RemoteException

See Also:

MaxUser.createPersonMbo(String, MboSetRemote, boolean)

openMainRecordDialog

public void openMainRecordDialog(java.lang.String id)
                          throws MXException,
                                 java.rmi.RemoteException

Open the dialog "grpassign", "chgperson", or "pwhint". Load dialogStates. If the dialog is cancelled, cancelMainRecordDialog will be invoked. Called from UserBean.

Specified by:

openMainRecordDialog in interface MaxUserRemote

Parameters:

id - Dialog name

Throws:

MXException

java.rmi.RemoteException

See Also:

MaxUser.openMainRecordDialog(java.lang.String)

cancelMainRecordDialog

public void cancelMainRecordDialog(java.lang.String id)
                            throws MXException,
                                   java.rmi.RemoteException

Cancel the dialog "grpassign", "chgperson", or "pwhint". This assumes that openMainRecordDialog was called when the dialog was first built. Set this MaxUser record back to the original "modified" state as when the dialog was first entered. Called from cancelDialog.

Specified by:

cancelMainRecordDialog in interface MaxUserRemote

Parameters:

id - Dialog name

Throws:

MXException

java.rmi.RemoteException

See Also:

MaxUserSet.setToBeSaved(boolean)

clearUserProfileHierarchySet

public void clearUserProfileHierarchySet()
                                  throws MXException,
                                         java.rmi.RemoteException

Specified by:

clearUserProfileHierarchySet in interface MaxUserRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

UserProfileHierarchySet.clearProfile(java.lang.String)

showProfileWarning

public boolean showProfileWarning()
                           throws MXException,
                                  java.rmi.RemoteException

If any info was changed via My Profile app that did not update the cached user profile, and there is more than one active session for this UserID, then return True. This info includes language, locale and timezone. Most of the other info in My Profile does update the cached Profile. This is called from MyProfileBean.

Specified by:

showProfileWarning in interface MaxUserRemote

Returns:

True is info was changed but cached Profile was not updated, and there is more than one session for this user.

Throws:

MXException

java.rmi.RemoteException

See Also:

MaxUser.showProfileWarning()

setLoginIdDefault

public void setLoginIdDefault()
                       throws MXException,
                              java.rmi.RemoteException

Called from FldMaxUserUserID when adding a new user. Set loginid equal to the input mixed-case value of userID.

Specified by:

setLoginIdDefault in interface MaxUserRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

MaxUser.setLoginIdDefault()

setValue

public void setValue(java.lang.String attributeName,
                     java.lang.String val,
                     long accessModifier)
              throws MXException,
                     java.rmi.RemoteException

Set value for the specified attribute.

Specified by:

setValue in interface MboRemote

Overrides:

setValue in class Mbo

Parameters:

attributeName - The attribute name within the current object.

val - The string value to set to the attribute.

accessModifier - The bitwise flags such as NOACCESSCHECK, NOVALIDATION_AND_NOACTION, and DELAYVALIDATION.

Throws:

MXException - "Attribute {0} does not exist" exception will be thrown if the attribute does not exist in the object. "Field is read only" exception will be thrown if the attribute is READONLY and the accessModifier does not specify NOACCESSCHECK. "Invalid Data Type" exception will be thrown for datatype mismatch. For example, setting a string value of characters to an attribute which has datatype of YORN.

java.rmi.RemoteException

See Also:

Mbo.setValue(String, String, long), HiddenValueSet.setValue(java.lang.String, java.lang.String, long)

authorizeGroups

public void authorizeGroups(MboSetRemote groupSet,
                            java.lang.String relationship)
                     throws MXException,
                            java.rmi.RemoteException

For multiselect of groups for GrpReassignAuth or GroupUser.

Specified by:

authorizeGroups in interface MaxUserRemote

Parameters:

groupSet - Set of MaxGroup

relationship - Relationship name: GRPREASSIGNAUTH or GROUPUSER.

Throws:

MXException

java.rmi.RemoteException

See Also:

SelectGroupsBean

clearGenPswdInfo

public void clearGenPswdInfo()
                      throws MXException,
                             java.rmi.RemoteException

Clear values for passwordinput, passwordcheck, and generatedpswd.

Specified by:

clearGenPswdInfo in interface MaxUserRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

MaxUser.clearGenPswdInfo()

generatePassword

public void generatePassword()
                      throws MXException,
                             java.rmi.RemoteException

Specified by:

generatePassword in interface MaxUserRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

MaxUser.clearGenPswdInfo(), SignatureService.generatePassword(String, UserInfo, MboRemote)

addGrpReassignAuthForUserInsert

public void addGrpReassignAuthForUserInsert()
                                     throws MXException,
                                            java.rmi.RemoteException

When user is added to a group that has USER-INSERT privilege, or that privilege is added to a group, then all users in that group need privilege to add people to the default group and the "everyone" group.

Throws:

MXException

java.rmi.RemoteException

initFieldFlagsOnMbo

public void initFieldFlagsOnMbo(java.lang.String attrName)
                         throws MXException

Description copied from class: Mbo

The logic of setting the readonly and required field flags to the mbo. Any setting of the field flags that require expensive operation, such as database query should be moved from init() to this method. However, those which don't require steps such as fetching Mbos can be left in init(). You can group the logic for a few attributes together if logic of deciding their flag is the same, or in other words, can be handled at once.

Overrides:

initFieldFlagsOnMbo in class Mbo

Throws:

MXException

getOldLoginID

public java.lang.String getOldLoginID()

setOldLoginID

public void setOldLoginID(java.lang.String oldLoginID)