View Javadoc

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.callback;
35  
36  import javax.servlet.http.HttpServletResponse;
37  import javax.servlet.http.HttpServletRequest;
38  import javax.security.auth.login.LoginException;
39  
40  import java.util.HashMap;
41  import java.util.Map;
42  
43  import info.magnolia.freemarker.FreemarkerUtil;
44  import info.magnolia.cms.beans.config.MIMEMapping;
45  import info.magnolia.cms.i18n.MessagesManager;
46  import info.magnolia.cms.i18n.Messages;
47  import info.magnolia.cms.security.auth.login.LoginResult;
48  
49  import org.slf4j.Logger;
50  import org.slf4j.LoggerFactory;
51  import org.apache.commons.lang.ClassUtils;
52  
53  /**
54   * Sends a login form.
55   * @author Sameer Charles
56   * $Id: FormClientCallback.java 36890 2010-09-02 11:38:12Z pbaerfuss $
57   */
58  public class FormClientCallback extends AbstractHttpClientCallback {
59  
60      private static final Logger log = LoggerFactory.getLogger(FormClientCallback.class);
61  
62      public static final String ERROR_STRING = "errorString";
63  
64      private String loginForm;
65  
66      public void doCallback(HttpServletRequest request, HttpServletResponse response) {
67          try {
68              if (!response.isCommitted()) {
69                  response.setContentType("text/html");
70                  if (null == request.getCharacterEncoding()) {
71                      response.setCharacterEncoding(MIMEMapping.getContentEncodingOrDefault("text/html"));
72                  }
73              }
74              FreemarkerUtil.process(getLoginForm(), getMessages(), response.getWriter());
75          }
76          catch (Throwable t) {
77              log.error("exception while writing login template", t);
78          }
79      }
80  
81      public String getLoginForm() {
82          return loginForm;
83      }
84  
85      public void setLoginForm(String loginForm) {
86          this.loginForm = loginForm;
87      }
88  
89      /**
90       * simply sets "errorString" in case of login exception.
91       * override this to pass more objects to the freemarker template.
92       * @return an empty map
93       */
94      protected Map<String, String> getMessages() {
95          LoginResult loginResult = LoginResult.getCurrentLoginResult();
96          LoginException exception = loginResult.getLoginException();
97          Map<String, String> messages = new HashMap<String, String>();
98          if (null != exception) {
99              final String exName = ClassUtils.getShortClassName(exception, null);
100             final Messages mm = MessagesManager.getMessages();
101             final String defaultMessage = mm.get("login.defaultError");
102             messages.put(ERROR_STRING, mm.getWithDefault("login." + exName, defaultMessage));
103         }
104         return messages;
105     }
106 
107 }