org.dspace.app.xmlui.aspect.eperson

Class StartAuthenticationAction

java.lang.Object

org.apache.cocoon.util.AbstractLogEnabled

org.apache.cocoon.acting.AbstractAction

org.dspace.app.xmlui.aspect.eperson.StartAuthenticationAction

All Implemented Interfaces:

org.apache.cocoon.acting.Action

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

This action will start the necessary steps to authenticate a user. After the user successfully authenticates, the user will resume this request with all parameters and attributes intact. An optional message can be added that will be displayed on the login form. This could be used to provide a reason why the user is being queried for a user name and password.

Possible parameters are:

• header: An i18n message that will be used as the header for the message.
• message: An i18n message tag.
• characters: Characters to be displayed, possibly for untranslated error messages

Example:

 <map:action name="StartAuthenticationAction" src="org.dspace.app.xmlui.eperson.StartAuthenticationAction"/>
 
 <map:act type="StartAuthenticationAction"/>
 
 

Typically, this is used in conjunction with the AuthenticatedSelector as:

 <map:select type="AuthenticatedSelector">
   <map:when test="eperson">
     ...
   </map:when>
   <map:otherwise>
     <map:act type="startAuthenticationAction">
       <map:parameter name="message" value="xmlui.Aspect.component.tag"/>
     </map:act>
   </map:otherwise>
 </map:select>
 
 

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
StartAuthenticationAction()

Method Summary

Methods

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) Redirect the user to the login page.

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

StartAuthenticationAction

public StartAuthenticationAction()

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

Redirect the user to the login page.

Parameters:

redirector - redirector.

resolver - source resolver.

objectModel - object model.

source - source.

parameters - sitemap parameters.

Returns:

result of the action.

Throws:

Exception - passed through.