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.scxml2;
18
19 /**
20 * The SCXML I/O Processor provides the interface for either an internal process or an external system or invoked child
21 * SCXML process ({@link org.apache.commons.scxml2.invoke.Invoker}) to send events into the SCXML processor queue.
22 */
23 public interface SCXMLIOProcessor {
24
25 /**
26 * The name of the default SCXML I/O Event Processor
27 */
28 String DEFAULT_EVENT_PROCESSOR = "http://www.w3.org/TR/scxml/#SCXMLEventProcessor";
29
30 /**
31 * Prefix for SCXML I/O Event Processor aliases
32 */
33 String EVENT_PROCESSOR_ALIAS_PREFIX = "#_";
34
35 /**
36 * Default SCXML I/O Event Processor alias
37 */
38 String SCXML_EVENT_PROCESSOR = "scxml";
39
40 /**
41 * Prefix for SCXML I/O (own) Session external Event processor
42 */
43 String SCXML_SESSION_EVENT_PROCESSOR_PREFIX = EVENT_PROCESSOR_ALIAS_PREFIX + "scxml_";
44
45 /**
46 * The name of the internal Event Processor
47 */
48 String INTERNAL_EVENT_PROCESSOR = EVENT_PROCESSOR_ALIAS_PREFIX + "internal";
49
50 /**
51 * The name of the parent Event Processor
52 */
53 String PARENT_EVENT_PROCESSOR = EVENT_PROCESSOR_ALIAS_PREFIX + "parent";
54
55 /**
56 * Send an event into the SCXML processor queue
57 * <p>
58 * @param event the event to send
59 */
60 void addEvent(TriggerEvent event);
61 }