com.aspc.password

Class DBPasswordStorage

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.password.DBPasswordStorage

All Implemented Interfaces:

SecondaryCacheGroup

public class DBPasswordStorage
extends DBObject

The algorithm to use to store/resolve the passwords in the database.

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

Since:

13 September 2015

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 The algorithm to use to store/resolve the passwords in the database.
static java.lang.String	DBCLASS_NAME The algorithm to use to store/resolve the passwords in the database.
static java.lang.String	LIST_BEST_PRACTICE_2017 Best Practice 2017
static java.lang.String	LIST_ENCRYPTED Encrypted Only
static java.lang.String	LIST_ENCRYPTED_SALTED_PBKDF2 Encrypted Salted PBKDF2 and SHA-512 Hashed 1234 times.
static java.lang.String	LIST_ENCRYPTED_SALTED_SHA512 Encrypted Salted SHA-512 Hash
static java.lang.String	LIST_HASHED_SHA1 Hashed SHA-1
static java.lang.String	LIST_LEGACY_ENCRYPTED Legacy encrypted handler
static java.lang.String	LIST_LEGACY_SHA1 Legacy SHA1 handler
static java.lang.String	LIST_SALTED_ENCRIPTED Salted Encrypted

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

Constructor and Description
DBPasswordStorage(DBClass def, DataSource dataSource) Std.

Method Summary

Modifier and Type	Method and Description
static DBPasswordStorage	create(MutableDataSource mds) Make a new instance of this class.
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) OVERRIDE This method for all objects with derived fields that are NOT linked.
protected ValidationError	extValidateField(DBField field, ValidationList list) Additional validation for particular field OVERRIDE THIS METHOD TO ADD VALIDATIONS FOR A FIELD.
static DBPasswordStorage	findKey(DataSource ds, java.lang.String key) Find the target for this class by the primary key
java.lang.String	getCode(java.lang.String... args)
java.util.Date	getDeprecatedNoLongerAvailable(java.lang.String... args)
java.lang.String	getDeprecatedReason(java.lang.String... args)
java.lang.String	getDescription(java.lang.String... args)
java.lang.String	getJavaClassName(java.lang.String... args)
java.lang.String	getLabel(java.lang.String... args)
boolean	isActive(java.lang.String... args)
boolean	isDeprecated(java.lang.String... args)
PasswordHandler	makePlugin()
static DBQuery<DBPasswordStorage>	makeQuery(DataSource ds) Make a new QUERY for this class.
DBPasswordStorage	setCode(java.lang.String value, java.lang.String... args)
DBPasswordStorage	setDeprecated(boolean value, java.lang.String... args)
DBPasswordStorage	setDeprecatedNoLongerAvailable(java.util.Date value, java.lang.String... args)
DBPasswordStorage	setDeprecatedReason(java.lang.String value, java.lang.String... args)
DBPasswordStorage	setDescription(java.lang.String value, java.lang.String... args)
DBPasswordStorage	setJavaClassName(java.lang.String value, java.lang.String... args)
DBPasswordStorage	setLabel(java.lang.String value, java.lang.String... args)

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, displayName, displayValue, doSearch, dump, equals, eventDataLoaded, eventFieldUpdated, extAutoEnterCreate, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extFixUp, extGetDerivedGlobalKey, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreSaveRecord, extPreValidate, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extSetValue, extUndelete, extValidateDelete, extValidateRecord, 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

Field Detail

DBCLASS_NAME

public static final java.lang.String DBCLASS_NAME

The algorithm to use to store/resolve the passwords in the database.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

The algorithm to use to store/resolve the passwords in the database.

LIST_BEST_PRACTICE_2017

public static final java.lang.String LIST_BEST_PRACTICE_2017

Best Practice 2017

See Also:

Constant Field Values

LIST_ENCRYPTED

public static final java.lang.String LIST_ENCRYPTED

Encrypted Only

See Also:

Constant Field Values

LIST_ENCRYPTED_SALTED_PBKDF2

public static final java.lang.String LIST_ENCRYPTED_SALTED_PBKDF2

Encrypted Salted PBKDF2 and SHA-512 Hashed 1234 times.

See Also:

Constant Field Values

LIST_ENCRYPTED_SALTED_SHA512

public static final java.lang.String LIST_ENCRYPTED_SALTED_SHA512

Encrypted Salted SHA-512 Hash

See Also:

Constant Field Values

LIST_HASHED_SHA1

public static final java.lang.String LIST_HASHED_SHA1

Hashed SHA-1

See Also:

Constant Field Values

LIST_LEGACY_ENCRYPTED

public static final java.lang.String LIST_LEGACY_ENCRYPTED

Legacy encrypted handler

See Also:

Constant Field Values

LIST_LEGACY_SHA1

public static final java.lang.String LIST_LEGACY_SHA1

Legacy SHA1 handler

See Also:

Constant Field Values

LIST_SALTED_ENCRIPTED

public static final java.lang.String LIST_SALTED_ENCRIPTED

Salted Encrypted

See Also:

Constant Field Values

Constructor Detail

DBPasswordStorage

public DBPasswordStorage(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

getCode

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

setCode

@Nonnull
public DBPasswordStorage setCode(java.lang.String value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

isActive

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

isDeprecated

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

setDeprecated

@Nonnull
public DBPasswordStorage setDeprecated(boolean value,
                                                java.lang.String... args)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

getDeprecatedNoLongerAvailable

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

setDeprecatedNoLongerAvailable

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

Throws:

java.lang.Exception

getDeprecatedReason

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

setDeprecatedReason

@Nonnull
public DBPasswordStorage setDeprecatedReason(java.lang.String value,
                                                      java.lang.String... args)
                                               throws java.lang.Exception

Throws:

java.lang.Exception

getDescription

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

setDescription

@Nonnull
public DBPasswordStorage setDescription(java.lang.String value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

getJavaClassName

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

setJavaClassName

@Nonnull
public DBPasswordStorage setJavaClassName(java.lang.String value,
                                                   java.lang.String... args)
                                            throws java.lang.Exception

Throws:

java.lang.Exception

getLabel

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

setLabel

@Nonnull
public DBPasswordStorage setLabel(java.lang.String value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

create

@Nonnull
 @CheckReturnValue
public static DBPasswordStorage 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<DBPasswordStorage> 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 DBPasswordStorage 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

extGetDerivedValue

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

Description copied from class: DBObject

OVERRIDE This method for all objects with derived fields that are NOT linked. A linked derived field should extend the extGetDerivedGlobalKey.

Overrides:

extGetDerivedValue 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.

Throws:

java.lang.Exception - a serious problem

extValidateField

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

Description copied from class: DBObject

Additional validation for particular field OVERRIDE THIS METHOD TO ADD VALIDATIONS FOR A FIELD.

OVERRIDE this method to add validation to a field but call iValidateField to perform the full validation for a field.

This method should be READ ONLY. Don't create DBObjects here.
When overriding this method the following code stub should be used.
ValidationError ve;
ve = super.extValidateField( field, list);
if( ve != null) return ve;
if( field.getName().equalsIgnoreCase( DBFIELD_FIELD1))
{
return list.createError( DBMessage.LIST_DB_MY_ERROR, this, field);
}
else if( field.getName().equalsIgnoreCase( DBFIELD_FIELD2))
{
....
}

Overrides:

extValidateField in class DBObject

Parameters:

field - The field to be validated

list - The validation list

Returns:

the error or warning.

Throws:

java.lang.Exception - a serious error

makePlugin

@Nullable
 @CheckReturnValue
public PasswordHandler makePlugin()
                                                        throws java.lang.ClassNotFoundException

Throws:

java.lang.ClassNotFoundException