uk.ac.ed.epcc.webapp.session

Class PublicKeyComposite<X>

java.lang.Object

uk.ac.ed.epcc.webapp.model.data.Composite<AU,X>

uk.ac.ed.epcc.webapp.session.AppUserComposite<AppUser,PublicKeyComposite>

uk.ac.ed.epcc.webapp.session.PublicKeyComposite<X>

Type Parameters:

X - type key parses to

All Implemented Interfaces:

TemplateContributor<AppUser>, Contexed, AnonymisingComposite<AppUser>, TableStructureContributer<AppUser>, DataContributor<AppUser>, HistoryFieldContributor, MetaDataContributer<AppUser>, SummaryContributer<AppUser>, UpdateNoteProvider<AppUser>

Direct Known Subclasses:

MultiKeyComposite, OldSingleKeyComposite, SingleKeyComposite

public abstract class PublicKeyComposite<X>
extends AppUserComposite<AppUser,PublicKeyComposite>
implements UpdateNoteProvider<AppUser>, AnonymisingComposite<AppUser>, SummaryContributer<AppUser>, MetaDataContributer<AppUser>, TemplateContributor<AppUser>, HistoryFieldContributor

A Composite that adds a SSH public key to an AppUser

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NORMALISED_PUBLIC_KEY_META_ATTR
static java.lang.String	PUBLIC_KEY
static java.lang.String	PUBLIC_KEY_META_ATTR
static Feature	SSH_REQUIRE_RSA_FEATURE

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

fac

Constructor Summary

Constructors

Constructor and Description
PublicKeyComposite(AppUserFactory fac)

Method Summary

Modifier and Type	Method and Description
void	addAttributes(java.util.Map<java.lang.String,java.lang.Object> attributes, AppUser target) Add to the set of attributes.
void	addMetaData(java.util.Map<java.lang.String,java.lang.Object> attributes, AppUser person) Add to the set of meta-data.
java.util.Set<java.lang.String>	addOptional(java.util.Set<java.lang.String> optional) generate the set of optional fields to be used to provide class specific defaults in form creation/update.
java.util.Map<java.lang.String,Selector>	addSelectors(java.util.Map<java.lang.String,Selector> selectors) Get a Map of selectors to use for forms of this type.
void	addToHistorySpecification(TableSpecification spec) add fields to the history table default specification.
java.util.Map<java.lang.String,java.lang.String>	addTranslations(java.util.Map<java.lang.String,java.lang.String> translations) return a default set of translation between field names and text labels.
<CB extends ContentBuilder> CB	addUpdateNotes(CB cb, AppUser person) add Notes to be included in a signup/update form.
void	anonymise(AppUser target)
protected abstract java.lang.String	format(X key)
protected abstract ParseAbstractInput<java.lang.String>	getInput()
java.lang.String	getNormalisedPublicKey(AppUser person)
java.lang.String	getPublicKey(AppUser person)
protected java.lang.Class<? super PublicKeyComposite>	getType() Returns the type the composite should be registered under.
boolean	hasPublicKey(AppUser person)
protected boolean	isOptional()
protected abstract X	load(java.lang.String value)
TableSpecification	modifyDefaultTableSpecification(TableSpecification spec, java.lang.String table) Modify the TableSpecification of the target factory.
protected java.lang.String	normalise(java.lang.String old)
void	postUpdate(AppUser o, Form f, java.util.Map<java.lang.String,java.lang.Object> orig, boolean changed) perform side effects after a formupdate
void	setPublickey(AppUser person, java.lang.String key)
void	setTemplateContent(TemplateFile template, java.lang.String prefix, AppUser target) Set parameters in a template.
boolean	usePublicKey()

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

addDefaults, addFieldHelp, addSuppress, customiseForm, customiseUpdateForm, getContext, getFactory, getLogger, getRecord, getRepository, preRegister, release, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface uk.ac.ed.epcc.webapp.model.AnonymisingComposite

addEraseFields

Methods inherited from interface uk.ac.ed.epcc.webapp.model.data.TableStructureContributer

addFieldConstraints, addFormFields

Field Detail

NORMALISED_PUBLIC_KEY_META_ATTR

public static final java.lang.String NORMALISED_PUBLIC_KEY_META_ATTR

See Also:

Constant Field Values

PUBLIC_KEY_META_ATTR

public static final java.lang.String PUBLIC_KEY_META_ATTR

See Also:

Constant Field Values

SSH_REQUIRE_RSA_FEATURE

public static final Feature SSH_REQUIRE_RSA_FEATURE

PUBLIC_KEY

public static final java.lang.String PUBLIC_KEY

See Also:

Constant Field Values

Constructor Detail

PublicKeyComposite

public PublicKeyComposite(AppUserFactory fac)

Method Detail

getType

protected java.lang.Class<? super PublicKeyComposite> getType()

Description copied from class: Composite

Returns the type the composite should be registered under.

Specified by:

getType in class Composite<AppUser,PublicKeyComposite>

Returns:

registration type

addTranslations

public java.util.Map<java.lang.String,java.lang.String> addTranslations(java.util.Map<java.lang.String,java.lang.String> translations)

Description copied from interface: TableStructureContributer

return a default set of translation between field names and text labels. This method provides a class specific set of defaults. The individual Form classes can still override this.

Specified by:

addTranslations in interface TableStructureContributer<AppUser>

Overrides:

addTranslations in class Composite<AppUser,PublicKeyComposite>

Returns:

Map

normalise

protected java.lang.String normalise(java.lang.String old)
                              throws java.lang.Exception

Throws:

java.lang.Exception

load

protected abstract X load(java.lang.String value)
                   throws java.lang.Exception

Throws:

java.lang.Exception

format

protected abstract java.lang.String format(X key)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getInput

protected abstract ParseAbstractInput<java.lang.String> getInput()

addSelectors

public java.util.Map<java.lang.String,Selector> addSelectors(java.util.Map<java.lang.String,Selector> selectors)

Description copied from interface: TableStructureContributer

Get a Map of selectors to use for forms of this type. This method provides a class specific set of defaults but the specific form classes can override this.

Specified by:

addSelectors in interface TableStructureContributer<AppUser>

Overrides:

addSelectors in class Composite<AppUser,PublicKeyComposite>

Returns:

Map of modified selectors/inputs

postUpdate

public void postUpdate(AppUser o,
                       Form f,
                       java.util.Map<java.lang.String,java.lang.Object> orig,
                       boolean changed)
                throws DataException

Description copied from interface: TableStructureContributer

perform side effects after a formupdate

Specified by:

postUpdate in interface TableStructureContributer<AppUser>

Overrides:

postUpdate in class Composite<AppUser,PublicKeyComposite>

Throws:

DataException

modifyDefaultTableSpecification

public TableSpecification modifyDefaultTableSpecification(TableSpecification spec,
                                                          java.lang.String table)

Description copied from interface: TableStructureContributer

Modify the TableSpecification of the target factory.

Specified by:

modifyDefaultTableSpecification in interface TableStructureContributer<AppUser>

Overrides:

modifyDefaultTableSpecification in class Composite<AppUser,PublicKeyComposite>

Returns:

addOptional

public java.util.Set<java.lang.String> addOptional(java.util.Set<java.lang.String> optional)

Description copied from interface: TableStructureContributer

generate the set of optional fields to be used to provide class specific defaults in form creation/update. If null is returned the default behaviour is to take fields that can be null in the database.

Specified by:

addOptional in interface TableStructureContributer<AppUser>

Overrides:

addOptional in class Composite<AppUser,PublicKeyComposite>

Returns:

Set

isOptional

protected boolean isOptional()

Returns:

usePublicKey

public boolean usePublicKey()

addUpdateNotes

public <CB extends ContentBuilder> CB addUpdateNotes(CB cb,
                                                     AppUser person)

Description copied from interface: UpdateNoteProvider

add Notes to be included in a signup/update form. This is included within the block element above the form.

Specified by:

addUpdateNotes in interface UpdateNoteProvider<AppUser>

Returns:

getPublicKey

public java.lang.String getPublicKey(AppUser person)

getNormalisedPublicKey

public java.lang.String getNormalisedPublicKey(AppUser person)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

setPublickey

public void setPublickey(AppUser person,
                         java.lang.String key)

hasPublicKey

public boolean hasPublicKey(AppUser person)

anonymise

public void anonymise(AppUser target)

Specified by:

anonymise in interface AnonymisingComposite<AppUser>

addAttributes

public void addAttributes(java.util.Map<java.lang.String,java.lang.Object> attributes,
                          AppUser target)

Description copied from interface: SummaryContributer

Add to the set of attributes. These will usually be added to a Table so the data should be of a type that can be displayed by Tables The keys should be display text.

Specified by:

addAttributes in interface SummaryContributer<AppUser>

addMetaData

public void addMetaData(java.util.Map<java.lang.String,java.lang.Object> attributes,
                        AppUser person)

Description copied from interface: DataContributor

Add to the set of meta-data.

Specified by:

addMetaData in interface DataContributor<AppUser>

setTemplateContent

public void setTemplateContent(TemplateFile template,
                               java.lang.String prefix,
                               AppUser target)

Description copied from interface: TemplateContributor

Set parameters in a template. The prefix is to allow multiple objects of the same type to be added to a template under differnet names.

Specified by:

setTemplateContent in interface TemplateContributor<AppUser>

Parameters:

template - TemplateFile to add content to.

prefix - String prefix to be pre-pended to property/region names

target - Object to take data from

addToHistorySpecification

public void addToHistorySpecification(TableSpecification spec)

Description copied from interface: HistoryFieldContributor

add fields to the history table default specification.

Specified by:

addToHistorySpecification in interface HistoryFieldContributor