Login (stSoftware API)

java.lang.Object
- com.aspc.DBObj.DBObject
- - com.aspc.DBObj.Contact.Login

All Implemented Interfaces:

ReloadEventListener, Watcher, PasswordRecord, SecondaryCacheGroup
```
public class Login
extends DBObject
implements ReloadEventListener, PasswordRecord
```
Login associates a person with their Access group. The password field has been overloaded to give one way access only. ie. You may test if a password matches but not view the password itself.

data model
THREAD MODE: MIXED, SINGLE-THREADED when called from MutableDataSource else MULTI-THREADED

Since:

October 2, 2000, 4:44 PM

Author:

Nigel Leck

Nested Class Summary
- Nested classes/interfaces inherited from class com.aspc.DBObj.DBObject
  DBObject.DenormalizeAction

Field Summary

Fields
Modifier and Type	Field and Description
`static GlobalId`	`DBCLASS_GID` Login associates a person with their Access group.
`static java.lang.String`	`DBCLASS_NAME` Login associates a person with their Access group.
`static java.lang.String`	`DEVICE_VERIFICATION_UUID`
`static java.lang.String`	`DIGEST_REALM` The digest realm.
`static java.lang.String`	`LOGIN_GUEST` Special login GUEST
`static java.lang.String`	`MODE_HYBRID` Hybrid
`static java.lang.String`	`MODE_TRANSPARENT` TRANSPARENT
`static java.lang.String`	`PASSWORD_HANDLER`
`static java.lang.String`	`PASSWORD_RESTRICTION_BYPASS` accept the password as is
`static java.lang.String`	`REALM` Our realm.

Fields inherited from class com.aspc.DBObj.DBObject
ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors
Constructor and Description

Login(DBClass def, DataSource dataSource)
Std.

Constructors
Constructor and Description
`Login(DBClass def, DataSource dataSource)` Std.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static Session`	`activateWebSession(Session session, boolean makeCurrentSession)`
`boolean`	`canCreateLogins(java.lang.String... args)`
`boolean`	`canCreateRecord(DBClassConcrete dbClass)` Can this login create ANY records of this class ?
`boolean`	`canDeleteRecords(DBClassConcrete dbClass)` Can this login delete ANY records of this class ?
`boolean`	`canModifyRecords(DBClassConcrete dbClass)` Can this login modify ANY records of this class ?
`boolean`	`canReadRecords(DBClassConcrete dbClass)` Can this login read ANY records of this class ?
`protected void`	`checkAtLeastOneOwner()` check that there is one owner.
`static java.lang.String`	`checkPassword(VirtualDB layer, java.lang.String password)` Is this a valid password for this layer ? Is it the right length etc.
`static Login`	`create(MutableDataSource mds)` Make a new instance of this class.
`Session`	`createRemoteSession(java.lang.String password, LoginContext loginContext, java.lang.String remoteHost)` May not login remotely if password has expired We allow multiple remote connections for a user as they maybe using word and Excel.
`Session`	`createWebSession(java.lang.String password, LoginContext loginContext, java.lang.String agent, java.lang.String host, java.lang.String clientURL)` Create a session to be used via the web.
`Session`	`createWebSession(java.lang.String password, LoginContext loginContext, java.lang.String agent, java.lang.String host, java.lang.String clientURL, boolean useMagicNumber)` Create a session to be used via the web.
`java.lang.String`	`displayName()` The display name for this login.
`protected void`	`eventDataLoaded()` Clear out the cache on load.
`protected void`	`eventFieldUpdated(DBField field, java.lang.Object previous, GlobalKey previousKey, FldParams params)` Update force expire and last updated
`void`	`eventReload(DBObject obj)` Called when a watched DBObject is reloaded, internally or externally.
`protected void`	`extCheckDeleteAccess()` Additional access checking for DELETE access for this object.
`protected void`	`extCheckModifyAccess()` Additional access checking for write access of this object.
`protected void`	`extCheckModifyAccess(DBField field)` Check that you are able to modify any login to be able to modify.
`protected void`	`extFixUp()` The extended fix up routine for known problems.
`protected GlobalKey`	`extGetDerivedGlobalKey(DBField field, FldParams params)` OVERRIDE This method to return a derived global key.
`protected java.lang.Object`	`extGetDerivedValue(DBField field, FldParams params)` Calculate the derived value for this field.
`protected java.lang.Object`	`extGetValue(DBField field, FldParams params)` This method will masks the default value returned to the user.
`protected void`	`extPreSaveRecord()` OVERRIDE this method to add functionality to stSoftware BEFORE saving the record to the database.
`protected void`	`extPreValidate()` Update the in-memory universe BEFORE validating
`protected void`	`extSetValue(DBField field, java.lang.Object orgValue, FldParams params)` We prevent some values from being set by a user.
`protected void`	`extValidateDelete(ValidationList list)` Validate a record which is about to be deleted
`protected ValidationError`	`extValidateField(DBField field, ValidationList list)` Validate that the password is OK.
`protected void`	`extValidateRecord(ValidationList list)` Performs additional validations on this record.
`DBMagicNumber`	`findActivationMagicNumber(java.lang.String... args)` The Magic Number code used to activate this login.
`Company`	`findCurrentBusUnit(java.lang.String... args)` Current business unit associated with the current login.
`DBRelease`	`findCurrentRelease(java.lang.String... args)` The current release.
`DBLanguage`	`findDefaultLanguage(java.lang.String... args)` The default language for this login.
`static Login`	`findKey(DataSource ds, java.lang.String key)` Find the target for this class by the primary key
`static Login`	`findLogin(java.lang.String signature, java.lang.String userName)` a short hand method to find the login for a user
`DBTriStateOption`	`findMfaCodeVerification(java.lang.String... args)` Also known as One-Time Password (OTP) via SMS, this method requires users to input a code that is sent to their mobile phone via SMS.
`DBTriStateOption`	`findMfaVerifyNewBrowser(java.lang.String... args)` This process, known as device recognition and email confirmation, verifies a user's identity when they log in from a new browser.
`Person`	`findPerson(java.lang.String... args)` The person
`DBPasswordStorage`	`findRequiredStorageAlgorithm(java.lang.String... args)` The required storage algorithm to use for this login.
`static GlobalKey`	`findSingleKey(VirtualDB layer, java.lang.String usernameOrEmail)`
`DBPasswordStorage`	`findStorageAlgorithm(java.lang.String... args)` The password storage algorithm.
`DBPasswordStorage`	`findStorageAlgorithmCalculated(java.lang.String... args)` The storage algorithm to use.
`DBTimeZone`	`findTimeZone(java.lang.String... args)` The overriding timezone.
`int`	`generateNextBatch()` Get the user batch number
`AccessGroup`	`getAccessGroup()`
`DBMagicNumber`	`getActivationMagicNumber(java.lang.String... args)`
`Login`	`getBaseLogin()`
`int`	`getBatchNumber(java.lang.String... args)`
`DBCriteria`	`getCreateCriteria(DBClassConcrete cls)` The CREATE criteria for the class passed
`Company`	`getCurrentBusUnit(java.lang.String... args)`
`java.lang.String`	`getCurrentReason(java.lang.String... args)`
`DBRelease`	`getCurrentRelease(java.lang.String... args)`
`Session`	`getCurrentSession()` The current session for the login
`java.util.TimeZone`	`getCurrentTimeZone()` The current timezone for this login
`DBLanguage`	`getDefaultLanguage(java.lang.String... args)`
`DBCriteria`	`getDeleteCriteria(DBClassConcrete cls)` The DELETE criteria for the class passed
`static java.lang.String`	`getDigestPart(java.lang.String name, java.lang.String header)` Authorization: Digest username="Mufasa", realm="testrealm@host.com", nonce="dcd98b7102dd2f0e8b11d0f600bfb0c093", uri="/dir/index.html", qop=auth, nc=00000001, cnonce="0a4f113b", response="6629fae49393a05397450978507c4ef1", opaque="5ccc069c403ebaf9f0171e9517f40e41"
`java.util.Date`	`getExpiry(java.lang.String... args)`
`int`	`getFailedAttempts(java.lang.String... args)`
`java.lang.String`	`getIgnoreWordList(java.lang.String... args)`
`java.lang.String`	`getJobProgressRefreshDuration(java.lang.String... args)`
`java.util.Date`	`getLastActive(java.lang.String... args)`
`java.util.Date`	`getLastChanged(java.lang.String... args)`
`java.lang.String`	`getLoginId(java.lang.String... args)`
`DBTriStateOption`	`getMfaCodeVerification(java.lang.String... args)`
`DBTriStateOption`	`getMfaVerifyNewBrowser(java.lang.String... args)`
`DBCriteria`	`getModifyCriteria(DBClassConcrete cls)` The MODIFY criteria for the class passed
`java.lang.String`	`getOutgoingEmailServer()` The email server.
`java.lang.String`	`getOutgoingMailPassword(java.lang.String... args)`
`java.lang.String`	`getOutgoingMailServer(java.lang.String... args)`
`java.lang.String`	`getOutgoingMailUser(java.lang.String... args)`
`java.lang.String`	`getPassword(java.lang.String... args)`
`Person`	`getPerson(java.lang.String... args)`
`java.lang.String`	`getPersonId()` The person id for this login.
`DBCriteria`	`getReadCriteria(DBClassConcrete cls)` The READ criteria for the class passed
`protected java.lang.String`	`getRealPassword()`
`DBPasswordStorage`	`getRequiredStorageAlgorithm(java.lang.String... args)`
`java.lang.String`	`getSalt(java.lang.String... args)`
`java.lang.String`	`getSha1Password(java.lang.String... args)` Deprecated.
`java.lang.String`	`getSsoDomain(java.lang.String... args)`
`java.lang.String`	`getSsoMode(java.lang.String... args)`
`DBPasswordStorage`	`getStorageAlgorithm(java.lang.String... args)`
`DBPasswordStorage`	`getStorageAlgorithmCalculated(java.lang.String... args)`
`DBTimeZone`	`getTimeZone(java.lang.String... args)`
`boolean`	`hasExpired(java.lang.String... args)`
`boolean`	`isDBAdmin()` Does this user have rights to access administration functions on the current layer
`boolean`	`isDisabled(java.lang.String... args)`
`boolean`	`isFinalFg(java.lang.String... args)`
`boolean`	`isForceBrowserCompression(java.lang.String... args)`
`boolean`	`isForceExpire(java.lang.String... args)`
`boolean`	`isFunctional(java.lang.String... args)`
`boolean`	`isGuest()` is a guest ?
`boolean`	`isInactive(java.lang.String... args)`
`boolean`	`isInactivePeriodExpiried(java.lang.String... args)`
`boolean`	`isNeverExpires(java.lang.String... args)`
`boolean`	`isPasswordOk(java.lang.String checkPassword)` is the passed password correct ?
`boolean`	`isShouldShowTabBar(java.lang.String... args)`
`boolean`	`isSysAdmin()` Does this user have rights to access system wide administration functions such as stats
`boolean`	`isSystem()` Is this a "system" login
`boolean`	`isSystemOrGuest()` is this a system or guest login
`boolean`	`isUser()`
`static java.lang.String`	`makeCheckURL(VirtualDB layer, java.lang.String callBack)`
`static java.util.UUID`	`makeDeviceVerification(java.lang.String username, java.lang.String signature)`
`static LoginContext`	`makeLoginContext(VirtualDB layer, java.lang.String login, java.lang.String clientTimeZoneOffset, java.lang.String clientTimeZoneName, java.lang.String javaVersion, java.lang.String language, java.lang.String authorization, java.lang.String requestType, boolean rememberMe, java.lang.String sessionType, java.lang.String authorizationCode, int screenWidth, int screenHeight)` Creates a new instance of LoginContext.
`protected PasswordHandler`	`makePasswordHandler()`
`static java.lang.String`	`makeProtectedURL(VirtualDB layer)` make the protected URL
`static DBQuery<Login>`	`makeQuery(DataSource ds)` Make a new QUERY for this class.
`java.lang.String`	`readPasswordValue()` Read the SALT & SHA512 value for this record.
`java.lang.String`	`readSalt()` Read the SALT for this record.
`static void`	`recordFailedLogin(Login login, DBServer server, java.lang.String category, VirtualDB db)` creates DBFailedLogin.
`Login`	`setAccessGroup(com.aspc.dal.dbobj.acl.AccessGroup value, java.lang.String... args)`
`Login`	`setActivationMagicNumber(com.aspc.dal.magic.DBMagicNumber value, java.lang.String... args)`
`Login`	`setBatchNumber(int value, java.lang.String... args)`
`Login`	`setCurrentBusUnit(com.aspc.dal.dbobj.contact.Business value, java.lang.String... args)`
`Login`	`setCurrentReason(java.lang.String value, java.lang.String... args)`
`Login`	`setCurrentRelease(com.aspc.dal.dbobj.misc.DBRelease value, java.lang.String... args)`
`Login`	`setCurrentSession(com.aspc.dal.dbobj.contact.Session value, java.lang.String... args)`
`Login`	`setDefaultLanguage(com.aspc.dal.dbobj.language.DBLanguage value, java.lang.String... args)`
`Login`	`setDisabled(boolean value, java.lang.String... args)`
`Login`	`setFailedAttempts(int value, java.lang.String... args)`
`Login`	`setFinalFg(boolean value, java.lang.String... args)`
`Login`	`setForceBrowserCompression(boolean value, java.lang.String... args)`
`Login`	`setForceExpire(boolean value, java.lang.String... args)`
`Login`	`setFunctional(boolean value, java.lang.String... args)`
`Login`	`setIgnoreWordList(java.lang.String value, java.lang.String... args)`
`Login`	`setInactive(boolean value, java.lang.String... args)`
`Login`	`setJobProgressRefreshDuration(java.lang.String value, java.lang.String... args)`
`Login`	`setLastActive(java.util.Date value, java.lang.String... args)`
`Login`	`setLastChanged(java.util.Date value, java.lang.String... args)`
`Login`	`setLoginId(java.lang.String value, java.lang.String... args)`
`Login`	`setMfaCodeVerification(com.aspc.dal.dbobj.misc.DBTriStateOption value, java.lang.String... args)`
`Login`	`setMfaVerifyNewBrowser(com.aspc.dal.dbobj.misc.DBTriStateOption value, java.lang.String... args)`
`Login`	`setNeverExpires(boolean value, java.lang.String... args)`
`Login`	`setOutgoingMailPassword(java.lang.String value, java.lang.String... args)`
`Login`	`setOutgoingMailServer(java.lang.String value, java.lang.String... args)`
`Login`	`setOutgoingMailUser(java.lang.String value, java.lang.String... args)`
`Login`	`setPassword(java.lang.String value, java.lang.String... args)`
`Login`	`setPersonId(com.aspc.dal.dbobj.contact.Person value, java.lang.String... args)`
`Login`	`setRequiredStorageAlgorithm(com.aspc.dal.password.DBPasswordStorage value, java.lang.String... args)`
`Login`	`setSalt(java.lang.String value, java.lang.String... args)`
`Login`	`setSha1Password(java.lang.String value, java.lang.String... args)` Deprecated.
`Login`	`setShowWelcomePage(boolean value, java.lang.String... args)`
`Login`	`setSsoDomain(java.lang.String value, java.lang.String... args)`
`Login`	`setSsoMode(java.lang.String value, java.lang.String... args)`
`Login`	`setStorageAlgorithm(com.aspc.dal.password.DBPasswordStorage value, java.lang.String... args)`
`Login`	`setTimeZone(com.aspc.dal.dbobj.misc.TimeZone value, java.lang.String... args)`
`boolean`	`showWelcomePage(java.lang.String... args)`
`static java.lang.String`	`splitURL(java.lang.String URLs)` Split the URLs
`java.lang.String`	`ssoMode()` is SSO enabled for this user
`static java.lang.String`	`ssoMode(VirtualDB layer, java.lang.String userModeSSO)` Is SSO enabled ? If disabled at the Signal Sign On modes 1) TRANSPARENT - only transparent login 2) HYBRID - Transparent or database password.
`boolean`	`validDigest(java.lang.String method, java.lang.String authorization)` http://en.wikipedia.org/wiki/Digest_access_authentication Authorization: Digest username="Mufasa", realm="testrealm@host.com", nonce="dcd98b7102dd2f0e8b11d0f600bfb0c093", uri="/dir/index.html", qop=auth, nc=00000001, cnonce="0a4f113b", response="6629fae49393a05397450978507c4ef1", opaque="5ccc069c403ebaf9f0171e9517f40e41" HA1 = MD5( "Mufasa:testrealm@host.com:Circle Of Life" ) = 939e7578ed9e3c518a452acee763bce9 HA2 = MD5( "GET:/dir/index.html" ) = 39aff3a2bab6126f332b942af96d3366 Response = MD5( "939e7578ed9e3c518a452acee763bce9:\ dcd98b7102dd2f0e8b11d0f600bfb0c093:\ 00000001:0a4f113b:auth:\ 39aff3a2bab6126f332b942af96d3366" ) = 6629fae49393a05397450978507c4ef1
`protected void`	`vetoSession(Session session)` veto a session
`void`	`writePasswordValue(java.lang.String value)` Write the SALT & SHA512 value for this record.
`void`	`writeSalt(java.lang.String salt)` Write the generated SALT

Methods inherited from class com.aspc.DBObj.DBObject
addReloadEventListener, archiveCheck, autoEnterCreate, calculateValue, calculateValue, calculateValue, callingRestoreByJournal, changeThreadMode, checkCreateAccess, checkDelete, checkDeleteAccess, checkModifyAccess, checkModifyAccess, checkReadAccess, clearCache, copy, copyFields, copyIncludeField, copyInwardLinks, delete, denormalizedResult, displayLogName, displayValue, doSearch, dump, equals, extAutoEnterCreate, extCanDeleteDependantObject, extCheckCreateAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extUndelete, fetchLinkHolder, findGlobalKey, findGlobalKey, findGlobalKey, findGlobalKey, findLinkedObject, findLinkedObject, findLinkedObject, findRawData, fireEventDataLoaded, fixUp, forceLockedTransaction, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getChangedFieldInfo, getChangedFields, getDate, getDate, getDate, getDate, getDate, getDefaultValue, getDisableOnChangeEvent, getDouble, getDouble, getDouble, getDouble, getDouble, getFieldDouble, getFieldInt, getFieldLong, getFieldString, getFormattedString, getFormattedString, getGlobalKey, getGlobalKey, getGlobalKey, getGlobalKey, getGlobalKey, getInt, getInt, getInt, getInt, getInt, getInt, getInwardLinkage, getKeyString, getKeyValue, getLinkedObject, getLinkedObject, getLinkedObject, getLinkedObjectByKey, getLinkedRowId, getLinkedRowId, getLinkedRowIdByData, getLinkHolder, getLockedTransaction, getLong, getLong, getLong, getLong, getLong, getLong, getMutableArrayValue, getMutableArrayValue, getOriginalKey, getOriginalValue, getOriginalValue, getProcessedValue, getPureValue, getRawData, getRawValue, getRawValue, getRowId, getRowKey, getSecondaryCacheGroupKey, getSrcLayerID, getString, getString, getString, getString, getString, getString, getValue, getValue, getValue, getValue, hasAutoChanged, hasAutoChanged, hasChanged, hasChangedByUser, hasChangedByUserField, hasChangedByUserField, hasFieldChanged, hasFieldChanged, hashCode, hasStoredResult, iCheckDeleteAccess, iCheckModifyAccess, iCheckReadAccess, iGetDenormalizedMap, iGetRawValue, iPlaceDenormalizedResult, iPostSaveOrDeleteRecord, iPreSaveOrDeleteRecord, iPreValidate, iRaiseEvents, iSaveOrDeleteRecord, isBrokenLink, isBrokenLink, isChanged, isDataCacheKnownToBeDirty, isDeleted, isEmpty, iSetValue, isForceReindex, isKeyWordField, isMandatory, isNew, isNull, isNull, isOnChange, isReindex, iValidateRecord, lastTouched, makeArchiveDataLoader, makeClone, makeDataLoader, makeDenormalizedDoc, makeLinkedArray, makeModifyAccessException, makeSearchPlan, makeWriteProvider, manualDenormalizeOnSave, markSavePoint, optLockedTransaction, registerWatchedObject, reindex, releaseDenormalized, removeReloadEventListener, restoreByJournal, rollbackTo, setBoolean, setBoolean, setBoolean, setBoolean, setDisableOnChangeEvent, setDouble, setDouble, setInt, setInt, setLong, setLong, setRawData, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, toString, touch, undelete, validateField, validateRecord, validateSubType

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.aspc.DBObj.Listeners.Watcher
registerWatchedObject

Field Detail
- DBCLASS_NAME
```
public static final java.lang.String DBCLASS_NAME
```
  Login associates a person with their Access group. The password field has been overloaded to give one way access only. ie. You may test if a password matches but not view the password itself.
  
  See Also:
  
  Constant Field Values
- DBCLASS_GID
```
public static final GlobalId DBCLASS_GID
```
  Login associates a person with their Access group. The password field has been overloaded to give one way access only. ie. You may test if a password matches but not view the password itself.
- PASSWORD_HANDLER
```
public static final java.lang.String PASSWORD_HANDLER
```
  See Also:
  
  Constant Field Values
- DIGEST_REALM
```
public static final java.lang.String DIGEST_REALM
```
  The digest realm.
  
  See Also:
  
  Constant Field Values
- REALM
```
public static final java.lang.String REALM
```
  Our realm.
  
  See Also:
  
  Constant Field Values
- MODE_HYBRID
```
public static final java.lang.String MODE_HYBRID
```
  Hybrid
  
  See Also:
  
  Constant Field Values
- MODE_TRANSPARENT
```
public static final java.lang.String MODE_TRANSPARENT
```
  TRANSPARENT
  
  See Also:
  
  Constant Field Values
- PASSWORD_RESTRICTION_BYPASS
```
public static final java.lang.String PASSWORD_RESTRICTION_BYPASS
```
  accept the password as is
  
  See Also:
  
  Constant Field Values
- LOGIN_GUEST
```
public static final java.lang.String LOGIN_GUEST
```
  Special login GUEST
  
  See Also:
  
  Constant Field Values
- DEVICE_VERIFICATION_UUID
```
public static java.lang.String DEVICE_VERIFICATION_UUID
```

Constructor Detail
- Login
```
public Login(DBClass def,
             DataSource dataSource)
      throws java.lang.Exception
```
  Std. DBObject constructor.
  
  Parameters:
  
  def - The class of this object
  
  dataSource - The datasource for this object
  
  Throws:
  
  java.lang.Exception - A serious problem occurred

Method Detail

getLoginId

@CheckReturnValue
 @Nonnull
public java.lang.String getLoginId(java.lang.String... args)

setLoginId

@Nonnull
public Login setLoginId(java.lang.String value,
                                 java.lang.String... args)
                          throws java.lang.Exception

Throws:: java.lang.Exception

setAccessGroup

@Nonnull
public Login setAccessGroup(com.aspc.dal.dbobj.acl.AccessGroup value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:: java.lang.Exception

getActivationMagicNumber

@CheckReturnValue
 @Nullable
public DBMagicNumber getActivationMagicNumber(java.lang.String... args)

findActivationMagicNumber
```
@CheckReturnValue
 @Nonnull
public final DBMagicNumber findActivationMagicNumber(java.lang.String... args)
                                                                          throws NotFoundException
```
The Magic Number code used to activate this login.

--> DBMagicNumber (String, Unique, Searchable)

Parameters:

args - the optional arguments

Returns:

DBMagicNumber

Throws:

NotFoundException - DBMagicNumber was not found

setActivationMagicNumber

@Nonnull
public Login setActivationMagicNumber(com.aspc.dal.magic.DBMagicNumber value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:: java.lang.Exception

getBatchNumber

@CheckReturnValue
public int getBatchNumber(java.lang.String... args)

setBatchNumber

@Nonnull
public Login setBatchNumber(int value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:: java.lang.Exception

canCreateLogins

@CheckReturnValue
public boolean canCreateLogins(java.lang.String... args)

getCurrentBusUnit

@CheckReturnValue
 @Nullable
public Company getCurrentBusUnit(java.lang.String... args)

findCurrentBusUnit
```
@CheckReturnValue
 @Nonnull
public final Company findCurrentBusUnit(java.lang.String... args)
                                                             throws NotFoundException
```
Current business unit associated with the current login.

--> Business (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Business

Throws:

NotFoundException - Business was not found

setCurrentBusUnit

@Nonnull
public Login setCurrentBusUnit(com.aspc.dal.dbobj.contact.Business value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:: java.lang.Exception

getCurrentReason

@CheckReturnValue
 @Nonnull
public java.lang.String getCurrentReason(java.lang.String... args)

setCurrentReason

@Nonnull
public Login setCurrentReason(java.lang.String value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:: java.lang.Exception

getCurrentRelease

@CheckReturnValue
 @Nullable
public DBRelease getCurrentRelease(java.lang.String... args)

findCurrentRelease

@CheckReturnValue
 @Nonnull
public final DBRelease findCurrentRelease(java.lang.String... args)
                                                               throws NotFoundException

The current release.

--> DBRelease (String, Searchable)

Parameters:: args - the optional arguments
Returns:: DBRelease
Throws:: NotFoundException - DBRelease was not found

setCurrentRelease

@Nonnull
public Login setCurrentRelease(com.aspc.dal.dbobj.misc.DBRelease value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:: java.lang.Exception

setCurrentSession

@Nonnull
public Login setCurrentSession(com.aspc.dal.dbobj.contact.Session value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:: java.lang.Exception

getDefaultLanguage

@CheckReturnValue
 @Nullable
public DBLanguage getDefaultLanguage(java.lang.String... args)

findDefaultLanguage

@CheckReturnValue
 @Nonnull
public final DBLanguage findDefaultLanguage(java.lang.String... args)
                                                                 throws NotFoundException

The default language for this login.

--> DBLanguage (String, Searchable)

Parameters:: args - the optional arguments
Returns:: Language
Throws:: NotFoundException - DBLanguage was not found

setDefaultLanguage

@Nonnull
public Login setDefaultLanguage(com.aspc.dal.dbobj.language.DBLanguage value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:: java.lang.Exception

isDisabled

@CheckReturnValue
public boolean isDisabled(java.lang.String... args)

setDisabled

@Nonnull
public Login setDisabled(boolean value,
                                  java.lang.String... args)
                           throws java.lang.Exception

Throws:: java.lang.Exception

getExpiry

@CheckReturnValue
 @Nullable
public java.util.Date getExpiry(java.lang.String... args)

getFailedAttempts

@CheckReturnValue
public int getFailedAttempts(java.lang.String... args)

setFailedAttempts

@Nonnull
public Login setFailedAttempts(int value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:: java.lang.Exception

isFinalFg

@CheckReturnValue
public boolean isFinalFg(java.lang.String... args)

setFinalFg

@Nonnull
public Login setFinalFg(boolean value,
                                 java.lang.String... args)
                          throws java.lang.Exception

Throws:: java.lang.Exception

isForceBrowserCompression

@CheckReturnValue
public boolean isForceBrowserCompression(java.lang.String... args)

setForceBrowserCompression

@Nonnull
public Login setForceBrowserCompression(boolean value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:: java.lang.Exception

isForceExpire

@CheckReturnValue
public boolean isForceExpire(java.lang.String... args)

setForceExpire

@Nonnull
public Login setForceExpire(boolean value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:: java.lang.Exception

isFunctional

@CheckReturnValue
public boolean isFunctional(java.lang.String... args)

setFunctional

@Nonnull
public Login setFunctional(boolean value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:: java.lang.Exception

hasExpired

@CheckReturnValue
public boolean hasExpired(java.lang.String... args)

getIgnoreWordList

@CheckReturnValue
 @Nonnull
public java.lang.String getIgnoreWordList(java.lang.String... args)

setIgnoreWordList

@Nonnull
public Login setIgnoreWordList(java.lang.String value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:: java.lang.Exception

isInactive

@CheckReturnValue
public boolean isInactive(java.lang.String... args)

setInactive

@Nonnull
public Login setInactive(boolean value,
                                  java.lang.String... args)
                           throws java.lang.Exception

Throws:: java.lang.Exception

isInactivePeriodExpiried

@CheckReturnValue
public boolean isInactivePeriodExpiried(java.lang.String... args)

getJobProgressRefreshDuration

@CheckReturnValue
 @Nonnull
public java.lang.String getJobProgressRefreshDuration(java.lang.String... args)

setJobProgressRefreshDuration

@Nonnull
public Login setJobProgressRefreshDuration(java.lang.String value,
                                                    java.lang.String... args)
                                             throws java.lang.Exception

Throws:: java.lang.Exception

getLastActive

@CheckReturnValue
 @Nullable
public java.util.Date getLastActive(java.lang.String... args)

setLastActive

@Nonnull
public Login setLastActive(java.util.Date value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:: java.lang.Exception

getLastChanged

@CheckReturnValue
 @Nullable
public java.util.Date getLastChanged(java.lang.String... args)

setLastChanged

@Nonnull
public Login setLastChanged(java.util.Date value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:: java.lang.Exception

getMfaCodeVerification

@CheckReturnValue
 @Nullable
public DBTriStateOption getMfaCodeVerification(java.lang.String... args)

findMfaCodeVerification
```
@CheckReturnValue
 @Nonnull
public final DBTriStateOption findMfaCodeVerification(java.lang.String... args)
                                                                           throws NotFoundException
```
Also known as One-Time Password (OTP) via SMS, this method requires users to input a code that is sent to their mobile phone via SMS. Following the initial username/password entry, the system will send a unique, time-sensitive code to the user's mobile phone. The user must input this code to successfully log in.

--> DBTriStateOption (String, Searchable)

Parameters:

args - the optional arguments

Returns:

DBTriStateOption

Throws:

NotFoundException - DBTriStateOption was not found

setMfaCodeVerification

@Nonnull
public Login setMfaCodeVerification(com.aspc.dal.dbobj.misc.DBTriStateOption value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:: java.lang.Exception

getMfaVerifyNewBrowser

@CheckReturnValue
 @Nullable
public DBTriStateOption getMfaVerifyNewBrowser(java.lang.String... args)

findMfaVerifyNewBrowser
```
@CheckReturnValue
 @Nonnull
public final DBTriStateOption findMfaVerifyNewBrowser(java.lang.String... args)
                                                                           throws NotFoundException
```
This process, known as device recognition and email confirmation, verifies a user's identity when they log in from a new browser. The system will detect unfamiliar devices and send a verification link to the registered email address. The user must click this link to verify the new browser before they can proceed with their login.

--> DBTriStateOption (String, Searchable)

Parameters:

args - the optional arguments

Returns:

DBTriStateOption

Throws:

NotFoundException - DBTriStateOption was not found

setMfaVerifyNewBrowser

@Nonnull
public Login setMfaVerifyNewBrowser(com.aspc.dal.dbobj.misc.DBTriStateOption value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:: java.lang.Exception

isNeverExpires

@CheckReturnValue
public boolean isNeverExpires(java.lang.String... args)

setNeverExpires

@Nonnull
public Login setNeverExpires(boolean value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:: java.lang.Exception

getOutgoingMailPassword

@CheckReturnValue
 @Nonnull
public java.lang.String getOutgoingMailPassword(java.lang.String... args)

setOutgoingMailPassword

@Nonnull
public Login setOutgoingMailPassword(java.lang.String value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:: java.lang.Exception

getOutgoingMailServer

@CheckReturnValue
 @Nonnull
public java.lang.String getOutgoingMailServer(java.lang.String... args)

setOutgoingMailServer

@Nonnull
public Login setOutgoingMailServer(java.lang.String value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:: java.lang.Exception

getOutgoingMailUser

@CheckReturnValue
 @Nonnull
public java.lang.String getOutgoingMailUser(java.lang.String... args)

setOutgoingMailUser

@Nonnull
public Login setOutgoingMailUser(java.lang.String value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:: java.lang.Exception

getPassword

@CheckReturnValue
 @Nonnull
public java.lang.String getPassword(java.lang.String... args)

setPassword

@Nonnull
public Login setPassword(@MatchesPattern(value="([a-zA-Z0-9#$!%\\(\\)\\+,\\./<=>@\\[\\]\\^_\\{\\|\\}~]+|.{8,})")
                                  java.lang.String value,
                                  java.lang.String... args)
                           throws java.lang.Exception

Throws:: java.lang.Exception

setPersonId

@Nonnull
public Login setPersonId(com.aspc.dal.dbobj.contact.Person value,
                                  java.lang.String... args)
                           throws java.lang.Exception

Throws:: java.lang.Exception

getRequiredStorageAlgorithm

@CheckReturnValue
 @Nullable
public DBPasswordStorage getRequiredStorageAlgorithm(java.lang.String... args)

findRequiredStorageAlgorithm
```
@CheckReturnValue
 @Nonnull
public final DBPasswordStorage findRequiredStorageAlgorithm(java.lang.String... args)
                                                                                 throws NotFoundException
```
The required storage algorithm to use for this login.

--> DBPasswordStorage (String, Searchable)

Parameters:

args - the optional arguments

Returns:

Password Storage

Throws:

NotFoundException - DBPasswordStorage was not found

setRequiredStorageAlgorithm

@Nonnull
public Login setRequiredStorageAlgorithm(com.aspc.dal.password.DBPasswordStorage value,
                                                  java.lang.String... args)
                                           throws java.lang.Exception

Throws:: java.lang.Exception

getSalt

@CheckReturnValue
 @Nonnull
public java.lang.String getSalt(java.lang.String... args)

setSalt

@Nonnull
public Login setSalt(java.lang.String value,
                              java.lang.String... args)
                       throws java.lang.Exception

Throws:: java.lang.Exception

getSha1Password

@Deprecated
 @CheckReturnValue
 @Nonnull
public java.lang.String getSha1Password(java.lang.String... args)

Deprecated.

setSha1Password

@Deprecated
 @Nonnull
public Login setSha1Password(java.lang.String value,
                                                   java.lang.String... args)
                                            throws java.lang.Exception

Deprecated.

Throws:: java.lang.Exception

isShouldShowTabBar

@CheckReturnValue
public boolean isShouldShowTabBar(java.lang.String... args)

showWelcomePage

@CheckReturnValue
public boolean showWelcomePage(java.lang.String... args)

setShowWelcomePage

@Nonnull
public Login setShowWelcomePage(boolean value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:: java.lang.Exception

getSsoDomain

@CheckReturnValue
 @Nonnull
public java.lang.String getSsoDomain(java.lang.String... args)

setSsoDomain

@Nonnull
public Login setSsoDomain(java.lang.String value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:: java.lang.Exception

getSsoMode

@CheckReturnValue
 @Nonnull
public java.lang.String getSsoMode(java.lang.String... args)

setSsoMode

@Nonnull
public Login setSsoMode(java.lang.String value,
                                 java.lang.String... args)
                          throws java.lang.Exception

Throws:: java.lang.Exception

getStorageAlgorithm

@CheckReturnValue
 @Nullable
public DBPasswordStorage getStorageAlgorithm(java.lang.String... args)

findStorageAlgorithm

@CheckReturnValue
 @Nonnull
public final DBPasswordStorage findStorageAlgorithm(java.lang.String... args)
                                                                         throws NotFoundException

The password storage algorithm.

--> DBPasswordStorage (String, Searchable)

Parameters:: args - the optional arguments
Returns:: Password Storage
Throws:: NotFoundException - DBPasswordStorage was not found

setStorageAlgorithm

@Nonnull
public Login setStorageAlgorithm(com.aspc.dal.password.DBPasswordStorage value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:: java.lang.Exception

getStorageAlgorithmCalculated

@CheckReturnValue
 @Nullable
public DBPasswordStorage getStorageAlgorithmCalculated(java.lang.String... args)

findStorageAlgorithmCalculated

@CheckReturnValue
 @Nonnull
public final DBPasswordStorage findStorageAlgorithmCalculated(java.lang.String... args)
                                                                                   throws NotFoundException

The storage algorithm to use.

--> DBPasswordStorage (String, Derived, Searchable)

Parameters:: args - the optional arguments
Returns:: Password Storage
Throws:: NotFoundException - DBPasswordStorage was not found

getTimeZone

@CheckReturnValue
 @Nullable
public DBTimeZone getTimeZone(java.lang.String... args)

findTimeZone

@CheckReturnValue
 @Nonnull
public final DBTimeZone findTimeZone(java.lang.String... args)
                                                          throws NotFoundException

The overriding timezone.

--> TimeZone (String, Searchable)

Parameters:: args - the optional arguments
Returns:: TimeZone
Throws:: NotFoundException - TimeZone was not found

setTimeZone

@Nonnull
public Login setTimeZone(com.aspc.dal.dbobj.misc.TimeZone value,
                                  java.lang.String... args)
                           throws java.lang.Exception

Throws:: java.lang.Exception

create

@Nonnull
 @CheckReturnValue
public static Login create(@Nonnull
                                                       MutableDataSource mds)
                                                throws java.lang.Exception

Make a new instance of this class.

Parameters:: mds - the datasource
Returns:: the new record
Throws:: java.lang.Exception - an object of this class could not be created

makeQuery

@Nonnull
 @CheckReturnValue
public static DBQuery<Login> makeQuery(@Nonnull
                                                                   DataSource ds)
                                                            throws NotFoundException

Make a new QUERY for this class.

Parameters:: ds - the datasource
Returns:: the new QUERY
Throws:: NotFoundException - if class could not be found

findKey

@Nonnull
 @CheckReturnValue
public static Login findKey(@Nonnull
                                                        DataSource ds,
                                                        @Nonnull
                                                        java.lang.String key)
                                                 throws NotFoundException,
                                                        java.lang.Exception

Find the target for this class by the primary key

Parameters:: ds - the datasource; key - the value
Returns:: the target
Throws:: NotFoundException - if target could not be found; java.lang.Exception - a serious problem

displayName
```
@CheckReturnValue
 @Nonnull
public java.lang.String displayName()
```
The display name for this login. If one of the "special" users system or guest just return the login otherwise the login and user's name.

Overrides:

displayName in class DBObject

Returns:

The display name

makeDeviceVerification

@CheckReturnValue
 @Nonnull
public static java.util.UUID makeDeviceVerification(@Nonnull
                                                                                java.lang.String username,
                                                                                @Nonnull
                                                                                java.lang.String signature)

getPersonId

@Nonnull
 @CheckReturnValue
public java.lang.String getPersonId()

The person id for this login.

Returns:: The person id

eventReload
```
public void eventReload(@Nonnull
                        DBObject obj)
```
Called when a watched DBObject is reloaded, internally or externally. Use to clear secondary caches

Specified by:

eventReload in interface ReloadEventListener

Parameters:

obj - The object that was reloaded.

isSystem
```
@CheckReturnValue
public final boolean isSystem()
```
Is this a "system" login

Returns:

true if system

isSystemOrGuest
```
@CheckReturnValue
public final boolean isSystemOrGuest()
```
is this a system or guest login

Returns:

true if either

isGuest

@CheckReturnValue
public final boolean isGuest()

is a guest ?

Returns:: true if is a guest

isUser

@CheckReturnValue
public boolean isUser()

Returns:: true if a user

isPasswordOk

@CheckReturnValue
public boolean isPasswordOk(@Nonnull
                                              java.lang.String checkPassword)
                                       throws java.lang.Exception

is the passed password correct ?

Parameters:: checkPassword - The password to check
Returns:: true if correct.
Throws:: java.lang.Exception - a serious problem

makePasswordHandler

protected PasswordHandler makePasswordHandler()
                                       throws java.lang.Exception

Throws:: java.lang.Exception

ssoMode

@Nonnull
 @CheckReturnValue
public java.lang.String ssoMode()
                                                     throws java.lang.Exception

is SSO enabled for this user

Returns:: true if enabled.
Throws:: java.lang.Exception - a serious problem.

ssoMode

@Nonnull
 @CheckReturnValue
public static java.lang.String ssoMode(@Nonnull
                                                                   VirtualDB layer,
                                                                   @Nullable
                                                                   java.lang.String userModeSSO)
                                                            throws java.lang.Exception

Is SSO enabled ? If disabled at the Signal Sign On modes 1) TRANSPARENT - only transparent login 2) HYBRID - Transparent or database password.

Parameters:: layer - the layer; userModeSSO - user wants to enable SSO
Returns:: true if enabled.
Throws:: java.lang.Exception - a serious problem.

makeProtectedURL

@Nonnull
 @CheckReturnValue
public static java.lang.String makeProtectedURL(@Nonnull
                                                                            VirtualDB layer)
                                                                     throws java.lang.Exception

make the protected URL

Parameters:: layer - the layer
Returns:: the URL
Throws:: java.lang.Exception - a serious problem

splitURL

@Nullable
 @CheckReturnValue
public static java.lang.String splitURL(java.lang.String URLs)

Split the URLs

Parameters:: URLs - the URLs
Returns:: the single URL

makeCheckURL

@Nonnull
 @CheckReturnValue
public static java.lang.String makeCheckURL(@Nonnull
                                                                        VirtualDB layer,
                                                                        @Nonnull
                                                                        java.lang.String callBack)
                                                                 throws java.lang.Exception

Parameters:: layer - the layer; callBack - the call back
Returns:: the check URL
Throws:: java.lang.Exception - a serious problem

getRealPassword

@Nonnull
 @CheckReturnValue
protected final java.lang.String getRealPassword()

canCreateRecord

@CheckReturnValue
public boolean canCreateRecord(@Nonnull
                                                 DBClassConcrete dbClass)
                                          throws java.lang.Exception

Can this login create ANY records of this class ?

Parameters:: dbClass - The class to check
Returns:: true if you may create record of this type.
Throws:: java.lang.Exception - a serious problem

canModifyRecords

@CheckReturnValue
public boolean canModifyRecords(@Nonnull
                                                  DBClassConcrete dbClass)
                                           throws java.lang.Exception

Can this login modify ANY records of this class ?

Parameters:: dbClass - the class to check
Returns:: true if you can modify records of this type.
Throws:: java.lang.Exception - a serious problem

canDeleteRecords

@CheckReturnValue
public boolean canDeleteRecords(@Nonnull
                                                  DBClassConcrete dbClass)
                                           throws java.lang.Exception

Can this login delete ANY records of this class ?

Parameters:: dbClass - the class to check
Returns:: true if you can modify records of this type.
Throws:: java.lang.Exception - a serious problem

canReadRecords

@CheckReturnValue
public boolean canReadRecords(@Nonnull
                                                DBClassConcrete dbClass)
                                         throws java.lang.Exception

Can this login read ANY records of this class ?

Parameters:: dbClass - the class to check
Returns:: true if you can read records of this type.
Throws:: java.lang.Exception - a serious problem

makeLoginContext

@Nonnull
 @CheckReturnValue
public static LoginContext makeLoginContext(VirtualDB layer,
                                                                        java.lang.String login,
                                                                        java.lang.String clientTimeZoneOffset,
                                                                        java.lang.String clientTimeZoneName,
                                                                        java.lang.String javaVersion,
                                                                        java.lang.String language,
                                                                        java.lang.String authorization,
                                                                        java.lang.String requestType,
                                                                        boolean rememberMe,
                                                                        java.lang.String sessionType,
                                                                        java.lang.String authorizationCode,
                                                                        int screenWidth,
                                                                        int screenHeight)
                                                                 throws java.lang.Exception

Creates a new instance of LoginContext.

Parameters:: layer - the layer; login - the login; clientTimeZoneOffset - time zone offset; clientTimeZoneName - time zone name; javaVersion - JDK version; language - user language; authorization - the authorization; requestType - the request type; rememberMe - remember me; sessionType - the type; authorizationCode - the code; screenWidth - the screen width; screenHeight - the screen height
Returns:: the value
Throws:: java.lang.Exception - a serious problem.

getAccessGroup

@Nonnull
 @CheckReturnValue
public AccessGroup getAccessGroup()

Returns:: the access group

getOutgoingEmailServer
```
@CheckReturnValue
 @Nonnull
public java.lang.String getOutgoingEmailServer()
```
The email server. TODO: Should this be on login ?

Returns:

The email server

getCurrentSession

@Nullable
 @CheckReturnValue
public Session getCurrentSession()

The current session for the login

Returns:: The session

getCurrentTimeZone

@Nonnull
 @CheckReturnValue
public java.util.TimeZone getCurrentTimeZone()

The current timezone for this login

Returns:: The timezone

createRemoteSession

@Nonnull
 @CheckReturnValue
public Session createRemoteSession(java.lang.String password,
                                                               LoginContext loginContext,
                                                               java.lang.String remoteHost)
                                                        throws java.lang.Exception

May not login remotely if password has expired We allow multiple remote connections for a user as they maybe using word and Excel.

Parameters:: loginContext - The login context; remoteHost - The remote host; password - The password to check
Returns:: The login.
Throws:: java.lang.Exception - The login details are not valid.

createWebSession

@Nonnull
 @CheckReturnValue
public Session createWebSession(java.lang.String password,
                                                            LoginContext loginContext,
                                                            java.lang.String agent,
                                                            java.lang.String host,
                                                            java.lang.String clientURL)
                                                     throws java.lang.Exception

Create a session to be used via the web. Unless this is a functional ID we do not allow multiple connection.

Parameters:: loginContext - the login context; password - The password to check; agent - The web agent used; host - The host that is being used; clientURL - The location of the user.
Returns:: The login
Throws:: java.lang.Exception - The login details are not valid

createWebSession

@Nonnull
 @CheckReturnValue
public Session createWebSession(java.lang.String password,
                                                            LoginContext loginContext,
                                                            java.lang.String agent,
                                                            java.lang.String host,
                                                            java.lang.String clientURL,
                                                            boolean useMagicNumber)
                                                     throws java.lang.Exception

Create a session to be used via the web. Unless this is a functional ID we do not allow multiple connection.

Parameters:: loginContext - the login context; password - The password to check; agent - The web agent used; host - The host that is being used; clientURL - The location of the user.; useMagicNumber - using magic number
Returns:: The session
Throws:: java.lang.Exception - The login details are not valid

vetoSession

protected void vetoSession(@Nonnull
                           Session session)
                    throws InvalidPasswordException

veto a session

Parameters:: session - the session to check
Throws:: InvalidPasswordException - no allowed to login

activateWebSession

@Nullable
public static Session activateWebSession(@Nullable
                                                   Session session,
                                                   boolean makeCurrentSession)
                                            throws java.lang.Exception

Parameters:: session - the session; makeCurrentSession - make this session the current session
Returns:: the active session
Throws:: java.lang.Exception - a serious problem

validDigest
```
@CheckReturnValue
public boolean validDigest(java.lang.String method,
                                             @Nullable
                                             java.lang.String authorization)
```
http://en.wikipedia.org/wiki/Digest_access_authentication Authorization: Digest username="Mufasa", realm="testrealm@host.com", nonce="dcd98b7102dd2f0e8b11d0f600bfb0c093", uri="/dir/index.html", qop=auth, nc=00000001, cnonce="0a4f113b", response="6629fae49393a05397450978507c4ef1", opaque="5ccc069c403ebaf9f0171e9517f40e41" HA1 = MD5( "Mufasa:testrealm@host.com:Circle Of Life" ) = 939e7578ed9e3c518a452acee763bce9 HA2 = MD5( "GET:/dir/index.html" ) = 39aff3a2bab6126f332b942af96d3366 Response = MD5( "939e7578ed9e3c518a452acee763bce9:\ dcd98b7102dd2f0e8b11d0f600bfb0c093:\ 00000001:0a4f113b:auth:\ 39aff3a2bab6126f332b942af96d3366" ) = 6629fae49393a05397450978507c4ef1

Parameters:

method - the method

authorization - the authorization to check.

Returns:

true if valid

getDigestPart
```
@Nonnull
 @CheckReturnValue
public static java.lang.String getDigestPart(@Nonnull
                                                                         java.lang.String name,
                                                                         @Nullable
                                                                         java.lang.String header)
```
Authorization: Digest username="Mufasa", realm="testrealm@host.com", nonce="dcd98b7102dd2f0e8b11d0f600bfb0c093", uri="/dir/index.html", qop=auth, nc=00000001, cnonce="0a4f113b", response="6629fae49393a05397450978507c4ef1", opaque="5ccc069c403ebaf9f0171e9517f40e41"

Parameters:

name - the component name

header - the header

Returns:

the value

recordFailedLogin

public static void recordFailedLogin(@Nonnull
                                     Login login,
                                     DBServer server,
                                     java.lang.String category,
                                     VirtualDB db)
                              throws java.lang.Exception

creates DBFailedLogin.

Parameters:: login - the login; server - The DBServer; category - the reason; db - the layer
Throws:: java.lang.Exception - a serious problem

checkPassword

@Nullable
 @CheckReturnValue
public static java.lang.String checkPassword(@Nonnull
                                                                          VirtualDB layer,
                                                                          @Nullable
                                                                          java.lang.String password)
                                                                   throws java.lang.Exception

Is this a valid password for this layer ? Is it the right length etc.

Parameters:: layer - The layer; password - The password to check
Returns:: null if OK, otherwise the error message
Throws:: java.lang.Exception - a serious problem

getReadCriteria

@Nonnull
 @CheckReturnValue
public DBCriteria getReadCriteria(@Nonnull
                                                              DBClassConcrete cls)
                                                       throws java.lang.Exception

The READ criteria for the class passed

Parameters:: cls - The class to check
Returns:: The criteria
Throws:: java.lang.Exception - A serious problem

getModifyCriteria

@Nonnull
 @CheckReturnValue
public DBCriteria getModifyCriteria(@Nonnull
                                                                DBClassConcrete cls)
                                                         throws java.lang.Exception

The MODIFY criteria for the class passed

Parameters:: cls - The class to check
Returns:: The criteria
Throws:: java.lang.Exception - A serious problem

getCreateCriteria

@Nonnull
 @CheckReturnValue
public DBCriteria getCreateCriteria(@Nonnull
                                                                DBClassConcrete cls)
                                                         throws java.lang.Exception

The CREATE criteria for the class passed

Parameters:: cls - The class to check
Returns:: The criteria
Throws:: java.lang.Exception - A serious problem

getDeleteCriteria

@Nonnull
 @CheckReturnValue
public DBCriteria getDeleteCriteria(@Nonnull
                                                                DBClassConcrete cls)
                                                         throws java.lang.Exception

The DELETE criteria for the class passed

Parameters:: cls - The class to check
Returns:: The criteria
Throws:: java.lang.Exception - A serious problem

isSysAdmin
```
@CheckReturnValue
public boolean isSysAdmin()
```
Does this user have rights to access system wide administration functions such as stats

Returns:

true if a system admin user

isDBAdmin
```
@CheckReturnValue
public boolean isDBAdmin()
```
Does this user have rights to access administration functions on the current layer

Returns:

true if a DBA

findLogin

@Nonnull
 @CheckReturnValue
public static Login findLogin(@Nullable
                                                          java.lang.String signature,
                                                          @Nullable
                                                          java.lang.String userName)
                                                   throws java.lang.Exception

a short hand method to find the login for a user

Parameters:: signature - The layer signature; userName - The user name to find
Returns:: The login
Throws:: java.lang.Exception - A serious problem

getBaseLogin

@Nonnull
 @CheckReturnValue
public Login getBaseLogin()

findSingleKey

@Nullable
 @CheckReturnValue
public static GlobalKey findSingleKey(VirtualDB layer,
                                                                   java.lang.String usernameOrEmail)
                                                            throws java.lang.Exception

Throws:: java.lang.Exception

extSetValue
```
protected void extSetValue(DBField field,
                           java.lang.Object orgValue,
                           FldParams params)
                    throws java.lang.Exception
```
We prevent some values from being set by a user.

Overrides:

extSetValue in class DBObject

Parameters:

orgValue - The value being set.

field - The field that is being changed

params - The extra parameters

Throws:

java.lang.Exception - A serious problem

extGetDerivedValue

@CheckReturnValue
protected java.lang.Object extGetDerivedValue(@Nonnull
                                                                DBField field,
                                                                @Nullable
                                                                FldParams params)
                                                         throws java.lang.Exception

Calculate the derived value for this field.

Overrides:: extGetDerivedValue in class DBObject
Parameters:: field - The field to get; params - The parameters for this field eg. language= or default=
Returns:: The calculated value.
Throws:: java.lang.Exception - A serious problem

extGetDerivedGlobalKey

@Nullable
 @CheckReturnValue
protected GlobalKey extGetDerivedGlobalKey(@Nonnull
                                                                        DBField field,
                                                                        @Nullable
                                                                        FldParams params)
                                                                 throws java.lang.Exception

Description copied from class: DBObject

OVERRIDE This method to return a derived global key. This method is only checked if the field is marked as being linked.

Overrides:: extGetDerivedGlobalKey in class DBObject
Parameters:: field - The field that is being changed; params - The extra parameters
Returns:: The Global key
Throws:: java.lang.Exception - A serious problem. In general validation is done later.

extFixUp
```
@OverridingMethodsMustInvokeSuper
protected void extFixUp()
                                                   throws java.lang.Exception
```
The extended fix up routine for known problems. This routine will be called by the method fixUp() in DBObject.

Overrides:

extFixUp in class DBObject

Throws:

java.lang.Exception - a serious problem

extCheckModifyAccess
```
@OverridingMethodsMustInvokeSuper
protected void extCheckModifyAccess()
                                                               throws DBAccessException
```
Additional access checking for write access of this object.

Overrides:

extCheckModifyAccess in class DBObject

Throws:

DBAccessException - No access to modify

extCheckModifyAccess

@OverridingMethodsMustInvokeSuper
protected void extCheckModifyAccess(@Nonnull
                                                                      DBField field)
                                                               throws DBAccessException

Check that you are able to modify any login to be able to modify. 1) inactive 2) never expires

Overrides:: extCheckModifyAccess in class DBObject
Parameters:: field - Can we change this field ?
Throws:: DBAccessException - No access to change

extCheckDeleteAccess
```
@OverridingMethodsMustInvokeSuper
protected void extCheckDeleteAccess()
                                                               throws DBAccessException
```
Additional access checking for DELETE access for this object.

Overrides:

extCheckDeleteAccess in class DBObject

Throws:

DBAccessException - No access to delete this object

extPreValidate

@OverridingMethodsMustInvokeSuper
protected void extPreValidate()
                                                         throws java.lang.Exception

Update the in-memory universe BEFORE validating

Overrides:: extPreValidate in class DBObject
Throws:: java.lang.Exception - A serious problem

eventDataLoaded
```
@OverridingMethodsMustInvokeSuper
protected void eventDataLoaded()
```
Clear out the cache on load.

Overrides:

eventDataLoaded in class DBObject

eventFieldUpdated

protected void eventFieldUpdated(DBField field,
                                 java.lang.Object previous,
                                 GlobalKey previousKey,
                                 FldParams params)
                          throws java.lang.Exception

Update force expire and last updated

Overrides:: eventFieldUpdated in class DBObject
Parameters:: field - The field changed; previous - The previous value; previousKey - the previous key; params - the field parameters used
Throws:: java.lang.Exception - a serious problem

extGetValue

@CheckReturnValue
 @Nullable
protected java.lang.Object extGetValue(@Nullable
                                                                    DBField field,
                                                                    @Nullable
                                                                    FldParams params)

This method will masks the default value returned to the user. The "real" value will still be used in searches etc

Overrides:: extGetValue in class DBObject
Parameters:: field - The field to get; params - The parameters for this field eg. language= or default=
Returns:: The value of the field.

extValidateRecord

@OverridingMethodsMustInvokeSuper
protected void extValidateRecord(@Nonnull
                                                                   ValidationList list)
                                                            throws java.lang.Exception

Performs additional validations on this record. Only ever called from MutableDataSource.

Overrides:: extValidateRecord in class DBObject
Parameters:: list - The validation list.
Throws:: java.lang.Exception - A serious problem

extValidateDelete

@OverridingMethodsMustInvokeSuper
protected void extValidateDelete(@Nonnull
                                                                   ValidationList list)
                                                            throws java.lang.Exception

Validate a record which is about to be deleted

Overrides:: extValidateDelete in class DBObject
Parameters:: list - The validation list
Throws:: java.lang.Exception - A serious problem
See Also:: DBObject.extValidateDelete( ValidationList)

checkAtLeastOneOwner

protected void checkAtLeastOneOwner()
                             throws java.lang.Exception

check that there is one owner.

Throws:: java.lang.Exception - no owner.

extValidateField

@CheckReturnValue
 @OverridingMethodsMustInvokeSuper
 @Nullable
protected ValidationError extValidateField(@Nonnull
                                                                                                           DBField field,
                                                                                                           @Nonnull
                                                                                                           ValidationList list)
                                                                                                    throws java.lang.Exception

Validate that the password is OK.

Overrides:: extValidateField in class DBObject
Parameters:: field - The field to validate; list - The validation list
Returns:: A validation error.
Throws:: java.lang.Exception - A serious problem

extPreSaveRecord
```
@OverridingMethodsMustInvokeSuper
protected void extPreSaveRecord()
                                                           throws java.lang.Exception
```
Description copied from class: DBObject

OVERRIDE this method to add functionality to stSoftware BEFORE saving the record to the database. At this stage the final validation ( internally called by save) has NOT been performed. This is your chance to create other associated records etc. This method is called for all created and modified records NOT deleted. The database transaction has not been started yet. Your changes will NOT be rollback in case of failure.

Overrides:

extPreSaveRecord in class DBObject

Throws:

java.lang.Exception - a serious problem

generateNextBatch

@CheckReturnValue
public int generateNextBatch()
                                        throws java.lang.Exception

Get the user batch number

Returns:: batch number
Throws:: java.lang.Exception - a serious problem

getPerson

@CheckReturnValue
 @Nullable
public Person getPerson(java.lang.String... args)

findPerson

@CheckReturnValue
 @Nonnull
public final Person findPerson(java.lang.String... args)
                                                    throws NotFoundException

The person

Parameters:: args - the optional arguments
Returns:: the person
Throws:: NotFoundException - DBLanguage was not found

readSalt
```
@Nonnull
 @CheckReturnValue
public java.lang.String readSalt()
```
Description copied from interface: PasswordRecord

Read the SALT for this record.

Specified by:

readSalt in interface PasswordRecord

Returns:

the SALT

writeSalt
```
public void writeSalt(java.lang.String salt)
               throws java.lang.Exception
```
Description copied from interface: PasswordRecord

Write the generated SALT

Specified by:

writeSalt in interface PasswordRecord

Parameters:

salt - the SALT.

Throws:

java.lang.Exception - a serious problem.

readPasswordValue
```
public java.lang.String readPasswordValue()
```
Description copied from interface: PasswordRecord

Read the SALT & SHA512 value for this record.

Specified by:

readPasswordValue in interface PasswordRecord

Returns:

the SALT

writePasswordValue
```
public void writePasswordValue(java.lang.String value)
                        throws java.lang.Exception
```
Description copied from interface: PasswordRecord

Write the SALT & SHA512 value for this record.

Specified by:

writePasswordValue in interface PasswordRecord

Parameters:

value - the value to store.

Throws:

java.lang.Exception - a serious problem

Class Login

Nested Class Summary

Nested classes/interfaces inherited from class com.aspc.DBObj.DBObject