com.aspc.magic

Class DBMagicNumber

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.magic.DBMagicNumber

All Implemented Interfaces:

SecondaryCacheGroup

Direct Known Subclasses:

DBICal, RestMagicNumber, RestPassMagicNumber, VCardQuery

public class DBMagicNumber
extends DBObject

The Magic Number provides a mechanism for automatically logging in users and running an associated command.

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

Since:

22 April 2004

Author:

Jason McGrath

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 Magic Number provides a mechanism for automatically logging in users and running an associated command.
static java.lang.String	DBCLASS_NAME The Magic Number provides a mechanism for automatically logging in users and running an associated command.

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static DBMagicNumber	create(MutableDataSource mds) Make a new instance of this class.
protected void	extAutoEnterCreate() Additional functionality when an object is created.
protected void	extCheckDeleteAccess() Additional access checking for delete access of this object.
protected void	extCheckModifyAccess() Additional access checking for write access of this object.
protected void	extFixUp() fixes the following problem 1) delete the session if the login can no longer be found.
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 DBMagicNumber	find(java.lang.String magicNumber, DataSource ds) Find the magic number object that created in layer ds
Contact	findContact(java.lang.String... args) This magic number was generated for this contact.
static DBMagicNumber	findKey(DataSource ds, java.lang.String key) Find the target for this class by the primary key
DBTimeZone	findTimezone(java.lang.String... args) The time zone to use for this magic number.
DBMagicNumberType	findType(java.lang.String... args) the type of the magic number.
Login	findUser(java.lang.String... args) User.
int	getActualCallCount(java.lang.String... args)
java.lang.String	getBatch(java.lang.String... args)
java.lang.String	getCommand(java.lang.String... args)
Contact	getContact(java.lang.String... args)
java.util.Date	getExpiry(java.lang.String... args)
java.lang.String	getMagicNumber(java.lang.String... args)
int	getMaxCallCount(java.lang.String... args)
java.lang.String	getSearchKey(java.lang.String... args)
int	getTargetLayerID(java.lang.String... args)
DBTimeZone	getTimezone(java.lang.String... args)
DBMagicNumberType	getType(java.lang.String... args)
Login	getUser(java.lang.String... args)
boolean	isValid()
boolean	isValidToExpunge(java.lang.String... args)
static DBQuery<DBMagicNumber>	makeQuery(DataSource ds) Make a new QUERY for this class.
static void	processMagicNumber(DBMagicNumber mn)
DBMagicNumber	setActualCallCount(int value, java.lang.String... args)
DBMagicNumber	setBatch(java.lang.String value, java.lang.String... args)
DBMagicNumber	setCommand(java.lang.String value, java.lang.String... args)
DBMagicNumber	setContact(com.aspc.dal.dbobj.contact.Contact value, java.lang.String... args)
DBMagicNumber	setExpiry(java.util.Date value, java.lang.String... args)
DBMagicNumber	setMagicNumber(java.lang.String value, java.lang.String... args)
DBMagicNumber	setMaxCallCount(int value, java.lang.String... args)
DBMagicNumber	setSearchKey(java.lang.String value, java.lang.String... args)
DBMagicNumber	setTargetLayerID(int value, java.lang.String... args)
DBMagicNumber	setTimezone(com.aspc.dal.dbobj.misc.TimeZone value, java.lang.String... args)
DBMagicNumber	setType(com.aspc.dal.magic.DBMagicNumberType value, java.lang.String... args)
DBMagicNumber	setUser(com.aspc.dal.dbobj.contact.Login 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, extCanDeleteDependantObject, extCheckCreateAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, 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 Magic Number provides a mechanism for automatically logging in users and running an associated command.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

The Magic Number provides a mechanism for automatically logging in users and running an associated command.

Constructor Detail

DBMagicNumber

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

getMagicNumber

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

setMagicNumber

@Nonnull
public DBMagicNumber setMagicNumber(java.lang.String value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getActualCallCount

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

setActualCallCount

@Nonnull
public DBMagicNumber setActualCallCount(int value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

getBatch

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

setBatch

@Nonnull
public DBMagicNumber setBatch(java.lang.String value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getCommand

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

setCommand

@Nonnull
public DBMagicNumber setCommand(java.lang.String value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getContact

@CheckReturnValue
 @Nullable
public Contact getContact(java.lang.String... args)

findContact

@CheckReturnValue
 @Nonnull
public final Contact findContact(java.lang.String... args)
                                                      throws NotFoundException

This magic number was generated for this contact.

--> Contact (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Person/Business

Throws:

NotFoundException - Contact was not found

setContact

@Nonnull
public DBMagicNumber setContact(com.aspc.dal.dbobj.contact.Contact 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)

setExpiry

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

Throws:

java.lang.Exception

getMaxCallCount

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

setMaxCallCount

@Nonnull
public DBMagicNumber setMaxCallCount(int value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getSearchKey

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

setSearchKey

@Nonnull
public DBMagicNumber setSearchKey(java.lang.String value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getTargetLayerID

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

setTargetLayerID

@Nonnull
public DBMagicNumber setTargetLayerID(int value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getTimezone

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

findTimezone

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

The time zone to use for this magic number.

--> TimeZone (String, Searchable)

Parameters:

args - the optional arguments

Returns:

TimeZone

Throws:

NotFoundException - TimeZone was not found

setTimezone

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

Throws:

java.lang.Exception

getType

@CheckReturnValue
 @Nullable
public DBMagicNumberType getType(java.lang.String... args)

findType

@CheckReturnValue
 @Nonnull
public final DBMagicNumberType findType(java.lang.String... args)
                                                             throws NotFoundException

the type of the magic number.

--> DBMagicNumberType (String, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

DBMagicNumberType

Throws:

NotFoundException - DBMagicNumberType was not found

setType

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

Throws:

java.lang.Exception

getUser

@CheckReturnValue
 @Nullable
public Login getUser(java.lang.String... args)

findUser

@CheckReturnValue
 @Nonnull
public final Login findUser(java.lang.String... args)
                                                 throws NotFoundException

User.

--> Login (String, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

Login

Throws:

NotFoundException - Login was not found

setUser

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

Throws:

java.lang.Exception

isValidToExpunge

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

create

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

find

public static DBMagicNumber find(java.lang.String magicNumber,
                                 DataSource ds)
                          throws NotFoundException

Find the magic number object that created in layer ds

Parameters:

magicNumber - The magic number

ds - The data source to use

Returns:

The magic number object that created in layer ds

Throws:

NotFoundException - A serious problem

extAutoEnterCreate

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

Additional functionality when an object is created.

Overrides:

extAutoEnterCreate in class DBObject

Throws:

java.lang.Exception - A serious problem

See Also:

com.aspc.DBObj.DBObject#autoEnterCreate()

extCheckModifyAccess

@OverridingMethodsMustInvokeSuper
protected void extCheckModifyAccess()
                                                               throws DBAccessException

Description copied from class: DBObject

Additional access checking for write access of this object.

Overrides:

extCheckModifyAccess in class DBObject

Throws:

DBAccessException - No access to modify

extCheckDeleteAccess

@OverridingMethodsMustInvokeSuper
protected void extCheckDeleteAccess()
                                                               throws DBAccessException

Description copied from class: DBObject

Additional access checking for delete access of this object.

Overrides:

extCheckDeleteAccess in class DBObject

Throws:

DBAccessException - No access to delete

isValid

public boolean isValid()

processMagicNumber

public static final void processMagicNumber(DBMagicNumber mn)
                                     throws MagicException

Throws:

MagicException

extFixUp

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

fixes the following problem 1) delete the session if the login can no longer be found. 2) delete the session if the soap session isn't unique

Overrides:

extFixUp in class DBObject

Throws:

java.lang.Exception - a serious problem

extValidateField

@CheckReturnValue
 @OverridingMethodsMustInvokeSuper
 @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

extGetDerivedValue

@CheckReturnValue
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