1 /**
2 * This file Copyright (c) 2003-2010 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 * @author philipp
44 * @version $Id: LoginResult.java 32667 2010-03-13 00:37:06Z gjoseph $
45 */
46 public class LoginResult {
47
48 public static final int STATUS_NO_LOGIN = 0;
49
50 public static LoginResult NOT_HANDLED = new LoginResult(LoginResult.STATUS_NOT_HANDLED);
51
52 public static LoginResult NO_LOGIN = new LoginResult(STATUS_NO_LOGIN);
53
54 /**
55 * request attribute holding the login exception
56 */
57 private static final String ATTRIBUTE_LOGINERROR = "mgnlLoginError";
58
59
60 private int status;
61
62 private User user;
63
64 private LoginException loginException;
65
66 public static final int STATUS_IN_PROCESS = 4;
67
68 public static final int STATUS_NOT_HANDLED = 3;
69
70 public static final int STATUS_FAILED = 2;
71
72 public static final int STATUS_SUCCEEDED = 1;
73
74 public LoginResult(int status) {
75 this.status = status;
76 }
77
78 public LoginResult(int status, LoginException loginException) {
79 this.status = status;
80 this.loginException = loginException;
81 }
82
83 public LoginResult(int status, User user) {
84 this.status = status;
85 this.user = user;
86 }
87
88 public int getStatus() {
89 return this.status;
90 }
91
92 public User getUser() {
93 return this.user;
94 }
95
96 /**
97 * @return an instance of {@link LoginException}. Warning: it can be null.
98 */
99 public LoginException getLoginException() {
100 return this.loginException;
101 }
102
103 /**
104 * Used by the login filter to depose the login result
105 */
106 public static void setCurrentLoginResult(LoginResult loginResult) {
107 MgnlContext.setAttribute(ATTRIBUTE_LOGINERROR, loginResult);
108 }
109
110 public static LoginResult getCurrentLoginResult() {
111 LoginResult loginResult = (LoginResult) MgnlContext.getAttribute(LoginResult.ATTRIBUTE_LOGINERROR);
112 if(loginResult == null){
113 loginResult = NO_LOGIN;
114 }
115 return loginResult;
116 }
117 }