org.dspace.app.xmlui.aspect.eperson

Class AuthenticateAction

java.lang.Object

org.apache.cocoon.util.AbstractLogEnabled

org.apache.cocoon.acting.AbstractAction

org.dspace.app.xmlui.aspect.eperson.AuthenticateAction

All Implemented Interfaces:

org.apache.cocoon.acting.Action

public class AuthenticateAction
extends org.apache.cocoon.acting.AbstractAction

Attempt to authenticate the user based upon their presented credentials. This action uses the HTTP parameters of login_email, login_password, and login_realm as credentials.

If the authentication attempt is successful then an HTTP redirect will be sent to the browser redirecting them to their original location in the system before authenticated or if none is supplied back to the DSpace home page. The action will also return true, thus contents of the action will be executed.

If the authentication attempt fails, the action returns false.

Example use:

 
 <map:act name="Authenticate">
   <map:serialize type="xml"/>
 </map:act>
 <map:transform type="try-to-login-again-transformer">
 
 

Author:

Scott Phillips

Field Summary

Fields inherited from class org.apache.cocoon.acting.AbstractAction

EMPTY_MAP

Fields inherited from interface org.apache.cocoon.acting.Action

ROLE

Constructor Summary

Constructors

Constructor and Description
AuthenticateAction()

Method Summary

Modifier and Type	Method and Description
Map	act(org.apache.cocoon.environment.Redirector redirector, org.apache.cocoon.environment.SourceResolver resolver, Map objectModel, String source, org.apache.avalon.framework.parameters.Parameters parameters) Attempt to authenticate the user.

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

Constructor Detail

AuthenticateAction

public AuthenticateAction()

Method Detail

act

public Map act(org.apache.cocoon.environment.Redirector redirector,
               org.apache.cocoon.environment.SourceResolver resolver,
               Map objectModel,
               String source,
               org.apache.avalon.framework.parameters.Parameters parameters)
        throws Exception

Attempt to authenticate the user.

Parameters:

redirector - redirector.

resolver - source resolver.

objectModel - object model.

source - source

parameters - sitemap parameters.

Returns:

result of the action.

Throws:

Exception - on error.