Nuxeo ECM Projects 5.4.3-SNAPSHOT

org.nuxeo.ecm.platform.ui.web.auth.plugins
Class FormAuthenticator

java.lang.Object
  extended by org.nuxeo.ecm.platform.ui.web.auth.plugins.FormAuthenticator
All Implemented Interfaces:
NuxeoAuthenticationPlugin

public class FormAuthenticator
extends Object
implements NuxeoAuthenticationPlugin


Constructor Summary
FormAuthenticator()
           
 
Method Summary
 List<String> getUnAuthenticatedURLPrefix()
          Returns the list of prefix for unauthenticated URLs, typically the URLs associated to login prompt.
 Boolean handleLoginPrompt(HttpServletRequest httpRequest, HttpServletResponse httpResponse, String baseURL)
          Handles the Login Prompt.
 UserIdentificationInfo handleRetrieveIdentity(HttpServletRequest httpRequest, HttpServletResponse httpResponse)
          Retrieves user identification information from the request.
 void initPlugin(Map<String,String> parameters)
          Initializes the Plugin from parameters set in the XML descriptor.
 Boolean needLoginPrompt(HttpServletRequest httpRequest)
          Defines if the authentication plugin needs to do a login prompt.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FormAuthenticator

public FormAuthenticator()
Method Detail

handleLoginPrompt

public Boolean handleLoginPrompt(HttpServletRequest httpRequest,
                                 HttpServletResponse httpResponse,
                                 String baseURL)
Description copied from interface: NuxeoAuthenticationPlugin
Handles the Login Prompt.

Specified by:
handleLoginPrompt in interface NuxeoAuthenticationPlugin
Parameters:
httpRequest - the request
httpResponse - the response
Returns:
true if AuthFilter must stop execution (ie: login prompt generated a redirect), false otherwise

handleRetrieveIdentity

public UserIdentificationInfo handleRetrieveIdentity(HttpServletRequest httpRequest,
                                                     HttpServletResponse httpResponse)
Description copied from interface: NuxeoAuthenticationPlugin
Retrieves user identification information from the request.

Specified by:
handleRetrieveIdentity in interface NuxeoAuthenticationPlugin
Parameters:
httpRequest - the request
httpResponse - the response

needLoginPrompt

public Boolean needLoginPrompt(HttpServletRequest httpRequest)
Description copied from interface: NuxeoAuthenticationPlugin
Defines if the authentication plugin needs to do a login prompt.

Specified by:
needLoginPrompt in interface NuxeoAuthenticationPlugin
Returns:
true if LoginPrompt is used

initPlugin

public void initPlugin(Map<String,String> parameters)
Description copied from interface: NuxeoAuthenticationPlugin
Initializes the Plugin from parameters set in the XML descriptor.

Specified by:
initPlugin in interface NuxeoAuthenticationPlugin

getUnAuthenticatedURLPrefix

public List<String> getUnAuthenticatedURLPrefix()
Description copied from interface: NuxeoAuthenticationPlugin
Returns the list of prefix for unauthenticated URLs, typically the URLs associated to login prompt.

Specified by:
getUnAuthenticatedURLPrefix in interface NuxeoAuthenticationPlugin

Nuxeo ECM Projects 5.4.3-SNAPSHOT

Copyright © 2011 Nuxeo SAS. All Rights Reserved.