-
-
Notifications
You must be signed in to change notification settings - Fork 542
/
XWikiAuthService.java
51 lines (45 loc) · 2.02 KB
/
XWikiAuthService.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
/*
* 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;
}