org.apache.cxf.aegis.databinding.AegisDatabinding 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.cxf.aegis.databinding;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Set;
import javax.xml.namespace.QName;
import javax.xml.stream.XMLStreamReader;
import javax.xml.stream.XMLStreamWriter;
import org.w3c.dom.Node;
import org.apache.cxf.aegis.DatabindingException;
import org.apache.cxf.aegis.type.AbstractTypeCreator.TypeClassInfo;
import org.apache.cxf.aegis.type.Configuration;
import org.apache.cxf.aegis.type.DefaultTypeMappingRegistry;
import org.apache.cxf.aegis.type.Type;
import org.apache.cxf.aegis.type.TypeCreator;
import org.apache.cxf.aegis.type.TypeMapping;
import org.apache.cxf.aegis.type.TypeMappingRegistry;
import org.apache.cxf.aegis.type.TypeUtil;
import org.apache.cxf.aegis.type.basic.BeanType;
import org.apache.cxf.aegis.util.XmlConstants;
import org.apache.cxf.common.classloader.ClassLoaderUtils;
import org.apache.cxf.common.xmlschema.SchemaCollection;
import org.apache.cxf.databinding.DataBinding;
import org.apache.cxf.databinding.DataReader;
import org.apache.cxf.databinding.DataWriter;
import org.apache.cxf.databinding.source.AbstractDataBinding;
import org.apache.cxf.frontend.MethodDispatcher;
import org.apache.cxf.frontend.SimpleMethodDispatcher;
import org.apache.cxf.service.Service;
import org.apache.cxf.service.factory.ServiceConstructionException;
import org.apache.cxf.service.model.AbstractMessageContainer;
import org.apache.cxf.service.model.FaultInfo;
import org.apache.cxf.service.model.MessagePartInfo;
import org.apache.cxf.service.model.OperationInfo;
import org.apache.cxf.service.model.ServiceInfo;
import org.apache.cxf.wsdl.WSDLConstants;
import org.apache.ws.commons.schema.XmlSchema;
import org.apache.ws.commons.schema.XmlSchemaAnnotated;
import org.apache.ws.commons.schema.utils.NamespaceMap;
import org.jdom.Attribute;
import org.jdom.Document;
import org.jdom.Element;
import org.jdom.JDOMException;
import org.jdom.Namespace;
import org.jdom.output.DOMOutputter;
/**
* Handles DataBinding functions for Aegis.
*
* NOTE: There is an assumed 1:1 mapping between an AegisDatabinding and a Service!
*/
public class AegisDatabinding extends AbstractDataBinding implements DataBinding {
public static final String CURRENT_MESSAGE_PART = "currentMessagePart";
public static final String TYPE_MAPPING_KEY = "type.mapping";
public static final String ENCODING_URI_KEY = "type.encodingUri";
public static final String WRITE_XSI_TYPE_KEY = "writeXsiType";
public static final String OVERRIDE_TYPES_KEY = "overrideTypesList";
public static final String READ_XSI_TYPE_KEY = "readXsiType";
protected static final int IN_PARAM = 0;
protected static final int OUT_PARAM = 1;
protected static final int FAULT_PARAM = 2;
private TypeMappingRegistry typeMappingRegistry;
private Map part2Type;
private List overrideTypes;
private Service service;
public AegisDatabinding() {
super();
this.typeMappingRegistry = new DefaultTypeMappingRegistry(true);
part2Type = new HashMap();
}
@SuppressWarnings("unchecked")
public DataReader createReader(Class cls) {
if (cls.equals(XMLStreamReader.class)) {
return (DataReader) new XMLStreamDataReader(this);
} else if (cls.equals(Node.class)) {
return (DataReader) new ElementDataReader(this);
} else {
throw new UnsupportedOperationException();
}
}
@SuppressWarnings("unchecked")
public DataWriter createWriter(Class cls) {
if (cls.equals(XMLStreamWriter.class)) {
return (DataWriter)new XMLStreamDataWriter(this);
} else if (cls.equals(Node.class)) {
return (DataWriter) new ElementDataWriter(this);
} else {
throw new UnsupportedOperationException();
}
}
public Class[] getSupportedReaderFormats() {
return new Class[] {XMLStreamReader.class, Node.class};
}
public Class[] getSupportedWriterFormats() {
return new Class[] {XMLStreamWriter.class, Node.class};
}
public TypeMappingRegistry getTypeMappingRegistry() {
return typeMappingRegistry;
}
public void setTypeMappingRegistry(TypeMappingRegistry typeMappingRegistry) {
this.typeMappingRegistry = typeMappingRegistry;
}
public void initialize(Service s) {
this.service = s;
QName serviceName = s.getServiceInfos().get(0).getName();
TypeMapping serviceTM = typeMappingRegistry.createTypeMapping(XmlConstants.XSD, true);
typeMappingRegistry.register(serviceName.getNamespaceURI(), serviceTM);
s.put(TypeMapping.class.getName(), serviceTM);
Set deps = new HashSet();
for (ServiceInfo info : s.getServiceInfos()) {
for (OperationInfo opInfo : info.getInterface().getOperations()) {
if (opInfo.isUnwrappedCapable()) {
initializeOperation(s, serviceTM, opInfo.getUnwrappedOperation(), deps);
} else {
initializeOperation(s, serviceTM, opInfo, deps);
}
}
}
List additional = getAdditionalTypes(s, serviceTM);
if (additional != null) {
for (Type t : additional) {
if (!deps.contains(t)) {
deps.add(t);
}
addDependencies(deps, t);
}
}
createSchemas(s, deps);
for (ServiceInfo info : s.getServiceInfos()) {
for (OperationInfo opInfo : info.getInterface().getOperations()) {
if (opInfo.isUnwrappedCapable()) {
initializeOperationTypes(info, opInfo.getUnwrappedOperation());
} else {
initializeOperationTypes(info, opInfo);
}
}
}
}
List getAdditionalTypes(Service s, TypeMapping tm) {
List classes = (List)s.get(OVERRIDE_TYPES_KEY);
this.overrideTypes = classes;
if (classes != null) {
List types = new ArrayList();
for (Iterator it = classes.iterator(); it.hasNext();) {
String typeName = (String)it.next();
Class c;
try {
c = ClassLoaderUtils.loadClass(typeName, TypeUtil.class);
} catch (ClassNotFoundException e) {
throw new DatabindingException("Could not find override type class: " + typeName, e);
}
Type t = tm.getType(c);
if (t == null) {
t = tm.getTypeCreator().createType(c);
tm.register(t);
}
if (t instanceof BeanType) {
BeanType bt = (BeanType)t;
bt.getTypeInfo().setExtension(true);
types.add(bt);
}
}
return types;
}
return null;
}
private void initializeOperation(Service s, TypeMapping serviceTM, OperationInfo opInfo,
Set deps) {
try {
initializeMessage(s, serviceTM, opInfo.getInput(), IN_PARAM, deps);
if (opInfo.hasOutput()) {
initializeMessage(s, serviceTM, opInfo.getOutput(), OUT_PARAM, deps);
}
for (FaultInfo info : opInfo.getFaults()) {
initializeMessage(s, serviceTM, info, FAULT_PARAM, deps);
}
} catch (DatabindingException e) {
e.prepend("Error initializing parameters for operation " + opInfo.getName());
throw e;
}
}
private void initializeOperationTypes(ServiceInfo s, OperationInfo opInfo) {
try {
initializeMessageTypes(s, opInfo.getInput(), IN_PARAM);
if (opInfo.hasOutput()) {
initializeMessageTypes(s, opInfo.getOutput(), OUT_PARAM);
}
for (FaultInfo info : opInfo.getFaults()) {
initializeMessageTypes(s, info, FAULT_PARAM);
}
} catch (DatabindingException e) {
e.prepend("Error initializing parameters for operation " + opInfo.getName());
throw e;
}
}
protected void initializeMessage(Service s, TypeMapping serviceTM,
AbstractMessageContainer container,
int partType, Set deps) {
for (Iterator itr = container.getMessageParts().iterator(); itr.hasNext();) {
MessagePartInfo part = (MessagePartInfo)itr.next();
Type type = getParameterType(s, serviceTM, part, partType);
if (part.getXmlSchema() == null) {
//schema hasn't been filled in yet
if (type.isAbstract()) {
part.setTypeQName(type.getSchemaType());
} else {
part.setElementQName(type.getSchemaType());
}
}
part2Type.put(part, type);
// QName elName = getSuggestedName(service, op, param)
deps.add(type);
addDependencies(deps, type);
}
}
protected void initializeMessageTypes(ServiceInfo s,
AbstractMessageContainer container,
int partType) {
SchemaCollection col = s.getXmlSchemaCollection();
for (Iterator itr = container.getMessageParts().iterator(); itr.hasNext();) {
MessagePartInfo part = (MessagePartInfo)itr.next();
if (part.getXmlSchema() == null) {
if (part.isElement()) {
XmlSchemaAnnotated tp = col.getElementByQName(part.getElementQName());
part.setXmlSchema(tp);
} else {
XmlSchemaAnnotated tp = col.getTypeByQName(part.getTypeQName());
part.setXmlSchema(tp);
}
}
}
}
private void addDependencies(Set deps, Type type) {
Set typeDeps = type.getDependencies();
if (typeDeps != null) {
for (Type t : typeDeps) {
if (!deps.contains(t)) {
deps.add(t);
addDependencies(deps, t);
}
}
}
}
private void createSchemas(Service s, Set deps) {
Map> tns2Type = new HashMap>();
for (Type t : deps) {
String ns = t.getSchemaType().getNamespaceURI();
Set types = tns2Type.get(ns);
if (types == null) {
types = new HashSet();
tns2Type.put(ns, types);
}
types.add(t);
}
for (ServiceInfo si : s.getServiceInfos()) {
SchemaCollection col = si.getXmlSchemaCollection();
if (col.getXmlSchemas().length > 1) {
// someone has already filled in the types
continue;
}
}
Map namespaceMap = getDeclaredNamespaceMappings();
for (Map.Entry> entry : tns2Type.entrySet()) {
String xsdPrefix = XmlConstants.XSD_PREFIX;
if (namespaceMap != null && namespaceMap.containsKey(XmlConstants.XSD)) {
xsdPrefix = namespaceMap.get(XmlConstants.XSD);
}
Element e = new Element("schema", xsdPrefix, XmlConstants.XSD);
e.setAttribute(new Attribute(WSDLConstants.ATTR_TNS, entry.getKey()));
if (null != namespaceMap) { // did application hand us some additional namespaces?
for (Map.Entry mapping : namespaceMap.entrySet()) {
// user gives us namespace->prefix mapping.
e.addNamespaceDeclaration(Namespace.getNamespace(mapping.getValue(),
mapping.getKey()));
}
}
// if the user didn't pick something else, assign 'tns' as the prefix.
if (namespaceMap == null || !namespaceMap.containsKey(entry.getKey())) {
// Schemas are more readable if there is a specific prefix for the TNS.
e.addNamespaceDeclaration(Namespace.getNamespace(WSDLConstants.CONVENTIONAL_TNS_PREFIX,
entry.getKey()));
}
e.setAttribute(new Attribute("elementFormDefault", "qualified"));
e.setAttribute(new Attribute("attributeFormDefault", "qualified"));
for (Type t : entry.getValue()) {
t.writeSchema(e);
}
if (e.getChildren().size() == 0) {
continue;
}
try {
NamespaceMap nsMap = new NamespaceMap();
nsMap.add(xsdPrefix, XmlConstants.XSD);
// We prefer explicit prefixes over those generated in the types.
// This loop may have intended to support prefixes from individual aegis files,
// but that isn't a good idea.
for (Iterator itr = e.getAdditionalNamespaces().iterator(); itr.hasNext();) {
Namespace n = (Namespace) itr.next();
if (!nsMap.containsValue(n.getURI())) {
nsMap.add(n.getPrefix(), n.getURI());
}
}
org.w3c.dom.Document schema = new DOMOutputter().output(new Document(e));
for (ServiceInfo si : s.getServiceInfos()) {
SchemaCollection col = si.getXmlSchemaCollection();
col.setNamespaceContext(nsMap);
XmlSchema xmlSchema = addSchemaDocument(si, col, schema, entry.getKey());
// Work around bug in JDOM DOMOutputter which fails to correctly
// assign namespaces to attributes. If JDOM worked right,
// the collection object would get the prefixes for itself.
xmlSchema.setNamespaceContext(nsMap);
}
} catch (JDOMException e1) {
throw new ServiceConstructionException(e1);
}
}
}
public QName getSuggestedName(Service s, TypeMapping tm, OperationInfo op, int param) {
Method m = getMethod(s, op);
if (m == null) {
return null;
}
QName name = tm.getTypeCreator().getElementName(m, param);
// No mapped name was specified, so if its a complex type use that name
// instead
if (name == null) {
Type type = tm.getTypeCreator().createType(m, param);
if (type.isComplex() && !type.isAbstract()) {
name = type.getSchemaType();
}
}
return name;
}
private Type getParameterType(Service s, TypeMapping tm, MessagePartInfo param, int paramtype) {
Type type = tm.getType(param.getTypeQName());
/*
* if (type == null && tm.isRegistered(param.getTypeClass())) { type =
* tm.getType(param.getTypeClass()); part2type.put(param, type); }
*/
int offset = 0;
if (paramtype == OUT_PARAM) {
offset = 1;
}
TypeCreator typeCreator = tm.getTypeCreator();
if (type == null) {
OperationInfo op = param.getMessageInfo().getOperation();
Method m = getMethod(s, op);
TypeClassInfo info;
if (paramtype != FAULT_PARAM && m != null) {
info = typeCreator.createClassInfo(m, param.getIndex() - offset);
} else {
info = typeCreator.createBasicClassInfo(param.getTypeClass());
}
if (param.getMessageInfo().getOperation().isUnwrapped()
&& param.getTypeClass().isArray()) {
//The service factory expects arrays going into the wrapper to be
//mapped to the array component type and will then add
//min=0/max=unbounded. That doesn't work for Aegis where we
//already created a wrapper ArrayType so we'll let it know we want the default.
param.setProperty("minOccurs", "1");
param.setProperty("maxOccurs", "1");
param.setProperty("nillable", Boolean.TRUE);
}
if (info.getMappedName() != null) {
param.setConcreteName(info.getMappedName());
param.setName(info.getMappedName());
}
type = typeCreator.createTypeForClass(info);
// We have to register the type if we want minOccurs and such to work.
if (info.nonDefaultAttributes()) {
tm.register(type);
}
type.setTypeMapping(tm);
part2Type.put(param, type);
}
return type;
}
private Method getMethod(Service s, OperationInfo op) {
MethodDispatcher md = (MethodDispatcher)s.get(MethodDispatcher.class.getName());
SimpleMethodDispatcher smd = (SimpleMethodDispatcher)md;
return smd.getPrimaryMethod(op);
}
public Type getType(MessagePartInfo part) {
return part2Type.get(part);
}
public List getOverrideTypes() {
return overrideTypes;
}
public Service getService() {
return service;
}
/**
* Return the type mapping configuration associated with this databinding object.
* The configuration is retrieved from the type mapping registry.
* @return Returns the configuration.
*/
public Configuration getConfiguration() {
return typeMappingRegistry.getConfiguration();
}
/**
* Set the configuration for this databinding object.
* @param configuration The configuration to set.
*/
public void setConfiguration(Configuration configuration) {
typeMappingRegistry.setConfiguration(configuration);
}
}