You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@shale.apache.org by cr...@apache.org on 2006/08/29 01:52:24 UTC
svn commit: r437881 - in /shale/sandbox/shale-dialog2-scxml: ./ src/
src/main/ src/main/java/ src/main/java/org/ src/main/java/org/apache/
src/main/java/org/apache/shale/ src/main/java/org/apache/shale/dialog2/
src/main/java/org/apache/shale/dialog2/sc...
Author: craigmcc
Date: Mon Aug 28 16:52:23 2006
New Revision: 437881
URL: http://svn.apache.org/viewvc?rev=437881&view=rev
Log:
Skeleton of support for Jakarta Commons SCXML as a state machine using
the shale-dialog2 abstraction APIs. I got distracted by refactoring the
legacy state machine support so there isn't any meat here yet ... but
that will be the next step.
SHALE-10 SHALE-48 SHALE-61
Added:
shale/sandbox/shale-dialog2-scxml/
shale/sandbox/shale-dialog2-scxml/pom.xml
shale/sandbox/shale-dialog2-scxml/src/
shale/sandbox/shale-dialog2-scxml/src/main/
shale/sandbox/shale-dialog2-scxml/src/main/java/
shale/sandbox/shale-dialog2-scxml/src/main/java/org/
shale/sandbox/shale-dialog2-scxml/src/main/java/org/apache/
shale/sandbox/shale-dialog2-scxml/src/main/java/org/apache/shale/
shale/sandbox/shale-dialog2-scxml/src/main/java/org/apache/shale/dialog2/
shale/sandbox/shale-dialog2-scxml/src/main/java/org/apache/shale/dialog2/scxml/
shale/sandbox/shale-dialog2-scxml/src/main/java/org/apache/shale/dialog2/scxml/ScxmlContext.java
shale/sandbox/shale-dialog2-scxml/src/main/java/org/apache/shale/dialog2/scxml/ScxmlContexts.java
shale/sandbox/shale-dialog2-scxml/src/main/resources/
shale/sandbox/shale-dialog2-scxml/src/main/resources/META-INF/
shale/sandbox/shale-dialog2-scxml/src/main/resources/META-INF/LICENSE.txt
shale/sandbox/shale-dialog2-scxml/src/main/resources/META-INF/NOTICE.txt
shale/sandbox/shale-dialog2-scxml/src/main/resources/META-INF/faces-config.xml
shale/sandbox/shale-dialog2-scxml/src/test/
shale/sandbox/shale-dialog2-scxml/src/test/java/
shale/sandbox/shale-dialog2-scxml/src/test/resources/
Added: shale/sandbox/shale-dialog2-scxml/pom.xml
URL: http://svn.apache.org/viewvc/shale/sandbox/shale-dialog2-scxml/pom.xml?rev=437881&view=auto
==============================================================================
--- shale/sandbox/shale-dialog2-scxml/pom.xml (added)
+++ shale/sandbox/shale-dialog2-scxml/pom.xml Mon Aug 28 16:52:23 2006
@@ -0,0 +1,64 @@
+<!--
+/*
+ * Copyright 2006 The Apache Software Foundation.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * $Id: pom.xml 160258 2006-05-21 01:56:12Z wsmoak $
+ */
+-->
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+ <modelVersion>4.0.0</modelVersion>
+
+ <parent>
+ <groupId>org.apache.shale</groupId>
+ <artifactId>shale-parent</artifactId>
+ <version>1.0.4-SNAPSHOT</version>
+ </parent>
+
+ <artifactId>shale-dialog2-scxml</artifactId>
+ <packaging>jar</packaging>
+ <name>Shale Dialog Manager (SCXML Implementation)</name>
+
+ <dependencies>
+
+ <dependency>
+ <groupId>commons-scxml</groupId>
+ <artifactId>commons-scxml</artifactId>
+ <version>0.5</version>
+ </dependency>
+
+ <dependency>
+ <groupId>junit</groupId>
+ <artifactId>junit</artifactId>
+ <scope>test</scope>
+ </dependency>
+
+<!--
+ <dependency>
+ <groupId>org.apache.shale</groupId>
+ <artifactId>shale-core</artifactId>
+ <version>${pom.version}</version>
+ </dependency>
+-->
+
+ <dependency>
+ <groupId>org.apache.shale</groupId>
+ <artifactId>shale-dialog2</artifactId>
+ <version>${pom.version}</version>
+ </dependency>
+
+ </dependencies>
+
+</project>
Added: shale/sandbox/shale-dialog2-scxml/src/main/java/org/apache/shale/dialog2/scxml/ScxmlContext.java
URL: http://svn.apache.org/viewvc/shale/sandbox/shale-dialog2-scxml/src/main/java/org/apache/shale/dialog2/scxml/ScxmlContext.java?rev=437881&view=auto
==============================================================================
--- shale/sandbox/shale-dialog2-scxml/src/main/java/org/apache/shale/dialog2/scxml/ScxmlContext.java (added)
+++ shale/sandbox/shale-dialog2-scxml/src/main/java/org/apache/shale/dialog2/scxml/ScxmlContext.java Mon Aug 28 16:52:23 2006
@@ -0,0 +1,139 @@
+/*
+ * Copyright 2006 The Apache Software Foundation.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.shale.dialog2.scxml;
+
+import java.io.Serializable;
+import javax.faces.context.FacesContext;
+import org.apache.shale.dialog2.Context;
+import org.apache.shale.dialog2.Contexts;
+
+/**
+ * <p>Implementation of {@link Contexts} for integrating
+ * Commons SCXML into the Shale Dialog Manager.</p>
+ *
+ * @since 1.0.4
+ */
+final class ScxmlContext implements Context, Serializable {
+
+
+ // ------------------------------------------------------------ Constructors
+
+
+ /**
+ * <p>Construct a new instance.</p>
+ *
+ * @param instances {@link IContexts instance that owns us
+ * @param id Dialog identifier assigned to this instance
+ * @param name Logical name of the dialog to be executed
+ */
+ ScxmlContext(Contexts instances, String id, String name) {
+ this.instances = instances;
+ this.id = id;
+ this.name = name;
+ }
+
+
+ // ------------------------------------------------------ Context Variables
+
+
+ /**
+ * <p>Flag indicating that this {@link Context} is currently active.</p>
+ */
+ private boolean active = true;
+
+
+ /**
+ * <p>Generic data object containing state information for this instance.</p>
+ */
+ private Object data = null;
+
+
+ /**
+ * <p>Dialog identifier for this instance.</p>
+ */
+ private String id = null;
+
+
+ /**
+ * <p>{@link Contexts} instance that owns us.</p>
+ */
+ private Contexts instances = null;
+
+
+ /**
+ * <p>Logical name of the dialog to be executed.</p>
+ */
+ private String name = null;
+
+
+ // ----------------------------------------------------- Context Properties
+
+
+ /** {@inheritDoc} */
+ public boolean isActive() {
+ return this.active;
+ }
+
+
+ /** {@inheritDoc} */
+ public Object getData() {
+ return this.data;
+ }
+
+
+
+ /** {@inheritDoc} */
+ public void setData(Object data) {
+ this.data = data;
+ }
+
+
+ /** {@inheritDoc} */
+ public String getId() {
+ return this.id;
+ }
+
+
+ /** {@inheritDoc} */
+ public String getName() {
+ return this.name;
+ }
+
+
+ // -------------------------------------------------------- Context Methods
+
+
+ /** {@inheritDoc} */
+ public String advance(FacesContext context, String outcome) {
+ return null; // FIXME - advance()
+ }
+
+
+ // ------------------------------------------------- Package Private Methods
+
+
+ /**
+ * <p>Mark this {@link Context} as being deactivated. This should only
+ * be called by the <code>remove()</code> method on our associated
+ * {@link Contexts}.</p>
+ */
+ void deactivate() {
+ this.active = false;
+ }
+
+
+}
Added: shale/sandbox/shale-dialog2-scxml/src/main/java/org/apache/shale/dialog2/scxml/ScxmlContexts.java
URL: http://svn.apache.org/viewvc/shale/sandbox/shale-dialog2-scxml/src/main/java/org/apache/shale/dialog2/scxml/ScxmlContexts.java?rev=437881&view=auto
==============================================================================
--- shale/sandbox/shale-dialog2-scxml/src/main/java/org/apache/shale/dialog2/scxml/ScxmlContexts.java (added)
+++ shale/sandbox/shale-dialog2-scxml/src/main/java/org/apache/shale/dialog2/scxml/ScxmlContexts.java Mon Aug 28 16:52:23 2006
@@ -0,0 +1,90 @@
+/*
+ * Copyright 2006 The Apache Software Foundation.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.shale.dialog2.scxml;
+
+import java.io.Serializable;
+import java.util.HashMap;
+import javax.faces.context.FacesContext;
+import org.apache.shale.dialog2.Constants;
+import org.apache.shale.dialog2.Context;
+import org.apache.shale.dialog2.Contexts;
+
+/**
+ * <p>Implementation of {@link Contexts} for integrating
+ * Commons SCXML into the Shale Dialog Manager.</p>
+ *
+ * @since 1.0.4
+ */
+public final class ScxmlContexts implements Contexts, Serializable {
+
+
+ // ------------------------------------------------------ Context Variables
+
+
+ /**
+ * <p>Map containing all currently active {@link Context} instances for
+ * the current user.</p>
+ */
+ private final HashMap map = new HashMap();
+
+
+ /**
+ * <p>Serial number used to generate dialog instance identifiers.</p>
+ */
+ private int serial = 0;
+
+
+ // ------------------------------------------------------- Contexts Methods
+
+
+ /** {@inheritDoc} */
+ public Context create(FacesContext context, String name) {
+ ScxmlContext instance = new ScxmlContext(this, generateId(), name);
+ instance.setData(new HashMap());
+ map.put(instance.getId(), instance);
+ context.getExternalContext().getRequestMap().put(Constants.CONTEXT_BEAN, instance);
+ return instance;
+ }
+
+
+ /** @{inheritDoc} */
+ public Context get(String id) {
+ return (Context) map.get(id);
+ }
+
+
+ /** @{inheritDoc} */
+ public void remove(Context instance) {
+ if (map.remove(instance.getId()) == instance) {
+ ((ScxmlContext) instance).deactivate();
+ }
+ }
+
+
+ // --------------------------------------------------------- Private Methods
+
+
+ /**
+ * <p>Generate and return a new dialog identifier. FIXME - switch to
+ * something that creates randomized identifiers?</p>
+ */
+ private String generateId() {
+ return "" + ++serial;
+ }
+
+
+}
Added: shale/sandbox/shale-dialog2-scxml/src/main/resources/META-INF/LICENSE.txt
URL: http://svn.apache.org/viewvc/shale/sandbox/shale-dialog2-scxml/src/main/resources/META-INF/LICENSE.txt?rev=437881&view=auto
==============================================================================
--- shale/sandbox/shale-dialog2-scxml/src/main/resources/META-INF/LICENSE.txt (added)
+++ shale/sandbox/shale-dialog2-scxml/src/main/resources/META-INF/LICENSE.txt Mon Aug 28 16:52:23 2006
@@ -0,0 +1,202 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
Added: shale/sandbox/shale-dialog2-scxml/src/main/resources/META-INF/NOTICE.txt
URL: http://svn.apache.org/viewvc/shale/sandbox/shale-dialog2-scxml/src/main/resources/META-INF/NOTICE.txt?rev=437881&view=auto
==============================================================================
--- shale/sandbox/shale-dialog2-scxml/src/main/resources/META-INF/NOTICE.txt (added)
+++ shale/sandbox/shale-dialog2-scxml/src/main/resources/META-INF/NOTICE.txt Mon Aug 28 16:52:23 2006
@@ -0,0 +1,6 @@
+This product includes software developed by
+The Apache Software Foundation (http://www.apache.org/).
+
+This product contains code written by David Geary and Cay Horstmann
+for the first edition of Core JavaServer Faces.
+
Added: shale/sandbox/shale-dialog2-scxml/src/main/resources/META-INF/faces-config.xml
URL: http://svn.apache.org/viewvc/shale/sandbox/shale-dialog2-scxml/src/main/resources/META-INF/faces-config.xml?rev=437881&view=auto
==============================================================================
--- shale/sandbox/shale-dialog2-scxml/src/main/resources/META-INF/faces-config.xml (added)
+++ shale/sandbox/shale-dialog2-scxml/src/main/resources/META-INF/faces-config.xml Mon Aug 28 16:52:23 2006
@@ -0,0 +1,36 @@
+<?xml version="1.0"?>
+
+
+<!DOCTYPE faces-config PUBLIC
+ "-//Sun Microsystems, Inc.//DTD JavaServer Faces Config 1.1//EN"
+ "http://java.sun.com/dtd/web-facesconfig_1_1.dtd">
+
+
+<!--
+
+ Copyright 2006 The Apache Software Foundation.
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+-->
+
+
+<faces-config>
+
+ <managed-bean>
+ <managed-bean-name>org.apache.shale.dialog2.INSTANCES</managed-bean-name>
+ <managed-bean-class>org.apache.shale.dialog2.scxml.ScxmlInstances</managed-bean-class>
+ <managed-bean-scope>session</managed-bean-scope>
+ </managed-bean>
+
+</faces-config>