uk.ac.ed.epcc.webapp.session

Class AbstractRequestFactory<R extends AbstractRequestFactory.AbstractRequest>

java.lang.Object

uk.ac.ed.epcc.webapp.model.data.DataObjectFactory<R>

uk.ac.ed.epcc.webapp.session.AbstractRequestFactory<R>

Type Parameters:

R - type of request object.

All Implemented Interfaces:

Contexed, ContextCached, FormCreatorProducer, FormUpdateProducer<R>, FilterMatcher<R>, TypeConverter<R,java.lang.Number>, DataObjectSelector<R>, Selector<DataObjectItemInput<R>>, Owner<R>, IndexedProducer<R>, Tagged, Targetted<R>

Direct Known Subclasses:

AbstractTargetRequestFactory, AbstractUserRequestFactory

public abstract class AbstractRequestFactory<R extends AbstractRequestFactory.AbstractRequest>
extends DataObjectFactory<R>

Abstract class for building request links (with expiry time). If the AppUser the link is for is known in advance use AbstractUserRequestFactory

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractRequestFactory.AbstractRequest

Nested classes/interfaces inherited from class uk.ac.ed.epcc.webapp.model.data.DataObjectFactory

DataObjectFactory.AbstractDataObjectInput, DataObjectFactory.AbstractFinder<X>, DataObjectFactory.DataObjectAcceptFilter, DataObjectFactory.DataObjectInput, DataObjectFactory.DataObjectIntegerInput, DataObjectFactory.DestAcceptFilter<T extends DataObject>, DataObjectFactory.FilterAdapter, DataObjectFactory.FilterCounter, DataObjectFactory.FilterExists, DataObjectFactory.FilterIterator, DataObjectFactory.FilterSelector, DataObjectFactory.FilterSet, DataObjectFactory.Finder, DataObjectFactory.MakeRemoteFilterVisitor<R extends DataObject>, DataObjectFactory.MatchFilter, DataObjectFactory.ReferencedAdapter<I extends Indexed>, DataObjectFactory.ReferenceIterator<I extends Indexed>, DataObjectFactory.SortingDataObjectInput, DataObjectFactory.TimeAcceptFilter<T extends DataObject>, DataObjectFactory.TimeFilter

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	EXPIRES
protected static java.lang.String	TAG

Fields inherited from class uk.ac.ed.epcc.webapp.model.data.DataObjectFactory

AUTO_CREATE_TABLES_FEATURE, COMPOSITES_SUFFIX, REJECT_MULTIPLE_RESULT_FEATURE, res

Constructor Summary

Constructors

Constructor and Description
AbstractRequestFactory()

Method Summary

Modifier and Type	Method and Description
R	findByTag(java.lang.String tag) locate a request object by tag.
protected TableSpecification	getDefaultTableSpecification(AppContext c, java.lang.String table) Get the default table specification if the table is to be created.
java.lang.String	makeTag(int id, java.lang.String seed) Generate a new tag used to create the request url.
void	purge() remove any time expired requests
protected void	purge(SQLFilter<R> fil) remove expired reqeusts based on a SQLFilter

Methods inherited from class uk.ac.ed.epcc.webapp.model.data.DataObjectFactory

all, allowPreSelect, canCreate, canUpdate, checkComposite, convertToDestinationFilter, customiseForm, equals, exists, find, find, find, find, find, getAllIterator, getComposite, getComposites, getComposites, getConfigTag, getContext, getCount, getDefaultRelationshipFilter, getDefaults, getDestFilter, getExcludeFilter, getFieldConstraints, getFieldHelp, getFilter, getFilter, getFilter, getFinalSelectFilter, getFinalTableSpecification, getFindFilter, getFormCreator, getFormUpdate, getID, getIndex, getInput, getInput, getInput, getLogger, getMaxIdentifierLength, getNullable, getOptional, getOrder, getProperty, getReferenced, getReferenceFieldType, getReferenceFieldType, getRemoteFilter, getRemoteSQLFilter, getResult, getResult, getSelectFilter, getSelector, getSelector, getSelectors, getSupress, getTableSpecification, getTableStructureContributers, getTag, getTarget, getTranslations, getUniqueIdName, hasComposite, hashCode, isMine, isMine, isMyReference, isValid, makeBDO, makeBDO, makeObject, makeRecord, makeReference, makeReference, matches, narrowSelector, narrowSelector, observeComposite, OrderBy, postCreateTableSetup, postSetContext, release, restrictDefaultInput, setComposites, setContext, setContext, setContextWithMake, setProperty, toString, updateTable

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

EXPIRES

protected static final java.lang.String EXPIRES

See Also:

Constant Field Values

TAG

protected static final java.lang.String TAG

See Also:

Constant Field Values

Constructor Detail

AbstractRequestFactory

public AbstractRequestFactory()

Method Detail

purge

public final void purge()
                 throws DataFault

remove any time expired requests

Throws:

DataFault

purge

protected void purge(SQLFilter<R> fil)
              throws DataFault

remove expired reqeusts based on a SQLFilter

Throws:

DataFault

findByTag

public R findByTag(java.lang.String tag)
            throws DataException

locate a request object by tag.

Parameters:

tag -

Returns:

Throws:

DataException

makeTag

public final java.lang.String makeTag(int id,
                                      java.lang.String seed)

Generate a new tag used to create the request url. This always contains a random value and an explicit integer id. The random value is generated from a hash of both a random number generator and a Seed value. The seed value should come from the context of the request. It is intended to mitigate against attacks against the random number generator. Both by making it harder to determine random number state by generating URLs and to guess urls (without also guessing/knowing the seed value). The id value specifies an object the request is in respect to. For example a user account being changed. This is to reduce the possibility of a tag clash.

Parameters:

id - - Integer id of object owning the request.

seed - - a String based on the context of the request.

Returns:

getDefaultTableSpecification

protected TableSpecification getDefaultTableSpecification(AppContext c,
                                                          java.lang.String table)

Description copied from class: DataObjectFactory

Get the default table specification if the table is to be created. A null result means that a default specification is not available and the table will not be created.

Overrides:

getDefaultTableSpecification in class DataObjectFactory<R extends AbstractRequestFactory.AbstractRequest>

Parameters:

c - AppContext

table - String table name.

Returns:

null or TableSpecification