001: /*
002: * Licensed to the Apache Software Foundation (ASF) under one or more
003: * contributor license agreements. See the NOTICE file distributed with
004: * this work for additional information regarding copyright ownership.
005: * The ASF licenses this file to You under the Apache License, Version 2.0
006: * (the "License"); you may not use this file except in compliance with
007: * the License. You may obtain a copy of the License at
008: *
009: * http://www.apache.org/licenses/LICENSE-2.0
010: *
011: * Unless required by applicable law or agreed to in writing, software
012: * distributed under the License is distributed on an "AS IS" BASIS,
013: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014: * See the License for the specific language governing permissions and
015: * limitations under the License.
016: */
017: package org.apache.commons.scxml.model;
018:
019: import org.apache.commons.logging.LogFactory;
020: import org.apache.commons.scxml.SCXMLHelper;
021:
022: /**
023: * A custom action is simply a tuple consisting of a namespace URI,
024: * the local name for the custom action and the corresponding
025: * {@link Action} class.
026: *
027: */
028: public class CustomAction {
029:
030: /**
031: * Error logged while attempting to define a custom action
032: * in a null or empty namespace.
033: */
034: private static final String ERR_NO_NAMESPACE = "Cannot define a custom SCXML action with a null or empty namespace";
035:
036: /**
037: * The SCXML namespace, to which custom actions may not be added.
038: */
039: private static final String NAMESPACE_SCXML = "http://www.w3.org/2005/07/scxml";
040:
041: /**
042: * Error logged while attempting to define a custom action
043: * with the SCXML namespace.
044: */
045: private static final String ERR_RESERVED_NAMESPACE = "Cannot define a custom SCXML action within the SCXML namespace '"
046: + NAMESPACE_SCXML + "'";
047:
048: /**
049: * Error logged while attempting to define a custom action
050: * in a null or empty local name.
051: */
052: private static final String ERR_NO_LOCAL_NAME = "Cannot define a custom SCXML action with a null or empty local name";
053:
054: /**
055: * Error logged while attempting to define a custom action
056: * which does not extend {@link Action}.
057: */
058: private static final String ERR_NOT_AN_ACTION = "Custom SCXML action does not extend Action superclass";
059:
060: /**
061: * The namespace this custom action belongs to.
062: */
063: private String namespaceURI;
064:
065: /**
066: * The local name of the custom action.
067: */
068: private String localName;
069:
070: /**
071: * The implementation of this custom action.
072: */
073: private Class actionClass;
074:
075: /**
076: * The log for this custom action.
077: */
078: private org.apache.commons.logging.Log log;
079:
080: /**
081: * Constructor, if the namespace or local name is null or empty,
082: * or if the implementation is not an {@link Action}, an
083: * {@link IllegalArgumentException} is thrown.
084: *
085: * @param namespaceURI The namespace URI for this custom action.
086: * @param localName The local name for this custom action.
087: * @param actionClass The {@link Action} subclass implementing this
088: * custom action.
089: */
090: public CustomAction(final String namespaceURI,
091: final String localName, final Class actionClass) {
092: this .log = LogFactory.getLog(CustomAction.class);
093: if (SCXMLHelper.isStringEmpty(namespaceURI)) {
094: log.error(ERR_NO_NAMESPACE);
095: throw new IllegalArgumentException(ERR_NO_NAMESPACE);
096: }
097: if (namespaceURI.trim().equalsIgnoreCase(NAMESPACE_SCXML)) {
098: log.error(ERR_RESERVED_NAMESPACE);
099: throw new IllegalArgumentException(ERR_RESERVED_NAMESPACE);
100: }
101: if (SCXMLHelper.isStringEmpty(localName)) {
102: log.error(ERR_NO_LOCAL_NAME);
103: throw new IllegalArgumentException(ERR_NO_LOCAL_NAME);
104: }
105: if (actionClass == null
106: || !Action.class.isAssignableFrom(actionClass)) {
107: log.error(ERR_NOT_AN_ACTION);
108: throw new IllegalArgumentException(ERR_NOT_AN_ACTION);
109: }
110: this .namespaceURI = namespaceURI;
111: this .localName = localName;
112: this .actionClass = actionClass;
113: }
114:
115: /**
116: * Get this custom action's implementation.
117: *
118: * @return Returns the action class.
119: */
120: public Class getActionClass() {
121: return actionClass;
122: }
123:
124: /**
125: * Get the local name for this custom action.
126: *
127: * @return Returns the local name.
128: */
129: public String getLocalName() {
130: return localName;
131: }
132:
133: /**
134: * Get the namespace URI for this custom action.
135: *
136: * @return Returns the namespace URI.
137: */
138: public String getNamespaceURI() {
139: return namespaceURI;
140: }
141:
142: }
|