/*
* The Apache Software License, Version 1.1
*
*
* Copyright (c) 2001 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Axis" and "Apache Software Foundation" must
* not be used to endorse or promote products derived from this
* software without prior written permission. For written
* permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache",
* nor may "Apache" appear in their name, without prior written
* permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*/
package samples.echo ;
import java.lang.reflect.Array;
import java.util.*;
import java.math.BigDecimal;
import org.apache.axis.AxisFault ;
import org.apache.axis.client.ServiceClient ;
import org.apache.axis.transport.http.HTTPTransport ;
import org.apache.axis.encoding.BeanSerializer;
import org.apache.axis.encoding.SOAPTypeMappingRegistry;
import org.apache.axis.encoding.ServiceDescription;
import org.apache.axis.encoding.TypeMappingRegistry;
import org.apache.axis.message.RPCParam;
import org.apache.axis.utils.Options ;
import org.apache.axis.utils.QName ;
import org.apache.axis.utils.JavaUtils;
/**
* Test Client for the echo interop service. See the main entrypoint
* for more details on usage.
*
* @author Sam Ruby <rubys@us.ibm.com>
*/
public abstract class TestClient {
private static ServiceClient call;
private static boolean addMethodToAction = false;
private static String soapAction = "http://soapinterop.org/";
private TypeMappingRegistry map;
/**
* Determine if two objects are equal. Handles nulls and recursively
* verifies arrays are equal. Accepts dates within a tolerance of
* 999 milliseconds.
*/
protected boolean equals(Object obj1, Object obj2) {
if (obj1 == null || obj2 == null) return (obj1 == obj2);
if (obj1.equals(obj2)) return true;
if (obj1 instanceof Date && obj2 instanceof Date)
if (Math.abs(((Date)obj1).getTime()-((Date)obj2).getTime())<1000)
return true;
if ((obj1 instanceof Map) && (obj2 instanceof Map)) {
Map map1 = (Map)obj1;
Map map2 = (Map)obj2;
Set keys1 = map1.keySet();
Set keys2 = map2.keySet();
if (!(keys1.equals(keys2))) return false;
Iterator i = keys1.iterator();
while (i.hasNext()) {
Object key = i.next();
if (!map1.get(key).equals(map2.get(key)))
return false;
}
return true;
}
if (obj1 instanceof List)
obj1 = JavaUtils.convert(obj1, Object[].class);
if (obj2 instanceof List)
obj2 = JavaUtils.convert(obj2, Object[].class);
if (!obj2.getClass().isArray()) return false;
if (!obj1.getClass().isArray()) return false;
if (Array.getLength(obj1) != Array.getLength(obj2)) return false;
for (int i=0; i<Array.getLength(obj1); i++)
if (!equals(Array.get(obj1,i),Array.get(obj2,i))) return false;
return true;
}
/**
* Test an echo method. Declares success if the response returns
* true with an Object.equal comparison with the object to be sent.
* @param method name of the method to invoke
* @param toSend object of the correct type to be sent
*/
private void test(String type, Object toSend) {
String method = "echo" + type;
type = type.trim();
String arg = "input" + type;
String resultName = "output" + type;
try {
// set up the argument list
Object args[];
if (toSend == null) {
args = new Object[] {};
} else {
args = new Object[] {new RPCParam(arg, toSend)};
// Default return type based on what we expect
ServiceDescription sd = new ServiceDescription(method, true);
sd.setOutputType(map.getTypeQName(toSend.getClass()));
call.setServiceDescription(sd);
}
// set the SOAPAction, optionally appending the method name
String action = soapAction;
if (addMethodToAction) action += method;
call.set(HTTPTransport.ACTION, action);
// safety first
call.setTimeout(60000);
// issue the request
Object got= call.invoke("http://soapinterop.org/",
method.trim(),
args);
// verify the result
verify(method, toSend, got);
} catch (AxisFault af) {
verify(method, toSend, af.getFaultString());
} catch (Exception e) {
verify(method, toSend, e);
}
}
/**
* Set up the call object.
*/
public void setURL(String url) {
call = new ServiceClient(url);
map = call.getMessageContext().getTypeMappingRegistry();
}
/**
* Execute the tests
*/
public void execute() throws Exception {
// register the SOAPStruct class
QName ssqn = new QName("http://soapinterop.org/xsd", "SOAPStruct");
Class cls = SOAPStruct.class;
call.addSerializer(cls, ssqn, new BeanSerializer(cls));
call.addDeserializerFactory(ssqn, cls, BeanSerializer.getFactory());
// execute the tests
test("String ", "abcdefg");
test("StringArray ", new String[] {"abc", "def"});
test("Integer ", new Integer(42));
test("IntegerArray", new Integer[] {new Integer(42)});
test("Float ", new Float(3.7F));
test("FloatArray ", new Float[] {new Float(3.7F), new Float(7F)});
test("Struct ", new SOAPStruct(5, "Hello", 10.3F));
test("StructArray ", new SOAPStruct[] {
new SOAPStruct(1, "one", 1.1F),
new SOAPStruct(2, "two", 2.2F),
new SOAPStruct(3, "three", 3.3F)});
test("Void ", null);
test("Base64 ", "Base64".getBytes());
test("Date ", new Date());
test("Decimal ", new BigDecimal("3.14159"));
test("Boolean ", Boolean.TRUE);
HashMap map = new HashMap();
map.put("stringKey", new Integer(5));
map.put(new Date(), "string value");
test("Map ", map);
}
/**
* Verify that the object sent was, indeed, the one you got back.
* Subclasses are sent to override this with their own output.
*/
protected abstract void verify(String method, Object sent, Object gotBack);
/**
* Main entry point. Tests a variety of echo methods and reports
* on their results.
*
* Arguments are of the form:
* -h localhost -p 8080 -s /soap/servlet/rpcrouter
*/
public static void main(String args[]) throws Exception {
// set up tests so that the results are sent to System.out
TestClient client = new TestClient() {
public void verify(String method, Object sent, Object gotBack) {
if (this.equals(sent, gotBack)) {
System.out.println(method + "\t OK");
} else {
System.out.println(method + "\t Fail: " + gotBack);
if (gotBack instanceof Exception)
if (!(gotBack instanceof AxisFault))
((Exception)gotBack).printStackTrace();
}
}
};
// set up the call object
Options opts = new Options(args);
client.setURL(opts.getURL());
// support for tests with non-compliant applications
client.addMethodToAction = (opts.isFlagSet('m') > 0);
String action = opts.isValueSet('a');
if (action != null) client.soapAction = action;
client.execute();
}
}