diff options
Diffstat (limited to 'sca-java-1.x/branches/sca-java-0.91/modules/binding-ajax')
11 files changed, 1069 insertions, 0 deletions
diff --git a/sca-java-1.x/branches/sca-java-0.91/modules/binding-ajax/DISCLAIMER b/sca-java-1.x/branches/sca-java-0.91/modules/binding-ajax/DISCLAIMER new file mode 100644 index 0000000000..d68a410903 --- /dev/null +++ b/sca-java-1.x/branches/sca-java-0.91/modules/binding-ajax/DISCLAIMER @@ -0,0 +1,8 @@ +Apache Tuscany is an effort undergoing incubation at The Apache Software
+Foundation (ASF), sponsored by the Apache Web Services PMC. Incubation is
+required of all newly accepted projects until a further review indicates that
+the infrastructure, communications, and decision making process have stabilized
+in a manner consistent with other successful ASF projects. While incubation
+status is not necessarily a reflection of the completeness or stability of the
+code, it does indicate that the project has yet to be fully endorsed by the ASF.
+
diff --git a/sca-java-1.x/branches/sca-java-0.91/modules/binding-ajax/LICENSE b/sca-java-1.x/branches/sca-java-0.91/modules/binding-ajax/LICENSE new file mode 100644 index 0000000000..8aa906c321 --- /dev/null +++ b/sca-java-1.x/branches/sca-java-0.91/modules/binding-ajax/LICENSE @@ -0,0 +1,205 @@ + + 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. + + + diff --git a/sca-java-1.x/branches/sca-java-0.91/modules/binding-ajax/NOTICE b/sca-java-1.x/branches/sca-java-0.91/modules/binding-ajax/NOTICE new file mode 100644 index 0000000000..94481d6cfa --- /dev/null +++ b/sca-java-1.x/branches/sca-java-0.91/modules/binding-ajax/NOTICE @@ -0,0 +1,6 @@ +${pom.name} +Copyright (c) 2005 - 2007 The Apache Software Foundation + +This product includes software developed by +The Apache Software Foundation (http://www.apache.org/). + diff --git a/sca-java-1.x/branches/sca-java-0.91/modules/binding-ajax/pom.xml b/sca-java-1.x/branches/sca-java-0.91/modules/binding-ajax/pom.xml new file mode 100644 index 0000000000..87c6f7f8da --- /dev/null +++ b/sca-java-1.x/branches/sca-java-0.91/modules/binding-ajax/pom.xml @@ -0,0 +1,76 @@ +<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you 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.
+-->
+<project>
+
+ <modelVersion>4.0.0</modelVersion>
+ <parent>
+ <groupId>org.apache.tuscany.sca</groupId>
+ <artifactId>tuscany-modules</artifactId>
+ <version>0.91-incubating-SNAPSHOT</version>
+ <relativePath>../pom.xml</relativePath>
+ </parent>
+
+ <artifactId>tuscany-binding-ajax</artifactId>
+ <name>Apache Tuscany Binding for AJAX clients</name>
+
+ <dependencies>
+
+ <dependency>
+ <groupId>org.apache.tuscany.sca</groupId>
+ <artifactId>tuscany-extension-helper</artifactId>
+ <version>0.91-incubating-SNAPSHOT</version>
+ </dependency>
+
+ <dependency>
+ <groupId>org.apache.tuscany.sca</groupId>
+ <artifactId>tuscany-host-http</artifactId>
+ <version>0.91-incubating-SNAPSHOT</version>
+ </dependency>
+
+ <dependency>
+ <groupId>org.directwebremoting</groupId>
+ <artifactId>dwr</artifactId>
+ <version>2.0.1</version>
+ </dependency>
+
+ <dependency>
+ <groupId>javax.servlet</groupId>
+ <artifactId>servlet-api</artifactId>
+ <version>2.4</version> <!-- to keep compatible with older servlet containers -->
+ <scope>provided</scope>
+ </dependency>
+
+ <dependency>
+ <groupId>junit</groupId>
+ <artifactId>junit</artifactId>
+ <version>3.8.1</version>
+ <scope>test</scope>
+ </dependency>
+
+ <dependency>
+ <groupId>org.easymock</groupId>
+ <artifactId>easymock</artifactId>
+ <version>2.2</version>
+ <scope>test</scope>
+ </dependency>
+
+ </dependencies>
+
+</project>
diff --git a/sca-java-1.x/branches/sca-java-0.91/modules/binding-ajax/src/main/java/org/apache/tuscany/sca/binding/ajax/AjaxBinding.java b/sca-java-1.x/branches/sca-java-0.91/modules/binding-ajax/src/main/java/org/apache/tuscany/sca/binding/ajax/AjaxBinding.java new file mode 100644 index 0000000000..9e244e5e5a --- /dev/null +++ b/sca-java-1.x/branches/sca-java-0.91/modules/binding-ajax/src/main/java/org/apache/tuscany/sca/binding/ajax/AjaxBinding.java @@ -0,0 +1,32 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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.tuscany.sca.binding.ajax; + + + + +/** + * The runtime representation of the <binding.ajax> SCDL + */ +public class AjaxBinding { + + // Empty as <binding.ajax> doesn't use any additional attributes or elements (yet). + +} diff --git a/sca-java-1.x/branches/sca-java-0.91/modules/binding-ajax/src/main/java/org/apache/tuscany/sca/binding/ajax/AjaxBindingActivator.java b/sca-java-1.x/branches/sca-java-0.91/modules/binding-ajax/src/main/java/org/apache/tuscany/sca/binding/ajax/AjaxBindingActivator.java new file mode 100644 index 0000000000..5483473961 --- /dev/null +++ b/sca-java-1.x/branches/sca-java-0.91/modules/binding-ajax/src/main/java/org/apache/tuscany/sca/binding/ajax/AjaxBindingActivator.java @@ -0,0 +1,56 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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.tuscany.sca.binding.ajax; + +import org.apache.tuscany.sca.assembly.Binding; +import org.apache.tuscany.sca.http.ServletHost; +import org.apache.tuscany.sca.runtime.RuntimeComponent; +import org.apache.tuscany.sca.runtime.RuntimeComponentReference; +import org.apache.tuscany.sca.runtime.RuntimeComponentService; +import org.apache.tuscany.sca.spi.BindingActivator; +import org.apache.tuscany.sca.spi.ComponentLifecycle; +import org.apache.tuscany.sca.spi.InvokerFactory; + +public class AjaxBindingActivator implements BindingActivator<AjaxBinding>{ + + private ServletHost servletHost; + + public AjaxBindingActivator(ServletHost servletHost) { + this.servletHost = servletHost; + } + + public Class<AjaxBinding> getBindingClass() { + return AjaxBinding.class; + } + + public InvokerFactory createInvokerFactory(RuntimeComponent rc, RuntimeComponentReference rcr, Binding b, AjaxBinding ab) { + return new AjaxInvokerFactory(rc, rcr, b, ab, servletHost); + } + + public ComponentLifecycle createService(RuntimeComponent rc, RuntimeComponentService rcs, Binding b, AjaxBinding ab) { + return new AjaxService(rc, rcs, b, ab, servletHost); + } + + public InvokerFactory createInvokerFactory(RuntimeComponent rc, RuntimeComponentReference rcr, AjaxBinding binding) { + // TODO Auto-generated method stub + return null; + } + +} diff --git a/sca-java-1.x/branches/sca-java-0.91/modules/binding-ajax/src/main/java/org/apache/tuscany/sca/binding/ajax/AjaxInvoker.java b/sca-java-1.x/branches/sca-java-0.91/modules/binding-ajax/src/main/java/org/apache/tuscany/sca/binding/ajax/AjaxInvoker.java new file mode 100644 index 0000000000..c05ae7ab09 --- /dev/null +++ b/sca-java-1.x/branches/sca-java-0.91/modules/binding-ajax/src/main/java/org/apache/tuscany/sca/binding/ajax/AjaxInvoker.java @@ -0,0 +1,88 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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.tuscany.sca.binding.ajax; + +import java.util.Collection; + +import org.apache.tuscany.sca.core.invocation.MessageImpl; +import org.apache.tuscany.sca.interfacedef.Operation; +import org.apache.tuscany.sca.invocation.Invoker; +import org.apache.tuscany.sca.invocation.Message; +import org.directwebremoting.ScriptBuffer; +import org.directwebremoting.WebContext; +import org.directwebremoting.WebContextFactory; +import org.directwebremoting.proxy.dwr.Util; + +public class AjaxInvoker implements Invoker { + + protected String referenceFunction; + + public AjaxInvoker(String referenceName, Operation operation) { + this.referenceFunction = referenceName + "." + operation.getName(); + } + + public Message invoke(Message requestMsg) { + + invoke((Object[])requestMsg.getBody()); + + // Ajax references can not return anything + return new MessageImpl(); + } + + public void invoke(Object[] args) { + + // TODO: this only works if its the same thread as request + WebContext wctx = WebContextFactory.get(); + String currentPage = wctx.getCurrentPage(); + + // Get a DWR Util proxy for all the browsers on the current page: + Collection sessions = wctx.getScriptSessionsByPage(currentPage); + Util utilAll = new Util(sessions); + + ScriptBuffer referenceInvoke = getInvokeFragment(args, wctx); + + // add the reference call to the Util proxy which will cause DWR to + // asynchronously send it to be run on each active browser client + utilAll.addScript(referenceInvoke); + } + + /** + * Creates a fragment of JavaScript code to invoke the reference function + * Eg: "<referenceName>.<operationName>(arg1, arg2,...);" + */ + protected ScriptBuffer getInvokeFragment(Object[] args, WebContext wctx) { + + ScriptBuffer sb = new ScriptBuffer(); + sb.appendScript(referenceFunction); + sb.appendScript("("); + if (args != null) { + for (int i = 0; i < args.length; i++) { + sb.appendData(args[i]); + if (i < (args.length - 1)) { + sb.appendScript(", "); + } + } + } + sb.appendScript(");"); + + return sb; + } + +} diff --git a/sca-java-1.x/branches/sca-java-0.91/modules/binding-ajax/src/main/java/org/apache/tuscany/sca/binding/ajax/AjaxInvokerFactory.java b/sca-java-1.x/branches/sca-java-0.91/modules/binding-ajax/src/main/java/org/apache/tuscany/sca/binding/ajax/AjaxInvokerFactory.java new file mode 100644 index 0000000000..a1493c5e7f --- /dev/null +++ b/sca-java-1.x/branches/sca-java-0.91/modules/binding-ajax/src/main/java/org/apache/tuscany/sca/binding/ajax/AjaxInvokerFactory.java @@ -0,0 +1,69 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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.tuscany.sca.binding.ajax; + +import static org.apache.tuscany.sca.binding.ajax.AjaxService.SERVLET_PATH; + +import org.apache.tuscany.sca.assembly.Binding; +import org.apache.tuscany.sca.http.ServletHost; +import org.apache.tuscany.sca.interfacedef.Operation; +import org.apache.tuscany.sca.invocation.Invoker; +import org.apache.tuscany.sca.runtime.RuntimeComponent; +import org.apache.tuscany.sca.runtime.RuntimeComponentReference; +import org.apache.tuscany.sca.spi.ComponentLifecycle; +import org.apache.tuscany.sca.spi.InvokerFactory; + +public class AjaxInvokerFactory implements InvokerFactory, ComponentLifecycle { + + protected RuntimeComponent runtimeComponent; + protected RuntimeComponentReference runtimeComponentReference; + protected Binding binding; + protected ServletHost servletHost; + + public AjaxInvokerFactory(RuntimeComponent rc, RuntimeComponentReference rcr, Binding b, AjaxBinding ab, ServletHost servletHost) { + this.runtimeComponent = rc; + this.runtimeComponentReference = rcr; + this.binding = b; + this.servletHost = servletHost; + } + + public Invoker createInvoker(Operation operation) { + return new AjaxInvoker(binding.getName(), operation); + } + + public void start() { + + // there is no "getServlet" method on ServletHost so this has to use remove/add + + AjaxServlet servlet = (AjaxServlet) servletHost.removeServletMapping(SERVLET_PATH); + if (servlet == null) { + servlet = new AjaxServlet(); + } + + servlet.addReference(binding.getName()); + + servletHost.addServletMapping(SERVLET_PATH, servlet); + } + + public void stop() { + servletHost.removeServletMapping(SERVLET_PATH); + } + +} diff --git a/sca-java-1.x/branches/sca-java-0.91/modules/binding-ajax/src/main/java/org/apache/tuscany/sca/binding/ajax/AjaxService.java b/sca-java-1.x/branches/sca-java-0.91/modules/binding-ajax/src/main/java/org/apache/tuscany/sca/binding/ajax/AjaxService.java new file mode 100644 index 0000000000..3a6f327dd6 --- /dev/null +++ b/sca-java-1.x/branches/sca-java-0.91/modules/binding-ajax/src/main/java/org/apache/tuscany/sca/binding/ajax/AjaxService.java @@ -0,0 +1,66 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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.tuscany.sca.binding.ajax; + +import org.apache.tuscany.sca.assembly.Binding; +import org.apache.tuscany.sca.http.ServletHost; +import org.apache.tuscany.sca.interfacedef.java.JavaInterface; +import org.apache.tuscany.sca.runtime.RuntimeComponent; +import org.apache.tuscany.sca.runtime.RuntimeComponentService; +import org.apache.tuscany.sca.spi.ComponentLifecycle; + +public class AjaxService implements ComponentLifecycle { + + RuntimeComponent rc; + RuntimeComponentService rcs; + Binding binding; + protected ServletHost servletHost; + + public static final String SERVLET_PATH = AjaxServlet.AJAX_SERVLET_PATH + "/*"; + + public AjaxService(RuntimeComponent rc, RuntimeComponentService rcs, Binding binding, AjaxBinding ab, ServletHost servletHost) { + this.rc = rc; + this.rcs = rcs; + this.binding = binding; + this.servletHost = servletHost; + } + + public void start() { + + // there is no "getServlet" method on ServletHost so this has to use remove/add + + AjaxServlet servlet = (AjaxServlet) servletHost.removeServletMapping(SERVLET_PATH); + if (servlet == null) { + servlet = new AjaxServlet(); + } + + Class<?> type = ((JavaInterface)rcs.getInterfaceContract().getInterface()).getJavaClass(); + Object instance = rc.createSelfReference(type).getService(); + + servlet.addService(binding.getName(), type, instance); + + servletHost.addServletMapping(SERVLET_PATH, servlet); + } + + public void stop() { + servletHost.removeServletMapping(SERVLET_PATH); + } + +} diff --git a/sca-java-1.x/branches/sca-java-0.91/modules/binding-ajax/src/main/java/org/apache/tuscany/sca/binding/ajax/AjaxServlet.java b/sca-java-1.x/branches/sca-java-0.91/modules/binding-ajax/src/main/java/org/apache/tuscany/sca/binding/ajax/AjaxServlet.java new file mode 100644 index 0000000000..c4209bfbf7 --- /dev/null +++ b/sca-java-1.x/branches/sca-java-0.91/modules/binding-ajax/src/main/java/org/apache/tuscany/sca/binding/ajax/AjaxServlet.java @@ -0,0 +1,444 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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.tuscany.sca.binding.ajax; + +import java.io.BufferedReader; +import java.io.IOException; +import java.io.PrintWriter; +import java.io.UnsupportedEncodingException; +import java.security.Principal; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Collection; +import java.util.Collections; +import java.util.Enumeration; +import java.util.HashMap; +import java.util.List; +import java.util.Locale; +import java.util.Map; + +import javax.servlet.RequestDispatcher; +import javax.servlet.ServletConfig; +import javax.servlet.ServletContext; +import javax.servlet.ServletException; +import javax.servlet.ServletInputStream; +import javax.servlet.ServletRequest; +import javax.servlet.ServletResponse; +import javax.servlet.http.Cookie; +import javax.servlet.http.HttpServletRequest; +import javax.servlet.http.HttpServletResponse; +import javax.servlet.http.HttpSession; + +import org.directwebremoting.Container; +import org.directwebremoting.create.AbstractCreator; +import org.directwebremoting.extend.CreatorManager; +import org.directwebremoting.extend.Handler; +import org.directwebremoting.extend.Remoter; +import org.directwebremoting.servlet.DwrServlet; +import org.directwebremoting.servlet.EngineHandler; +import org.directwebremoting.servlet.PathConstants; +import org.directwebremoting.servlet.UrlProcessor; + +/** + * Tuscany customized DWR Servlet to implement support for the Ajax binding + * + * Handles requests for SCA services and references that use <binding.ajax>, + * and also the HTTP GET for the Tuscany ajax system script "scaDomain.js" + */ +public class AjaxServlet extends DwrServlet { + private static final long serialVersionUID = 1L; + + transient protected Map<String, ServiceHolder> services; + transient protected List<String> referenceNames; + transient protected boolean initialized; + transient protected Map<String, String> initParams; + + protected static final String SCADOMAIN_SCRIPT_PATH = "/scaDomain.js"; + public static final String AJAX_SERVLET_PATH = "/SCADomain"; + + public AjaxServlet() { + this.services = new HashMap<String, ServiceHolder>(); + this.referenceNames = new ArrayList<String>(); + + this.initParams = new HashMap<String, String>(); + // maybe use <binding.ajax> attributes to define the init params + initParams.put("activeReverseAjaxEnabled", "true"); + } + + @Override + public void service(ServletRequest req, ServletResponse res) throws ServletException, IOException { + super.service(patchRequest((HttpServletRequest)req), res); + } + + /** + * Initialize the servlet + * There is a single instance of this servlet which is registered + * for multiple path mappings, but the init should only run once. + */ + @Override + public void init(ServletConfig servletConfig) throws ServletException { + if (!initialized) { + super.init(patchConfig(servletConfig)); + addScriptHandler(); + initServices(); + initialized = true; + } + } + + /** + * Add in the handler to process the http get for /sca/scaDomain.js + * + * This wrappers the DWR Engine handler which returns the DWR engine.js script, + * this wrappers that handler so as to add Tuscany specific header and footer code + * to the DWR engine.js to define the Tuscany SCADomain control functions and + * functions for each SCA service and reference that use <binding.dwr>. + */ + protected void addScriptHandler() { + + UrlProcessor urlProcessor = (UrlProcessor)getContainer().getBean(UrlProcessor.class.getName()); + + final EngineHandler engineHandler = + (EngineHandler)getContainer().getBean(PathConstants.URL_PREFIX + "/engine.js"); + + final Handler scaDomainScriptHandler = new Handler() { + public void handle(HttpServletRequest request, HttpServletResponse response) throws IOException { + PrintWriter out = response.getWriter(); + out.println("/** Apache Tuscany scaDomain.js Header */"); + + engineHandler.handle(request, response); + + tuscanyFooter(request, out); + } + + }; + + // add the scaDomainScriptHandler to the urlProcessor + // bit of a hack, there's probably cleaner way to get it registered + urlProcessor.afterContainerSetup(new Container() { + public Object getBean(String name) { + return scaDomainScriptHandler; + } + public Collection getBeanNames() { + return Arrays.asList(new String[] {PathConstants.URL_PREFIX + SCADOMAIN_SCRIPT_PATH}); + } + }); + } + + /** + * Adds the JavaScript defining SCADomain, its control functions, + * and functions for all the available SCA services and references. + */ + protected void tuscanyFooter(HttpServletRequest request, PrintWriter out) { + out.println("/** Apache Tuscany scaDomain.js Footer */"); + out.println(); + out.println("function scaDomain() { }"); + out.println(); + + // Alter the value of these variables in DWR engine.js to add in this servlet's path + out.println("dwr.engine._ModePlainCall = '" + AJAX_SERVLET_PATH + "/call/plaincall/';"); + out.println("dwr.engine._ModeHtmlCall = '" + AJAX_SERVLET_PATH + "/call/htmlcall/';"); + out.println("dwr.engine._ModePlainPoll = '" + AJAX_SERVLET_PATH + "/call/plainpoll/';"); + out.println("dwr.engine._ModeHtmlPoll = '" + AJAX_SERVLET_PATH + "/call/htmlpoll/';"); + + out.println(); + out.println("// SCA sevices"); + + // Use the DWR remoter to generate the JavaScipt function for each SCA service + Remoter remoter = (Remoter)getContainer().getBean(Remoter.class.getName()); + + String path = request.getContextPath() + request.getServletPath(); + + for (String serviceName : services.keySet()) { + String serviceScript = remoter.generateInterfaceScript(serviceName, path); + out.println(serviceScript); + } + + if (referenceNames.size() > 0) { + + out.println("// SCA reverse ajax control functions"); + out.println(); + out.println("scaDomain.open = function() { dwr.engine.setActiveReverseAjax(true); };"); + out.println("scaDomain.close = function() { dwr.engine.setActiveReverseAjax(false); };"); + + out.println(); + out.println("// SCA references"); + out.println(); + + // the JavaScript function for SCA references has an + // empty impl as it uses DWR severside "push" + for (String referenceName : referenceNames) { + out.println("function " + referenceName + "() { }"); + } + } + + out.println(); + out.println("/** End of Apache Tuscany scaDomain.js */"); + out.println(); + } + + /** + * Add an SCA reference to be added to the DWR runtime + */ + public void addReference(String name) { + referenceNames.add(name); + } + + /** + * Add an SCA service to be added to the DWR runtime + */ + public void addService(String name, final Class type, final Object instance) { + ServiceHolder holder = new ServiceHolder(); + holder.name = name; + holder.type = type; + holder.instance = instance; + services.put(name, holder); + } + + /** + * Defines each SCA service proxy instance to DWR + */ + protected void initServices() { + CreatorManager creatorManager = (CreatorManager)getContainer().getBean(CreatorManager.class.getName()); + + for (final ServiceHolder holder : services.values()) { + creatorManager.addCreator(holder.name, new AbstractCreator() { + public Class getType() { + return holder.type; + } + + public Object getInstance() throws InstantiationException { + return holder.instance; + } + }); + } + } + + // utility class to aid passing around services + class ServiceHolder { + String name; + Class type; + Object instance; + } + + /** + * Patch the ServletConfig to enable setting init params for DWR + * and so DWR can't see the Tuscany servlet's init params. + */ + protected ServletConfig patchConfig(final ServletConfig servletConfig) { + ServletConfig patchedContext = new ServletConfig() { + public String getInitParameter(String name) { + return initParams.get(name); + } + public Enumeration getInitParameterNames() { + return Collections.enumeration(initParams.keySet()); + } + public ServletContext getServletContext() { + return servletConfig.getServletContext(); + } + public String getServletName() { + return servletConfig.getServletName(); + } + }; + return patchedContext; + } + + /** + * This changes the value returned from getPathInfo so that it does not include + * the path prefix of this Servlet. The DWR servlet expects its handlers to be + * at the root, eg /call/plaincall/, so they aren't found if the value request + * getPathInfo returns includes this servlets path, eg /SCADomain/call/plaincall/ + */ + protected HttpServletRequest patchRequest(final HttpServletRequest req) { + + final String translatedPath = req.getPathInfo().substring(AJAX_SERVLET_PATH.length()); + + HttpServletRequest patchedRequest = new HttpServletRequest() { + public Object getAttribute(String arg0) { + return req.getAttribute(arg0); + } + public Enumeration getAttributeNames() { + return req.getAttributeNames(); + } + public String getCharacterEncoding() { + return req.getCharacterEncoding(); + } + public int getContentLength() { + return req.getContentLength(); + } + public String getContentType() { + return req.getContentType(); + } + public ServletInputStream getInputStream() throws IOException { + return req.getInputStream(); + } + public String getLocalAddr() { + return req.getLocalAddr(); + } + public String getLocalName() { + return req.getLocalName(); + } + public int getLocalPort() { + return req.getLocalPort(); + } + public Locale getLocale() { + return req.getLocale(); + } + public Enumeration getLocales() { + return req.getLocales(); + } + public String getParameter(String arg0) { + return req.getParameter(arg0); + } + public Map getParameterMap() { + return req.getParameterMap(); + } + public Enumeration getParameterNames() { + return req.getParameterNames(); + } + public String[] getParameterValues(String arg0) { + return req.getParameterValues(arg0); + } + public String getProtocol() { + return req.getProtocol(); + } + public BufferedReader getReader() throws IOException { + return req.getReader(); + } + @SuppressWarnings("deprecation") + public String getRealPath(String arg0) { + return req.getRealPath(arg0); + } + public String getRemoteAddr() { + return req.getRemoteAddr(); + } + public String getRemoteHost() { + return req.getRemoteHost(); + } + public int getRemotePort() { + return req.getRemotePort(); + } + public RequestDispatcher getRequestDispatcher(String arg0) { + return req.getRequestDispatcher(arg0); + } + public String getScheme() { + return req.getScheme(); + } + public String getServerName() { + return req.getServerName(); + } + public int getServerPort() { + return req.getServerPort(); + } + public boolean isSecure() { + return req.isSecure(); + } + public void removeAttribute(String arg0) { + req.removeAttribute(arg0); + } + public void setAttribute(String arg0, Object arg1) { + req.setAttribute(arg0, arg1); + } + public void setCharacterEncoding(String arg0) throws UnsupportedEncodingException { + req.setCharacterEncoding(arg0); + } + public String getAuthType() { + return req.getAuthType(); + } + public String getContextPath() { + return req.getContextPath(); + } + public Cookie[] getCookies() { + return req.getCookies(); + } + public long getDateHeader(String arg0) { + return req.getDateHeader(arg0); + } + public String getHeader(String arg0) { + return req.getHeader(arg0); + } + public Enumeration getHeaderNames() { + return req.getHeaderNames(); + } + public Enumeration getHeaders(String arg0) { + return req.getHeaders(arg0); + } + public int getIntHeader(String arg0) { + return req.getIntHeader(arg0); + } + public String getMethod() { + return req.getMethod(); + } + public String getPathInfo() { + + // *** return the translated path + + return translatedPath; + } + public String getPathTranslated() { + return req.getPathTranslated(); + } + public String getQueryString() { + return req.getQueryString(); + } + public String getRemoteUser() { + return req.getRemoteUser(); + } + public String getRequestURI() { + return req.getRequestURI(); + } + public StringBuffer getRequestURL() { + return req.getRequestURL(); + } + public String getRequestedSessionId() { + return req.getRequestedSessionId(); + } + public String getServletPath() { + return req.getServletPath(); + } + public HttpSession getSession() { + return req.getSession(); + } + public HttpSession getSession(boolean arg0) { + return req.getSession(arg0); + } + public Principal getUserPrincipal() { + return req.getUserPrincipal(); + } + public boolean isRequestedSessionIdFromCookie() { + return req.isRequestedSessionIdFromCookie(); + } + public boolean isRequestedSessionIdFromURL() { + return req.isRequestedSessionIdFromURL(); + } + @SuppressWarnings("deprecation") + public boolean isRequestedSessionIdFromUrl() { + return req.isRequestedSessionIdFromUrl(); + } + public boolean isRequestedSessionIdValid() { + return req.isRequestedSessionIdValid(); + } + public boolean isUserInRole(String arg0) { + return req.isUserInRole(arg0); + } + + }; + return patchedRequest; + } +} diff --git a/sca-java-1.x/branches/sca-java-0.91/modules/binding-ajax/src/main/resources/META-INF/services/org.apache.tuscany.sca.spi.BindingActivator b/sca-java-1.x/branches/sca-java-0.91/modules/binding-ajax/src/main/resources/META-INF/services/org.apache.tuscany.sca.spi.BindingActivator new file mode 100644 index 0000000000..d09c9f4306 --- /dev/null +++ b/sca-java-1.x/branches/sca-java-0.91/modules/binding-ajax/src/main/resources/META-INF/services/org.apache.tuscany.sca.spi.BindingActivator @@ -0,0 +1,19 @@ +# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you 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.
+# Implementation class for the ExtensionActivator
+org.apache.tuscany.sca.binding.ajax.AjaxBindingActivator
+
|