1 /**
2 * This file Copyright (c) 2003-2011 Magnolia International
3 * Ltd. (http://www.magnolia-cms.com). All rights reserved.
4 *
5 *
6 * This file is dual-licensed under both the Magnolia
7 * Network Agreement and the GNU General Public License.
8 * You may elect to use one or the other of these licenses.
9 *
10 * This file is distributed in the hope that it will be
11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12 * implied warranty of MERCHANTABILITY or FITNESS FOR A
13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14 * Redistribution, except as permitted by whichever of the GPL
15 * or MNA you select, is prohibited.
16 *
17 * 1. For the GPL license (GPL), you can redistribute and/or
18 * modify this file under the terms of the GNU General
19 * Public License, Version 3, as published by the Free Software
20 * Foundation. You should have received a copy of the GNU
21 * General Public License, Version 3 along with this program;
22 * if not, write to the Free Software Foundation, Inc., 51
23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24 *
25 * 2. For the Magnolia Network Agreement (MNA), this file
26 * and the accompanying materials are made available under the
27 * terms of the MNA which accompanies this distribution, and
28 * is available at http://www.magnolia-cms.com/mna.html
29 *
30 * Any modifications to this file must keep this entire header
31 * intact.
32 *
33 */
34 package info.magnolia.cms.security.auth.login;
35
36 import info.magnolia.cms.security.User;
37 import info.magnolia.context.MgnlContext;
38
39 import javax.security.auth.login.LoginException;
40
41
42 /**
43 * The result of a login operation.
44 * @version $Id: LoginResult.java 41137 2011-01-06 18:19:25Z gjoseph $
45 */
46 public class LoginResult {
47
48 public static final int STATUS_NO_LOGIN = 0;
49
50 /**
51 * Returned if a login handler is not able to perform the operation.
52 */
53 public static LoginResult NOT_HANDLED = new LoginResult(LoginResult.STATUS_NOT_HANDLED);
54
55 /**
56 * Returned if a login handler was able to perform the operation but the authentication failed.
57 */
58 public static LoginResult NO_LOGIN = new LoginResult(STATUS_NO_LOGIN);
59
60 /**
61 * Request attribute holding the current login exception. Used to render login error messages.
62 */
63 private static final String ATTRIBUTE_LOGINERROR = "mgnlLoginError";
64
65
66 private int status;
67
68 private User user;
69
70 private LoginException loginException;
71
72 public static final int STATUS_IN_PROCESS = 4;
73
74 public static final int STATUS_NOT_HANDLED = 3;
75
76 public static final int STATUS_FAILED = 2;
77
78 public static final int STATUS_SUCCEEDED = 1;
79
80 public LoginResult(int status) {
81 this.status = status;
82 }
83
84 public LoginResult(int status, LoginException loginException) {
85 this.status = status;
86 this.loginException = loginException;
87 }
88
89 public LoginResult(int status, User user) {
90 this.status = status;
91 this.user = user;
92 }
93
94 public int getStatus() {
95 return this.status;
96 }
97
98 public User getUser() {
99 return this.user;
100 }
101
102 /**
103 * @return an instance of {@link LoginException}. Warning: it can be null.
104 */
105 public LoginException getLoginException() {
106 return this.loginException;
107 }
108
109 /**
110 * Used by the login filter to depose the login result.
111 */
112 public static void setCurrentLoginResult(LoginResult loginResult) {
113 MgnlContext.setAttribute(ATTRIBUTE_LOGINERROR, loginResult);
114 }
115
116 public static LoginResult getCurrentLoginResult() {
117 LoginResult loginResult = (LoginResult) MgnlContext.getAttribute(LoginResult.ATTRIBUTE_LOGINERROR);
118 if(loginResult == null){
119 loginResult = NO_LOGIN;
120 }
121 return loginResult;
122 }
123 }