org.dspace.app.xmlui.aspect.eperson

Class PasswordLogin

java.lang.Object

org.apache.cocoon.util.AbstractLogEnabled

org.apache.cocoon.xml.AbstractXMLProducer

org.apache.cocoon.xml.AbstractXMLPipe

org.apache.cocoon.transformation.AbstractTransformer

org.dspace.app.xmlui.wing.AbstractWingTransformer

org.dspace.app.xmlui.cocoon.AbstractDSpaceTransformer

org.dspace.app.xmlui.aspect.eperson.PasswordLogin

All Implemented Interfaces:

org.apache.avalon.excalibur.pool.Poolable, org.apache.avalon.excalibur.pool.Recyclable, org.apache.cocoon.caching.CacheableProcessingComponent, org.apache.cocoon.sitemap.SitemapModelComponent, org.apache.cocoon.transformation.Transformer, org.apache.cocoon.xml.XMLPipe, org.apache.cocoon.xml.XMLProducer, org.apache.excalibur.xml.sax.XMLConsumer, DSpaceTransformer, WingTransformer, ContentHandler, LexicalHandler

public class PasswordLogin
extends AbstractDSpaceTransformer
implements org.apache.cocoon.caching.CacheableProcessingComponent

Query the user for their authentication credentials. The parameter "return-url" may be passed to give a location where to redirect the user to after successfully authenticating.

Author:

Sid, Scott Phillips

Field Summary

Fields

Modifier and Type	Field and Description
static Message	T_dspace_home
static Message	T_email_address
static Message	T_error_bad_login
static Message	T_forgot_link
static Message	T_head1
static Message	T_head2
static Message	T_para1
static Message	T_password
static Message	T_register_link
static Message	T_submit
static Message	T_title language strings
static Message	T_trail

Fields inherited from class org.dspace.app.xmlui.cocoon.AbstractDSpaceTransformer

context, contextPath, eperson, knot, objectModel, parameters, servletPath, sitemapURI, url

Fields inherited from class org.apache.cocoon.xml.AbstractXMLProducer

contentHandler, EMPTY_CONTENT_HANDLER, lexicalHandler, xmlConsumer

Fields inherited from interface org.apache.cocoon.transformation.Transformer

ROLE

Constructor Summary

Constructors

Constructor and Description
PasswordLogin()

Method Summary

Methods

Modifier and Type	Method and Description
void	addBody(Body body) Display the login form.
void	addPageMeta(PageMeta pageMeta) Set the page title and trail.
Serializable	getKey() Generate the unique caching key.
org.apache.excalibur.source.SourceValidity	getValidity() Generate the cache validity object.

Methods inherited from class org.dspace.app.xmlui.cocoon.AbstractDSpaceTransformer

addOptions, addUserMeta, decodeFromURL, dispose, encodeForURL, generateURL, getComponentName, getObjectManager, handleException, recycle, setup

Methods inherited from class org.dspace.app.xmlui.wing.AbstractWingTransformer

createWingDocument, endDocument, endElement, endPrefixMapping, getDefaultMessageCatalogue, message, message, setupWing, startDocument, startElement, startPrefixMapping

Methods inherited from class org.apache.cocoon.xml.AbstractXMLPipe

characters, comment, endCDATA, endDTD, endEntity, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity, startCDATA, startDTD, startEntity

Methods inherited from class org.apache.cocoon.xml.AbstractXMLProducer

setConsumer, setContentHandler, setLexicalHandler

Methods inherited from class org.apache.cocoon.util.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xml.sax.ContentHandler

characters, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity

Methods inherited from interface org.xml.sax.ext.LexicalHandler

comment, endCDATA, endDTD, endEntity, startCDATA, startDTD, startEntity

Methods inherited from interface org.apache.cocoon.xml.XMLProducer

setConsumer

Field Detail

T_title

public static final Message T_title

language strings

T_dspace_home

public static final Message T_dspace_home

T_trail

public static final Message T_trail

T_head1

public static final Message T_head1

T_email_address

public static final Message T_email_address

T_error_bad_login

public static final Message T_error_bad_login

T_password

public static final Message T_password

T_forgot_link

public static final Message T_forgot_link

T_submit

public static final Message T_submit

T_head2

public static final Message T_head2

T_para1

public static final Message T_para1

T_register_link

public static final Message T_register_link

Constructor Detail

PasswordLogin

public PasswordLogin()

Method Detail

getKey

public Serializable getKey()

Generate the unique caching key. This key must be unique inside the space of this component.

Specified by:

getKey in interface org.apache.cocoon.caching.CacheableProcessingComponent

getValidity

public org.apache.excalibur.source.SourceValidity getValidity()

Generate the cache validity object.

Specified by:

getValidity in interface org.apache.cocoon.caching.CacheableProcessingComponent

addPageMeta

public void addPageMeta(PageMeta pageMeta)
                 throws WingException

Set the page title and trail.

Specified by:

addPageMeta in interface DSpaceTransformer

Specified by:

addPageMeta in interface WingTransformer

Overrides:

addPageMeta in class AbstractDSpaceTransformer

Parameters:

pageMeta - to be added.

Throws:

WingException - whenever.

UIException - whenever.

addBody

public void addBody(Body body)
             throws SQLException,
                    SAXException,
                    WingException

Display the login form.

Specified by:

addBody in interface DSpaceTransformer

Specified by:

addBody in interface WingTransformer

Overrides:

addBody in class AbstractDSpaceTransformer

Parameters:

body - to be added.

Throws:

SQLException - whenever.

SAXException - whenever.

WingException - whenever.

UIException - whenever.