View Javadoc

1   /**
2    * This file Copyright (c) 2008-2013 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.commands.impl;
35  
36  import java.util.Date;
37  
38  import info.magnolia.commands.MgnlCommand;
39  import info.magnolia.context.Context;
40  
41  import org.apache.commons.lang.StringUtils;
42  import org.slf4j.Logger;
43  import org.slf4j.LoggerFactory;
44  
45  /**
46   * Command outputting the value of "message" property into current log file. Used to monitor execution of workflow or other sorts of command chains.
47   */
48  public class LogCommand extends MgnlCommand {
49  
50      private String msg;
51  
52      private String log = LogCommand.class.getName();
53  
54      @Override
55      public boolean execute(Context ctx) throws Exception {
56          getLogger().info(getMsg());
57          return true;
58      }
59  
60      public String getMsg() {
61          if(StringUtils.isEmpty(msg)){
62              return new Date().toString();
63          }
64          return this.msg;
65      }
66  
67      public void setMsg(String msg) {
68          this.msg = msg;
69      }
70  
71      public String getLog() {
72          return this.log;
73      }
74  
75      public void setLog(String log) {
76          this.log = log;
77      }
78  
79      protected Logger getLogger() {
80          return LoggerFactory.getLogger(getLog());
81      }
82  
83      @Override
84      public void release() {
85          super.release();
86          log = LogCommand.class.getName();
87          msg = null;
88      }
89  }