Finalize the AllowsPassByReference support and add test cases

git-svn-id: http://svn.us.apache.org/repos/asf/tuscany@1068211 13f79535-47bb-0310-9956-ffa450edef68

9 files changed, 623 insertions, 0 deletions

diff --git a/sca-java-2.x/trunk/testing/itest/references/src/main/java/org/apache/tuscany/sca/itest/allowspassbyreference/AService.java b/sca-java-2.x/trunk/testing/itest/references/src/main/java/org/apache/tuscany/sca/itest/allowspassbyreference/AService.java
new file mode 100644
index 0000000000..cecb2d83dd
--- /dev/null
+++ b/sca-java-2.x/trunk/testing/itest/references/src/main/java/org/apache/tuscany/sca/itest/allowspassbyreference/AService.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.itest.allowspassbyreference;
+
+import org.oasisopen.sca.annotation.Remotable;
+
+/**
+ * The service interface
+ */
+@Remotable
+public interface AService {
+    /**
+     * Create a new object 
+     * @param req
+     * @return
+     */
+    MutableObject create(MutableObject req);
+
+    /**
+     * 
+     * @param req
+     * @return
+     */
+    MutableObject read(MutableObject req);
+
+    /**
+     * 
+     * @param req
+     * @return
+     */
+    MutableObject update(MutableObject req);
+
+    /**
+     * 
+     * @param req
+     * @return
+     */
+    MutableObject delete(MutableObject req);
+}
diff --git a/sca-java-2.x/trunk/testing/itest/references/src/main/java/org/apache/tuscany/sca/itest/allowspassbyreference/AServiceClient.java b/sca-java-2.x/trunk/testing/itest/references/src/main/java/org/apache/tuscany/sca/itest/allowspassbyreference/AServiceClient.java
new file mode 100644
index 0000000000..2c746fcbb2
--- /dev/null
+++ b/sca-java-2.x/trunk/testing/itest/references/src/main/java/org/apache/tuscany/sca/itest/allowspassbyreference/AServiceClient.java
@@ -0,0 +1,55 @@
+/*
+ * 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.itest.allowspassbyreference;
+
+
+/**
+ * The client interface
+ */
+public interface AServiceClient {
+    /**
+     * Create a new object with the given state
+     * @param state
+     * @return the id
+     */
+    int create(String state);
+
+    /**
+     * Read the object state by id
+     * @param id
+     * @return
+     */
+    String read(int id);
+
+    /**
+     * Update the state
+     * @param id
+     * @param newState
+     * @return
+     */
+    String update(int id, String newState);
+
+    /**
+     * Delete the object by id
+     * @param id
+     * @return
+     */
+    boolean delete(int id);
+}
diff --git a/sca-java-2.x/trunk/testing/itest/references/src/main/java/org/apache/tuscany/sca/itest/allowspassbyreference/ClientImplA.java b/sca-java-2.x/trunk/testing/itest/references/src/main/java/org/apache/tuscany/sca/itest/allowspassbyreference/ClientImplA.java
new file mode 100644
index 0000000000..59c3768964
--- /dev/null
+++ b/sca-java-2.x/trunk/testing/itest/references/src/main/java/org/apache/tuscany/sca/itest/allowspassbyreference/ClientImplA.java
@@ -0,0 +1,87 @@
+/*
+ * 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.itest.allowspassbyreference;
+
+import junit.framework.Assert;
+
+import org.oasisopen.sca.annotation.ComponentName;
+import org.oasisopen.sca.annotation.Reference;
+import org.oasisopen.sca.annotation.Scope;
+import org.oasisopen.sca.annotation.Service;
+
+/**
+ * 
+ */
+@Service(AServiceClient.class)
+@Scope("COMPOSITE")
+public class ClientImplA implements AServiceClient {
+    @ComponentName
+    private String componentName;
+
+    @Reference
+    private AService service;
+
+    @Override
+    public int create(String state) {
+        MutableObject req = new MutableObject(state);
+        MutableObject res = service.create(req);
+        if ("ClientA1Component".equals(componentName)) {
+            Assert.assertTrue(req.getId() == -1);
+            Assert.assertNotSame(req, res);
+        } else if ("ClientA2Component".equals(componentName)) {
+            Assert.assertTrue(req.getId() == -1);
+            Assert.assertNotSame(req, res);
+        }
+        return res.getId();
+    }
+
+    @Override
+    public String read(int id) {
+        MutableObject req = new MutableObject(id);
+        MutableObject res = service.read(req);
+        if ("ClientA1Component".equals(componentName)) {
+            Assert.assertTrue(req.getState() == null);
+            Assert.assertNotSame(req, res);
+        } else if ("ClientA2Component".equals(componentName)) {
+            Assert.assertTrue(req.getState() == null);
+        }
+        return res.getState();
+    }
+
+    @Override
+    public String update(int id, String newState) {
+        MutableObject req = new MutableObject(id, newState);
+        MutableObject res = service.update(req);
+        if ("ClientA1Component".equals(componentName)) {
+            Assert.assertTrue(req.getState() == newState);
+        } else if ("ClientA2Component".equals(componentName)) {
+            Assert.assertTrue(req.getState() == newState);
+        }
+        return res.getState();
+    }
+
+    @Override
+    public boolean delete(int id) {
+        MutableObject req = new MutableObject(id);
+        MutableObject res = service.delete(req);
+        return res != null;
+    }
+
+}
diff --git a/sca-java-2.x/trunk/testing/itest/references/src/main/java/org/apache/tuscany/sca/itest/allowspassbyreference/ClientImplB.java b/sca-java-2.x/trunk/testing/itest/references/src/main/java/org/apache/tuscany/sca/itest/allowspassbyreference/ClientImplB.java
new file mode 100644
index 0000000000..01b2c5d946
--- /dev/null
+++ b/sca-java-2.x/trunk/testing/itest/references/src/main/java/org/apache/tuscany/sca/itest/allowspassbyreference/ClientImplB.java
@@ -0,0 +1,90 @@
+/*
+ * 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.itest.allowspassbyreference;
+
+import junit.framework.Assert;
+
+import org.oasisopen.sca.annotation.AllowsPassByReference;
+import org.oasisopen.sca.annotation.ComponentName;
+import org.oasisopen.sca.annotation.Reference;
+import org.oasisopen.sca.annotation.Scope;
+import org.oasisopen.sca.annotation.Service;
+
+/**
+ * 
+ */
+@Service(AServiceClient.class)
+@Scope("COMPOSITE")
+public class ClientImplB implements AServiceClient {
+    @ComponentName
+    private String componentName;
+
+    @Reference
+    @AllowsPassByReference
+    private AService service;
+
+    @Override
+    public int create(String state) {
+        MutableObject req = new MutableObject(state);
+        MutableObject res = service.create(req);
+        if ("ClientB1Component".equals(componentName)) {
+            Assert.assertTrue(req.getId() == -1);
+            Assert.assertNotSame(req, res);
+        } else if ("ClientB2Component".equals(componentName)) {
+            // Both sides allow PBR, so the id is changed (for the purpose of checking if PBR is used)
+            Assert.assertTrue(req.getId() != -1);
+        }
+        return res.getId();
+    }
+
+    @Override
+    public String read(int id) {
+        MutableObject req = new MutableObject(id);
+        MutableObject res = service.read(req);
+        if ("ClientB1Component".equals(componentName)) {
+            Assert.assertTrue("READ".equals(req.getState()));
+            Assert.assertNotSame(req, res);
+        } else if ("ClientB2Component".equals(componentName)) {
+            Assert.assertTrue("READ".equals(req.getState()));
+        }
+        return res.getState();
+    }
+
+    @Override
+    public String update(int id, String newState) {
+        MutableObject req = new MutableObject(id, newState);
+        MutableObject res = service.update(req);
+        if ("ClientB1Component".equals(componentName)) {
+            Assert.assertTrue(req.getState() == newState);
+            Assert.assertNotSame(req, res);
+        } else if ("ClientB2Component".equals(componentName)) {
+            Assert.assertTrue(req.getState() == newState);
+        }
+        return res.getState();
+    }
+
+    @Override
+    public boolean delete(int id) {
+        MutableObject req = new MutableObject(id);
+        MutableObject res = service.delete(req);
+        return res != null;
+    }
+
+}
diff --git a/sca-java-2.x/trunk/testing/itest/references/src/main/java/org/apache/tuscany/sca/itest/allowspassbyreference/MutableObject.java b/sca-java-2.x/trunk/testing/itest/references/src/main/java/org/apache/tuscany/sca/itest/allowspassbyreference/MutableObject.java
new file mode 100644
index 0000000000..6fc28e36b2
--- /dev/null
+++ b/sca-java-2.x/trunk/testing/itest/references/src/main/java/org/apache/tuscany/sca/itest/allowspassbyreference/MutableObject.java
@@ -0,0 +1,77 @@
+/*
+ * 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.itest.allowspassbyreference;
+
+/**
+ * A mutable object
+ */
+public class MutableObject implements Cloneable {
+    private int id = -1;
+    private String state;
+
+    public MutableObject() {
+    }
+
+    public MutableObject(int id, String state) {
+        super();
+        this.id = id;
+        this.state = state;
+    }
+
+    public MutableObject(String state) {
+        super();
+        this.state = state;
+    }
+
+    public MutableObject(int id) {
+        super();
+        this.id = id;
+    }
+
+    public String getState() {
+        return state;
+    }
+
+    public void setState(String state) {
+        this.state = state;
+    }
+
+    public int getId() {
+        return id;
+    }
+
+    public void setId(int id) {
+        this.id = id;
+    }
+
+    public MutableObject clone() {
+        MutableObject copy = new MutableObject();
+        copy.id = id;
+        copy.state = state;
+        return copy;
+    }
+
+    @Override
+    public String toString() {
+        StringBuilder builder = new StringBuilder();
+        builder.append("MutableObject [id=").append(id).append(", state=").append(state).append("]");
+        return builder.toString();
+    }
+}
diff --git a/sca-java-2.x/trunk/testing/itest/references/src/main/java/org/apache/tuscany/sca/itest/allowspassbyreference/ServiceImplA.java b/sca-java-2.x/trunk/testing/itest/references/src/main/java/org/apache/tuscany/sca/itest/allowspassbyreference/ServiceImplA.java
new file mode 100644
index 0000000000..43a9e71f44
--- /dev/null
+++ b/sca-java-2.x/trunk/testing/itest/references/src/main/java/org/apache/tuscany/sca/itest/allowspassbyreference/ServiceImplA.java
@@ -0,0 +1,61 @@
+/*
+ * 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.itest.allowspassbyreference;
+
+import java.util.HashMap;
+import java.util.Map;
+
+import org.oasisopen.sca.annotation.AllowsPassByReference;
+import org.oasisopen.sca.annotation.Scope;
+
+/**
+ * 
+ */
+@Scope("COMPOSITE")
+public class ServiceImplA implements AService {
+    private volatile int count = 0;
+    private Map<Integer, MutableObject> objects = new HashMap<Integer, MutableObject>();
+
+    @Override
+    public MutableObject create(MutableObject req) {
+        req.setId(count++);
+        objects.put(req.getId(), req);
+        return req;
+    }
+
+    @AllowsPassByReference
+    public MutableObject read(MutableObject req) {
+        // Change the state of the request so that the client side can verify if PBR is used
+        req.setState("READ");
+        return objects.get(req.getId());
+    }
+
+    @Override
+    public MutableObject update(MutableObject req) {
+        objects.put(req.getId(), req);
+        return req;
+    }
+
+    @Override
+    public MutableObject delete(MutableObject req) {
+        return objects.remove(req.getId());
+    }
+
+}
diff --git a/sca-java-2.x/trunk/testing/itest/references/src/main/java/org/apache/tuscany/sca/itest/allowspassbyreference/ServiceImplB.java b/sca-java-2.x/trunk/testing/itest/references/src/main/java/org/apache/tuscany/sca/itest/allowspassbyreference/ServiceImplB.java
new file mode 100644
index 0000000000..a0ad7746d7
--- /dev/null
+++ b/sca-java-2.x/trunk/testing/itest/references/src/main/java/org/apache/tuscany/sca/itest/allowspassbyreference/ServiceImplB.java
@@ -0,0 +1,70 @@
+/*
+ * 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.itest.allowspassbyreference;
+
+import java.util.HashMap;
+import java.util.Map;
+
+import org.oasisopen.sca.annotation.AllowsPassByReference;
+import org.oasisopen.sca.annotation.Scope;
+
+/**
+ * 
+ */
+@AllowsPassByReference
+@Scope("COMPOSITE")
+public class ServiceImplB implements AService {
+
+    private volatile int count = 0;
+    private Map<Integer, MutableObject> objects = new HashMap<Integer, MutableObject>();
+
+    @Override
+    public MutableObject create(MutableObject req) {
+        // Change the id of the request so that the client side can verify if PBR is used
+        req.setId(count++);
+        req = req.clone();
+        objects.put(req.getId(), req);
+        return req;
+    }
+
+    @Override
+    public MutableObject read(MutableObject req) {
+        // Change the state of the request so that the client side can verify if PBR is used
+        req.setState("READ");
+        return objects.get(req.getId()).clone();
+    }
+
+    @Override
+    public MutableObject update(MutableObject req) {
+        req = req.clone();
+        objects.put(req.getId(), req);
+        return req;
+    }
+
+    @Override
+    public MutableObject delete(MutableObject req) {
+        MutableObject obj = objects.remove(req.getId());
+        if (obj != null) {
+            return obj.clone();
+        }
+        return obj;
+    }
+
+}
diff --git a/sca-java-2.x/trunk/testing/itest/references/src/main/resources/AllowsPBRTest.composite b/sca-java-2.x/trunk/testing/itest/references/src/main/resources/AllowsPBRTest.composite
new file mode 100644
index 0000000000..98ebddafc0
--- /dev/null
+++ b/sca-java-2.x/trunk/testing/itest/references/src/main/resources/AllowsPBRTest.composite
@@ -0,0 +1,50 @@
+<?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
+    * 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.
+-->
+<composite xmlns="http://docs.oasis-open.org/ns/opencsa/sca/200912" xmlns:foo="http://foo" targetNamespace="http://foo"
+    name="AllowsPBRTest" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+
+    <component name="ClientA1Component">
+        <implementation.java class="org.apache.tuscany.sca.itest.allowspassbyreference.ClientImplA" />
+        <reference name="service" target="ServiceAComponent"/>
+    </component>
+
+    <component name="ClientB1Component">
+        <implementation.java class="org.apache.tuscany.sca.itest.allowspassbyreference.ClientImplB" />
+        <reference name="service" target="ServiceAComponent"/>
+    </component>
+
+    <component name="ClientA2Component">
+        <implementation.java class="org.apache.tuscany.sca.itest.allowspassbyreference.ClientImplA" />
+        <reference name="service" target="ServiceBComponent"/>
+    </component>
+
+    <component name="ClientB2Component">
+        <implementation.java class="org.apache.tuscany.sca.itest.allowspassbyreference.ClientImplB" />
+        <reference name="service" target="ServiceBComponent"/>
+    </component>
+    
+    <component name="ServiceAComponent">
+        <implementation.java class="org.apache.tuscany.sca.itest.allowspassbyreference.ServiceImplA" />
+    </component>
+
+    <component name="ServiceBComponent">
+        <implementation.java class="org.apache.tuscany.sca.itest.allowspassbyreference.ServiceImplB" />
+    </component>
+
+</composite>
\ No newline at end of file
diff --git a/sca-java-2.x/trunk/testing/itest/references/src/test/java/org/apache/tuscany/sca/itest/references/AllowsPBRTestCase.java b/sca-java-2.x/trunk/testing/itest/references/src/test/java/org/apache/tuscany/sca/itest/references/AllowsPBRTestCase.java
new file mode 100644
index 0000000000..adabc65a25
--- /dev/null
+++ b/sca-java-2.x/trunk/testing/itest/references/src/test/java/org/apache/tuscany/sca/itest/references/AllowsPBRTestCase.java
@@ -0,0 +1,77 @@
+/*
+ * 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.itest.references;
+
+import junit.framework.Assert;
+
+import org.apache.tuscany.sca.itest.allowspassbyreference.AServiceClient;
+import org.apache.tuscany.sca.node.Contribution;
+import org.apache.tuscany.sca.node.ContributionLocationHelper;
+import org.apache.tuscany.sca.node.Node;
+import org.apache.tuscany.sca.node.NodeFactory;
+import org.junit.AfterClass;
+import org.junit.BeforeClass;
+import org.junit.Test;
+
+public class AllowsPBRTestCase {
+    private static Node node;
+
+    @BeforeClass
+    public static void init() throws Exception {
+        String location = ContributionLocationHelper.getContributionLocation("AllowsPBRTest.composite");
+        node = NodeFactory.newInstance().createNode("AllowsPBRTest.composite", new Contribution("c1", location));
+        node.start();
+    }
+
+    @AfterClass
+    public static void destroy() throws Exception {
+        node.stop();
+    }
+
+    @Test
+    public void testClientA1() {
+        test("ClientA1Component");
+    }
+
+    @Test
+    public void testClientA2() {
+        test("ClientA2Component");
+    }
+
+    @Test
+    public void testClientB1() {
+        test("ClientB1Component");
+    }
+
+    @Test
+    public void testClientB2() {
+        test("ClientB2Component");
+    }
+
+    private void test(String serviceName) {
+        AServiceClient client = node.getService(AServiceClient.class, serviceName);
+        int id = client.create("A");
+        String state = client.read(id);
+        Assert.assertEquals("A", state);
+        state = client.update(id, "B");
+        Assert.assertEquals("B", state);
+        client.delete(id);
+    }
+
+}