com.xpn.xwiki.user.impl.xwiki

Class GroovyAuthServiceImpl

java.lang.Object

com.xpn.xwiki.user.impl.xwiki.AbstractXWikiAuthService

com.xpn.xwiki.user.impl.xwiki.XWikiAuthServiceImpl

com.xpn.xwiki.user.impl.xwiki.GroovyAuthServiceImpl

All Implemented Interfaces:

XWikiAuthService

public class GroovyAuthServiceImpl
extends XWikiAuthServiceImpl

Field Summary

Fields inherited from class com.xpn.xwiki.user.impl.xwiki.XWikiAuthServiceImpl

authenticators

Constructor Summary

Constructors

Constructor and Description
GroovyAuthServiceImpl()

Method Summary

Modifier and Type	Method and Description
Principal	authenticate(String username, String password, XWikiContext context)
XWikiUser	checkAuth(String username, String password, String rememberme, XWikiContext context) Method to authenticate and set the cookie from a username and password passed as parameters
XWikiUser	checkAuth(XWikiContext context)
XWikiAuthService	getAuthService(XWikiContext context)
protected String	getParam(String name, XWikiContext context)
void	showLogin(XWikiContext context)

Methods inherited from class com.xpn.xwiki.user.impl.xwiki.XWikiAuthServiceImpl

checkPassword, createUser, findUser, getAuthenticator, stripContextPathFromURL

Methods inherited from class com.xpn.xwiki.user.impl.xwiki.AbstractXWikiAuthService

authenticateSuperAdmin, isSuperAdmin

Methods inherited from class java.lang.Object

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

Constructor Detail

GroovyAuthServiceImpl

public GroovyAuthServiceImpl()

Method Detail

getParam

protected String getParam(String name,
                          XWikiContext context)

Overrides:

getParam in class XWikiAuthServiceImpl

getAuthService

public XWikiAuthService getAuthService(XWikiContext context)

checkAuth

public XWikiUser checkAuth(XWikiContext context)
                    throws XWikiException

Specified by:

checkAuth in interface XWikiAuthService

Overrides:

checkAuth in class XWikiAuthServiceImpl

Throws:

XWikiException

checkAuth

public XWikiUser checkAuth(String username,
                           String password,
                           String rememberme,
                           XWikiContext context)
                    throws XWikiException

Description copied from class: XWikiAuthServiceImpl

Method to authenticate and set the cookie from a username and password passed as parameters

Specified by:

checkAuth in interface XWikiAuthService

Overrides:

checkAuth in class XWikiAuthServiceImpl

Parameters:

username - the user name for the user to authenticate

password - the password of the user to authenticate

context - the XWiki context object

Returns:

null if the user is not authenticated properly

Throws:

XWikiException - in case of authentication error

showLogin

public void showLogin(XWikiContext context)
               throws XWikiException

Specified by:

showLogin in interface XWikiAuthService

Overrides:

showLogin in class XWikiAuthServiceImpl

Throws:

XWikiException

authenticate

public Principal authenticate(String username,
                              String password,
                              XWikiContext context)
                       throws XWikiException

Specified by:

authenticate in interface XWikiAuthService

Overrides:

authenticate in class XWikiAuthServiceImpl

Returns:

a null Principal Object if the user hasn't been authenticated or a valid Principal Object if the user is correctly authenticated

Throws:

XWikiException