uk.ac.ed.epcc.webapp.model.mail

Class AbstractMessageHandlerFactory<H extends AbstractMessageHandlerFactory.Provider>

java.lang.Object

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

uk.ac.ed.epcc.webapp.model.mail.AbstractMessageHandlerFactory<H>

Type Parameters:

H -

All Implemented Interfaces:

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

public abstract class AbstractMessageHandlerFactory<H extends AbstractMessageHandlerFactory.Provider>
extends DataObjectFactory<H>
implements MessageHandlerFactory

A superclass for MessageHandlerFactorys where the message data is stored directly in the table not via a reference to a remote table. This is primarily an example class and for use in unit tests but may be useful as a base class for some use-cases. It will need to be extended to add additional fields nedded to specify the access control logic and how to populate the initial message Each

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AbstractMessageHandlerFactory.Composer
class	AbstractMessageHandlerFactory.Handler
static class	AbstractMessageHandlerFactory.Provider
static class	AbstractMessageHandlerFactory.Status

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 AbstractMessageHandlerFactory.Status.Value	ABANDONED
protected static AbstractMessageHandlerFactory.Status.Value	COMPOSE
protected static AbstractMessageHandlerFactory.Status.Value	SENT

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
AbstractMessageHandlerFactory(AppContext conn, java.lang.String table)

Method Summary

Modifier and Type	Method and Description
boolean	canEdit(H h, SessionService<?> user)
boolean	canRead(H h, SessionService<?> user)
protected TableSpecification	getDefaultTableSpecification(AppContext c, java.lang.String table) Get the default table specification if the table is to be created.
MessageHandler	getHandler(java.util.LinkedList<java.lang.String> path, SessionService<?> user) Locate a MessageHandler by id number This method also does access control.
MessageHandler	getHandler(SessionService<?> user, H h)
java.lang.Class<H>	getTarget() Get a bound on the type of object produced by this factory for run-time checking.

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, 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

Methods inherited from interface uk.ac.ed.epcc.webapp.Tagged

getTag

Methods inherited from interface uk.ac.ed.epcc.webapp.Contexed

getContext

Field Detail

COMPOSE

protected static final AbstractMessageHandlerFactory.Status.Value COMPOSE

SENT

protected static final AbstractMessageHandlerFactory.Status.Value SENT

ABANDONED

protected static final AbstractMessageHandlerFactory.Status.Value ABANDONED

Constructor Detail

AbstractMessageHandlerFactory

public AbstractMessageHandlerFactory(AppContext conn,
                                     java.lang.String table)

Method Detail

getHandler

public MessageHandler getHandler(java.util.LinkedList<java.lang.String> path,
                                 SessionService<?> user)

Description copied from interface: MessageHandlerFactory

Locate a MessageHandler by id number This method also does access control. If the user only has read permission a simple MessageHandler should be returned. If the user has edit permission a MessageComposer should be returned. Otherwise this method returns null. The path may contain additional path elements after the MessageHandler is identified.

Specified by:

getHandler in interface MessageHandlerFactory

Parameters:

path - path identifier for MessageComposers from this Factory

user - AppUSer making request

Returns:

MessageHandler or MessageComposer or null

getHandler

public MessageHandler getHandler(SessionService<?> user,
                                 H h)

Parameters:

user -

h -

canRead

public boolean canRead(H h,
                       SessionService<?> user)

canEdit

public boolean canEdit(H h,
                       SessionService<?> user)

getTarget

public java.lang.Class<H> getTarget()

Description copied from class: DataObjectFactory

Get a bound on the type of object produced by this factory for run-time checking. This implements IndexedProducer.getTarget(). Normally this method should be overridden each time we make a sub-class that narrows the produced type. However checks should still pass if the super-type method is retained.

Specified by:

getTarget in interface IndexedProducer<H extends AbstractMessageHandlerFactory.Provider>

Specified by:

getTarget in interface Targetted<H extends AbstractMessageHandlerFactory.Provider>

Overrides:

getTarget in class DataObjectFactory<H extends AbstractMessageHandlerFactory.Provider>

Returns:

Class object for return type

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<H extends AbstractMessageHandlerFactory.Provider>

Parameters:

c - AppContext

table - String table name.

Returns:

null or TableSpecification