View Javadoc

1   /**
2    * This file Copyright (c) 2003-2014 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.context.MgnlContext;
37  
38  import javax.security.auth.Subject;
39  import javax.security.auth.login.LoginException;
40  
41  
42  /**
43   * The result of a login operation.
44   */
45  public class LoginResult {
46  
47      public static final int STATUS_NO_LOGIN = 0;
48  
49      /**
50       * Returned if a login handler is not able to perform the operation.
51       */
52      public static LoginResult NOT_HANDLED = new LoginResult(LoginResult.STATUS_NOT_HANDLED);
53  
54      /**
55       * Returned if a login handler was able to perform the operation but the authentication failed.
56       */
57      public static LoginResult NO_LOGIN = new LoginResult(STATUS_NO_LOGIN);
58  
59      /**
60       * Request attribute holding the current login exception. Used to render login error messages.
61       */
62      private static final String ATTRIBUTE_LOGINERROR = "mgnlLoginError";
63  
64  
65      private final int status;
66  
67      private LoginException loginException;
68  
69      private Subject subject;
70  
71      public static final int STATUS_IN_PROCESS = 4;
72  
73      public static final int STATUS_NOT_HANDLED = 3;
74  
75      public static final int STATUS_FAILED = 2;
76  
77      public static final int STATUS_SUCCEEDED = 1;
78  
79      public LoginResult(int status) {
80          this.status = status;
81      }
82  
83      public LoginResult(int status, LoginException loginException) {
84          this.status = status;
85          this.loginException = loginException;
86      }
87  
88      public LoginResult(int status, Subject subject) {
89          this.status = status;
90          this.subject = subject;
91      }
92  
93      public int getStatus() {
94          return this.status;
95      }
96  
97      public Subject getSubject() {
98          return this.subject;
99      }
100 
101     /**
102      * @return an instance of {@link LoginException}. Warning: it can be null.
103      */
104     public LoginException getLoginException() {
105         return this.loginException;
106     }
107 
108     /**
109      * Used by the login filter to depose the login result.
110      */
111     public static void setCurrentLoginResult(LoginResult loginResult) {
112         MgnlContext.setAttribute(ATTRIBUTE_LOGINERROR, loginResult);
113     }
114 
115     public static LoginResult getCurrentLoginResult() {
116         LoginResult loginResult =  (LoginResult) MgnlContext.getAttribute(LoginResult.ATTRIBUTE_LOGINERROR);
117         if(loginResult == null){
118             loginResult = NO_LOGIN;
119         }
120         return loginResult;
121     }
122 }