org.apache.tuscany.sca.core.databinding.processor.WrapperJavaInterfaceProcessor Maven / Gradle / Ivy
/*
* 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.core.databinding.processor;
import java.util.HashSet;
import java.util.LinkedList;
import java.util.List;
import java.util.Set;
import org.apache.tuscany.sca.core.ExtensionPointRegistry;
import org.apache.tuscany.sca.databinding.DataBinding;
import org.apache.tuscany.sca.databinding.DataBindingExtensionPoint;
import org.apache.tuscany.sca.databinding.WrapperHandler;
import org.apache.tuscany.sca.databinding.javabeans.JavaBeansDataBinding;
import org.apache.tuscany.sca.databinding.javabeans.SimpleJavaDataBinding;
import org.apache.tuscany.sca.interfacedef.DataType;
import org.apache.tuscany.sca.interfacedef.InvalidInterfaceException;
import org.apache.tuscany.sca.interfacedef.Operation;
import org.apache.tuscany.sca.interfacedef.java.JavaInterface;
import org.apache.tuscany.sca.interfacedef.java.introspect.JavaInterfaceVisitor;
import org.apache.tuscany.sca.interfacedef.util.WrapperInfo;
/**
* The databinding annotation processor for java interfaces
*
* @version $Rev: 1305484 $ $Date: 2012-03-26 11:34:04 -0700 (Mon, 26 Mar 2012) $
*/
public class WrapperJavaInterfaceProcessor implements JavaInterfaceVisitor {
private static final String JAXB_DATABINDING = "javax.xml.bind.JAXBElement";
private DataBindingExtensionPoint dataBindingRegistry;
public WrapperJavaInterfaceProcessor(ExtensionPointRegistry registry) {
super();
this.dataBindingRegistry = registry.getExtensionPoint(DataBindingExtensionPoint.class);
}
public void visitInterface(JavaInterface javaInterface) throws InvalidInterfaceException {
// create regardless in case the user overrides the remotable flag
// in the SCDL
//if (!javaInterface.isRemotable()) {
// return;
//}
for (Operation operation : javaInterface.getOperations()) {
WrapperInfo inputWrapperInfo = operation.getInputWrapper();
WrapperInfo outputWrapperInfo = operation.getOutputWrapper();
if (inputWrapperInfo == null || outputWrapperInfo == null) {
continue;
}
// TUSCANY-824
// TUSCANY-3804 - modify the existing code to set up the input wrapper
String db = inputWrapperInfo.getDataBinding();
if (db == null || JAXB_DATABINDING.equals(db)) {
db = assignInputDataBinding(operation);
}
// Introspect the wrapper data type
DataBinding dbObj = dataBindingRegistry.getDataBinding(db);
WrapperHandler handler = dbObj == null ? null : dbObj.getWrapperHandler();
if (handler != null) {
inputWrapperInfo.setWrapperType(handler.getWrapperType(operation, true));
}
if (dbObj != null && handler == null) {
// To avoid JAXB wrapper bean generation
inputWrapperInfo.setWrapperType(null);
}
// TUSCANY-3804 - handle output wrapper separately
db = outputWrapperInfo.getDataBinding();
if (db == null || JAXB_DATABINDING.equals(db)) {
db = assignOutputDataBinding(operation);
}
// Introspect the wrapper data type
dbObj = dataBindingRegistry.getDataBinding(db);
handler = dbObj == null ? null : dbObj.getWrapperHandler();
if (handler != null) {
outputWrapperInfo.setWrapperType(handler.getWrapperType(operation, false));
}
if (dbObj != null && handler == null) {
// To avoid JAXB wrapper bean generation
outputWrapperInfo.setWrapperType(null);
}
}
}
/*
* Assigns an operation DB if one of the input types has a non-default DB.
* However, if two of the input types, have two different non-default DBs
* ( e.g. SDO and JAXB), then we do nothing to the operation DB.
*
* The method logic assumes the JavaBeans DataBinding is the default
*/
private String assignInputDataBinding(Operation operation) {
Set dbs = new HashSet();
List opDataTypes = new LinkedList();
opDataTypes.addAll(operation.getInputType().getLogical());
for (DataType d : opDataTypes) {
if (d != null) {
String dataBinding = d.getDataBinding();
if ("java:array".equals(dataBinding)) {
dataBinding = ((DataType)d.getLogical()).getDataBinding();
}
if (dataBinding != null) {
dbs.add(dataBinding);
}
}
}
dbs.remove(JavaBeansDataBinding.NAME);
dbs.remove(SimpleJavaDataBinding.NAME);
if (dbs.size() == 1) {
String db = dbs.iterator().next();
operation.getInputWrapper().setDataBinding(db);
return db;
} else {
return operation.getInputWrapper().getDataBinding();
}
}
// TUSCANY-3804: handle output wrapper separately. Ignore faults
// in this calculation, as they're not part of the output wrapper, and
// we have our own introspection/framework to deal with fault databindings.
//
private String assignOutputDataBinding(Operation operation) {
Set dbs = new HashSet();
List opDataTypes = new LinkedList();
opDataTypes.addAll(operation.getOutputType().getLogical());
for (DataType d : opDataTypes) {
if (d != null) {
String dataBinding = d.getDataBinding();
if ("java:array".equals(dataBinding)) {
dataBinding = ((DataType)d.getLogical()).getDataBinding();
}
if (dataBinding != null) {
dbs.add(dataBinding);
}
}
}
dbs.remove(JavaBeansDataBinding.NAME);
dbs.remove(SimpleJavaDataBinding.NAME);
if (dbs.size() == 1) {
String db = dbs.iterator().next();
operation.getOutputWrapper().setDataBinding(db);
return db;
} else {
return operation.getOutputWrapper().getDataBinding();
}
}
}