com.xpn.xwiki.user.api
Interface XWikiAuthService

All Known Implementing Classes:
AbstractXWikiAuthService, AppServerTrustedAuthServiceImpl, AppServerTrustedKerberosAuthServiceImpl, GroovyAuthServiceImpl, XWikiAuthServiceImpl, XWikiLDAPAuthServiceImpl

public interface XWikiAuthService


Method Summary
 Principal authenticate(String username, String password, XWikiContext context)
           
 XWikiUser checkAuth(String username, String password, String rememberme, XWikiContext context)
          Authenticates the user.
 XWikiUser checkAuth(XWikiContext context)
           
 void showLogin(XWikiContext context)
           
 

Method Detail

checkAuth

XWikiUser checkAuth(XWikiContext context)
                    throws XWikiException
Throws:
XWikiException

checkAuth

XWikiUser checkAuth(String username,
                    String password,
                    String rememberme,
                    XWikiContext context)
                    throws XWikiException
Authenticates the user.

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 or a XWikiUser object representing the authenticated user if successful
Throws:
XWikiException - in case of authentication error

showLogin

void showLogin(XWikiContext context)
               throws XWikiException
Throws:
XWikiException

authenticate

Principal authenticate(String username,
                       String password,
                       XWikiContext context)
                       throws XWikiException
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


Copyright © 2004–2014 XWiki. All rights reserved.