fr.paris.lutece.plugins.mylutece.authentication
Class ExternalAuthentication

java.lang.Object
  extended by fr.paris.lutece.plugins.mylutece.authentication.ExternalAuthentication
All Implemented Interfaces:
fr.paris.lutece.portal.service.security.LuteceAuthentication

public abstract class ExternalAuthentication
extends java.lang.Object
implements fr.paris.lutece.portal.service.security.LuteceAuthentication


Constructor Summary
ExternalAuthentication()
           
 
Method Summary
 java.lang.String getAccessControledTemplate()
          Returns the access controled template
 java.lang.String getAccessDeniedTemplate()
          Returns the access denied template
 java.lang.String getDoLoginUrl()
          Returns the DoLogin URL of the Authentication Service
 java.lang.String getDoLogoutUrl()
          Returns the DoLogout URL of the Authentication Service
 java.lang.String getLoginPageUrl()
          Returns the Login page URL of the Authentication Service
 java.lang.String getLostPasswordPageUrl()
          Returns the lost password URL of the Authentication Service
 java.lang.String getNewAccountPageUrl()
          Returns the new account page URL of the Authentication Service
 java.lang.String[] getRolesByUser(fr.paris.lutece.portal.service.security.LuteceUser user)
          get all roles for this user : - user's roles - user's groups roles
 fr.paris.lutece.portal.service.security.LuteceUser getUser(java.lang.String userLogin)
          Returns the user managed by the authentication service if this feature is available.
 java.util.Collection<fr.paris.lutece.portal.service.security.LuteceUser> getUsers()
          Returns all users managed by the authentication service if this feature is available.
 java.lang.String getViewAccountPageUrl()
          Returns the View account page URL of the Authentication Service
 boolean isExternalAuthentication()
          Indicates that the user should be already authenticated by an external authentication service (ex : Web Server authentication).
 boolean isUsersListAvailable()
          Tells whether or not the authentication service can provide a list of all its users
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface fr.paris.lutece.portal.service.security.LuteceAuthentication
getAnonymousUser, getAuthServiceName, getAuthType, getHttpAuthenticatedUser, isUserInRole, login, logout
 

Constructor Detail

ExternalAuthentication

public ExternalAuthentication()
Method Detail

isExternalAuthentication

public boolean isExternalAuthentication()
Indicates that the user should be already authenticated by an external authentication service (ex : Web Server authentication).

Specified by:
isExternalAuthentication in interface fr.paris.lutece.portal.service.security.LuteceAuthentication
Returns:
true if the authentication is external, false if the authentication is provided by the Lutece portal.

getLoginPageUrl

public java.lang.String getLoginPageUrl()
Returns the Login page URL of the Authentication Service

Specified by:
getLoginPageUrl in interface fr.paris.lutece.portal.service.security.LuteceAuthentication
Returns:
The URL

getDoLoginUrl

public java.lang.String getDoLoginUrl()
Returns the DoLogin URL of the Authentication Service

Specified by:
getDoLoginUrl in interface fr.paris.lutece.portal.service.security.LuteceAuthentication
Returns:
The URL

getDoLogoutUrl

public java.lang.String getDoLogoutUrl()
Returns the DoLogout URL of the Authentication Service

Specified by:
getDoLogoutUrl in interface fr.paris.lutece.portal.service.security.LuteceAuthentication
Returns:
The URL

getNewAccountPageUrl

public java.lang.String getNewAccountPageUrl()
Returns the new account page URL of the Authentication Service

Specified by:
getNewAccountPageUrl in interface fr.paris.lutece.portal.service.security.LuteceAuthentication
Returns:
The URL

getViewAccountPageUrl

public java.lang.String getViewAccountPageUrl()
Returns the View account page URL of the Authentication Service

Specified by:
getViewAccountPageUrl in interface fr.paris.lutece.portal.service.security.LuteceAuthentication
Returns:
The URL

getLostPasswordPageUrl

public java.lang.String getLostPasswordPageUrl()
Returns the lost password URL of the Authentication Service

Specified by:
getLostPasswordPageUrl in interface fr.paris.lutece.portal.service.security.LuteceAuthentication
Returns:
The URL

getAccessDeniedTemplate

public java.lang.String getAccessDeniedTemplate()
Returns the access denied template

Specified by:
getAccessDeniedTemplate in interface fr.paris.lutece.portal.service.security.LuteceAuthentication
Returns:
The template

getAccessControledTemplate

public java.lang.String getAccessControledTemplate()
Returns the access controled template

Specified by:
getAccessControledTemplate in interface fr.paris.lutece.portal.service.security.LuteceAuthentication
Returns:
The template

isUsersListAvailable

public boolean isUsersListAvailable()
Tells whether or not the authentication service can provide a list of all its users

Specified by:
isUsersListAvailable in interface fr.paris.lutece.portal.service.security.LuteceAuthentication
Returns:
true if the service can return a users list

getUsers

public java.util.Collection<fr.paris.lutece.portal.service.security.LuteceUser> getUsers()
Returns all users managed by the authentication service if this feature is available.

Specified by:
getUsers in interface fr.paris.lutece.portal.service.security.LuteceAuthentication
Returns:
A collection of Lutece users or null if the service doesn't provide a users list

getUser

public fr.paris.lutece.portal.service.security.LuteceUser getUser(java.lang.String userLogin)
Returns the user managed by the authentication service if this feature is available.

Specified by:
getUser in interface fr.paris.lutece.portal.service.security.LuteceAuthentication
Returns:
A Lutece users or null if the service doesn't provide a user

getRolesByUser

public java.lang.String[] getRolesByUser(fr.paris.lutece.portal.service.security.LuteceUser user)
get all roles for this user : - user's roles - user's groups roles

Specified by:
getRolesByUser in interface fr.paris.lutece.portal.service.security.LuteceAuthentication
Parameters:
user - The user
Returns:
Array of roles


Copyright © 2009 Mairie de Paris. All Rights Reserved.