1 /*
2 * $Id$
3 *
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21 package org.apache.struts.chain.commands;
22
23 import org.apache.struts.chain.contexts.ActionContext;
24 import org.slf4j.Logger;
25 import org.slf4j.LoggerFactory;
26
27 /**
28 * Simple abstract class which logs the {@code ActionCommand}-class when
29 * executed.
30 */
31 public abstract class ActionCommandBase implements ActionCommand {
32
33 /**
34 * The {@code Log} instance for this class.
35 */
36 private final Logger log =
37 LoggerFactory.getLogger(ActionCommandBase.class);
38
39 /**
40 * Logs and executes the command.
41 *
42 * @param actionContext The {@code Context} for the current request
43 *
44 * @return TRUE if processing should halt
45 *
46 * @throws Exception On any error
47 */
48 @Override
49 public final boolean execute(ActionContext actionContext) throws Exception {
50 log.debug("Executing {}", getClass().getName());
51 return execute_(actionContext);
52 }
53
54 /**
55 * Executes the command.
56 *
57 * @param actionContext The {@code Context} for the current request
58 *
59 * @return TRUE if processing should halt
60 *
61 * @throws Exception On any error
62 */
63 protected abstract boolean execute_(ActionContext actionContext)
64 throws Exception;
65 }