Permalink
Switch branches/tags
xwiki-xmldoc-update-plugin-1.4 xwiki-xmldoc-update-plugin-1.3 xwiki-xmldoc-update-plugin-1.2 xwiki-xmldoc-update-plugin-1.1 xwiki-xmldoc-update-plugin-1.0 xwiki-xar-plugin-1.14 xwiki-xar-plugin-1.13 xwiki-xar-plugin-1.12 xwiki-xar-plugin-1.11 xwiki-xar-plugin-1.10 xwiki-xar-plugin-1.9 xwiki-xar-plugin-1.8 xwiki-xar-handlers-1.9 xwiki-xar-handlers-1.8 xwiki-web-3.0 xwiki-web-3.0-rc-1 xwiki-web-3.0-milestone-3 xwiki-web-3.0-milestone-2 xwiki-web-3.0-milestone-1 xwiki-web-2.7.1 xwiki-web-2.7 xwiki-web-2.7-rc-1 xwiki-web-2.6.2 xwiki-web-2.6.1 xwiki-web-2.6 xwiki-web-2.6-rc-2 xwiki-web-2.6-rc-1 xwiki-web-2.5.2 xwiki-web-2.5.1 xwiki-web-2.5 xwiki-web-2.5-rc-1 xwiki-web-2.5-milestone-2 xwiki-web-2.5-milestone-1 xwiki-web-2.4.4 xwiki-web-2.4.3 xwiki-web-2.4.2 xwiki-web-2.4.1 xwiki-web-2.4 xwiki-web-2.4-rc-1 xwiki-web-2.4-milestone-2 xwiki-web-2.4-milestone-1 xwiki-web-2.3.2 xwiki-web-2.3.1 xwiki-web-2.3 xwiki-web-2.3-rc-1 xwiki-web-2.3-milestone-2 xwiki-web-2.3-milestone-1 xwiki-web-2.2.6 xwiki-web-2.2.5 xwiki-web-2.2.4 xwiki-web-2.2.3 xwiki-web-2.2.2 xwiki-web-2.2.1 xwiki-web-2.2 xwiki-web-2.2-rc-2 xwiki-web-2.2-rc-1 xwiki-web-2.2-milestone-2 xwiki-web-2.2-milestone-1 xwiki-web-2.1.2 xwiki-web-2.1.1 xwiki-web-2.1 xwiki-web-2.1-rc-1 xwiki-web-2.1-milestone-2 xwiki-web-2.1-milestone-1 xwiki-web-2.0.5 xwiki-web-2.0.4 xwiki-web-2.0.3 xwiki-web-2.0.2 xwiki-web-2.0.1 xwiki-web-2.0 xwiki-web-2.0-rc-2 xwiki-web-2.0-rc-1 xwiki-web-2.0-milestone-4 xwiki-web-2.0-milestone-3 xwiki-web-2.0-milestone-2 xwiki-web-2.0-milestone-1 xwiki-web-1.9.4 xwiki-web-1.9.3 xwiki-web-1.9.2 xwiki-web-1.9.1 xwiki-web-1.9 xwiki-web-1.9-rc-1 xwiki-web-1.9-milestone-2 xwiki-web-1.9-milestone-1 xwiki-web-1.8.4 xwiki-web-1.8.3 xwiki-web-1.8.2 xwiki-web-1.8.1 xwiki-web-1.8 xwiki-web-1.8-rc-2 xwiki-web-1.8-rc-1 xwiki-web-1.8-milestone-2 xwiki-web-1.8-milestone-1 xwiki-web-1.7.2 xwiki-web-1.7.1 xwiki-web-1.7 xwiki-web-1.7-rc-1 xwiki-web-1.7-milestone-3 xwiki-web-1.7-milestone-2 xwiki-web-1.7-milestone-1
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
52 lines (45 sloc) 2.02 KB
/*
* See the NOTICE file distributed with this work for additional
* information regarding copyright ownership.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package com.xpn.xwiki.user.api;
import java.security.Principal;
import com.xpn.xwiki.XWikiContext;
import com.xpn.xwiki.XWikiException;
public interface XWikiAuthService
{
XWikiUser checkAuth(XWikiContext context) throws XWikiException;
/**
* Authenticates the user.
*
* @param username the user name for the user to authenticate
* @param password the password of the user to authenticate
* @param context the XWiki context object
* @return null if the user is not authenticated properly or a {@link XWikiUser} object representing the
* authenticated user if successful
* @throws XWikiException in case of authentication error
*/
XWikiUser checkAuth(String username, String password, String rememberme, XWikiContext context)
throws XWikiException;
void showLogin(XWikiContext context) throws XWikiException;
/**
* @return a null Principal Object if the user hasn't been authenticated or a valid Principal Object if the user is
* correctly authenticated
*/
Principal authenticate(String username, String password, XWikiContext context) throws XWikiException;
}