View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *     http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.commons.scxml.env;
18  
19  import java.io.Serializable;
20  import java.util.Iterator;
21  import java.util.Map;
22  import java.util.Set;
23  
24  import org.apache.commons.logging.Log;
25  import org.apache.commons.logging.LogFactory;
26  import org.apache.commons.scxml.ErrorReporter;
27  import org.apache.commons.scxml.model.SCXML;
28  import org.apache.commons.scxml.model.State;
29  import org.apache.commons.scxml.model.TransitionTarget;
30  import org.apache.commons.scxml.semantics.ErrorConstants;
31  
32  /***
33   * Custom error reporter that log execution errors.
34   */
35  public class SimpleErrorReporter implements ErrorReporter, Serializable {
36  
37      /*** Serial version UID. */
38      private static final long serialVersionUID = 1L;
39      /*** Log. */
40      private Log log = LogFactory.getLog(getClass());
41  
42      /***
43       * Constructor.
44       */
45      public SimpleErrorReporter() {
46          super();
47      }
48  
49      /***
50       * @see ErrorReporter#onError(String, String, Object)
51       */
52      public void onError(final String errorCode, final String errDetail,
53              final Object errCtx) {
54          //Note: the if-then-else below is based on the actual usage
55          // (codebase search), it has to be kept up-to-date as the code changes
56          String errCode = errorCode.intern();
57          StringBuffer msg = new StringBuffer();
58          msg.append(errCode).append(" (");
59          msg.append(errDetail).append("): ");
60          if (errCode == ErrorConstants.NO_INITIAL) {
61              if (errCtx instanceof SCXML) {
62                  //determineInitialStates
63                  msg.append("<SCXML>");
64              } else if (errCtx instanceof State) {
65                  //determineInitialStates
66                  //determineTargetStates
67                  msg.append("State " + LogUtils.getTTPath((State) errCtx));
68              }
69          } else if (errCode == ErrorConstants.UNKNOWN_ACTION) {
70              //executeActionList
71              msg.append("Action: " + errCtx.getClass().getName());
72          } else if (errCode == ErrorConstants.ILLEGAL_CONFIG) {
73              //isLegalConfig
74              if (errCtx instanceof Map.Entry) {
75                  TransitionTarget tt = (TransitionTarget)
76                      (((Map.Entry) errCtx).getKey());
77                  Set vals = (Set) (((Map.Entry) errCtx).getValue());
78                  msg.append(LogUtils.getTTPath(tt) + " : [");
79                  for (Iterator i = vals.iterator(); i.hasNext();) {
80                      TransitionTarget tx = (TransitionTarget) i.next();
81                      msg.append(LogUtils.getTTPath(tx));
82                      if (i.hasNext()) {
83                          msg.append(", ");
84                      }
85                  }
86                  msg.append(']');
87              } else if (errCtx instanceof Set) {
88                  Set vals = (Set) errCtx;
89                  msg.append("<SCXML> : [");
90                  for (Iterator i = vals.iterator(); i.hasNext();) {
91                      TransitionTarget tx = (TransitionTarget) i.next();
92                      msg.append(LogUtils.getTTPath(tx));
93                      if (i.hasNext()) {
94                          msg.append(", ");
95                      }
96                  }
97                  msg.append(']');
98              }
99          }
100         if (log.isWarnEnabled()) {
101             log.warn(msg.toString());
102         }
103     }
104 
105 }
106