1. Project Clover database Sat Feb 2 2019 06:45:20 CET
  2. Package com.xpn.xwiki.user.api

File XWikiAuthService.java

 

Code metrics

0
0
0
1
51
12
0
-
-
0
-

Classes

Class Line # Actions
XWikiAuthService 27 0 - 0 0
-1.0 -
 

Contributing tests

No tests hitting this source file were found.

Source view

1    /*
2    * See the NOTICE file distributed with this work for additional
3    * information regarding copyright ownership.
4    *
5    * This is free software; you can redistribute it and/or modify it
6    * under the terms of the GNU Lesser General Public License as
7    * published by the Free Software Foundation; either version 2.1 of
8    * the License, or (at your option) any later version.
9    *
10    * This software is distributed in the hope that it will be useful,
11    * but WITHOUT ANY WARRANTY; without even the implied warranty of
12    * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13    * Lesser General Public License for more details.
14    *
15    * You should have received a copy of the GNU Lesser General Public
16    * License along with this software; if not, write to the Free
17    * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
18    * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
19    */
20    package com.xpn.xwiki.user.api;
21   
22    import java.security.Principal;
23   
24    import com.xpn.xwiki.XWikiContext;
25    import com.xpn.xwiki.XWikiException;
26   
 
27    public interface XWikiAuthService
28    {
29    XWikiUser checkAuth(XWikiContext context) throws XWikiException;
30   
31    /**
32    * Authenticates the user.
33    *
34    * @param username the user name for the user to authenticate
35    * @param password the password of the user to authenticate
36    * @param context the XWiki context object
37    * @return null if the user is not authenticated properly or a {@link XWikiUser} object representing the
38    * authenticated user if successful
39    * @throws XWikiException in case of authentication error
40    */
41    XWikiUser checkAuth(String username, String password, String rememberme, XWikiContext context)
42    throws XWikiException;
43   
44    void showLogin(XWikiContext context) throws XWikiException;
45   
46    /**
47    * @return a null Principal Object if the user hasn't been authenticated or a valid Principal Object if the user is
48    * correctly authenticated
49    */
50    Principal authenticate(String username, String password, XWikiContext context) throws XWikiException;
51    }