Java tutorial
/** * 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 com.msopentech.odatajclient.engine.data.impl; import com.msopentech.odatajclient.engine.client.ODataClient; import com.msopentech.odatajclient.engine.data.Entry; import com.msopentech.odatajclient.engine.data.Feed; import com.msopentech.odatajclient.engine.data.LinkCollection; import com.msopentech.odatajclient.engine.data.Link; import com.msopentech.odatajclient.engine.data.ODataBinder; import com.msopentech.odatajclient.engine.data.ODataCollectionValue; import com.msopentech.odatajclient.engine.data.ODataComplexValue; import com.msopentech.odatajclient.engine.data.ODataEntity; import com.msopentech.odatajclient.engine.data.ODataEntitySet; import com.msopentech.odatajclient.engine.data.ODataGeospatialValue; import com.msopentech.odatajclient.engine.data.ODataInlineEntity; import com.msopentech.odatajclient.engine.data.ODataInlineEntitySet; import com.msopentech.odatajclient.engine.data.ODataLink; import com.msopentech.odatajclient.engine.data.ODataLinkCollection; import com.msopentech.odatajclient.engine.data.ODataOperation; import com.msopentech.odatajclient.engine.data.ODataPrimitiveValue; import com.msopentech.odatajclient.engine.data.ODataProperty; import com.msopentech.odatajclient.engine.data.ODataProperty.PropertyType; import com.msopentech.odatajclient.engine.data.ODataServiceDocument; import com.msopentech.odatajclient.engine.data.ODataValue; import com.msopentech.odatajclient.engine.data.ResourceFactory; import com.msopentech.odatajclient.engine.data.ServiceDocument; import com.msopentech.odatajclient.engine.data.ServiceDocumentElement; import com.msopentech.odatajclient.engine.metadata.EdmType; import com.msopentech.odatajclient.engine.utils.ODataConstants; import com.msopentech.odatajclient.engine.utils.ODataVersion; import com.msopentech.odatajclient.engine.utils.URIUtils; import com.msopentech.odatajclient.engine.utils.XMLUtils; import java.io.StringWriter; import java.net.URI; import java.util.ArrayList; import java.util.List; import javax.xml.parsers.DocumentBuilder; import javax.xml.parsers.ParserConfigurationException; import org.apache.commons.lang3.StringUtils; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.w3c.dom.Document; import org.w3c.dom.Element; import org.w3c.dom.Node; import org.w3c.dom.NodeList; public abstract class AbstractODataBinder implements ODataBinder { private static final long serialVersionUID = 454285889193689536L; /** * Logger. */ protected final Logger LOG = LoggerFactory.getLogger(AbstractODataBinder.class); protected final ODataClient client; protected AbstractODataBinder(final ODataClient client) { this.client = client; } protected Element newEntryContent() { Element properties = null; try { final DocumentBuilder builder = XMLUtils.DOC_BUILDER_FACTORY.newDocumentBuilder(); final Document doc = builder.newDocument(); properties = doc.createElement(ODataConstants.ELEM_PROPERTIES); properties.setAttribute(ODataConstants.XMLNS_METADATA, client.getWorkingVersion().getNamespaceMap().get(ODataVersion.NS_METADATA)); properties.setAttribute(ODataConstants.XMLNS_DATASERVICES, client.getWorkingVersion().getNamespaceMap().get(ODataVersion.NS_DATASERVICES)); properties.setAttribute(ODataConstants.XMLNS_GML, ODataConstants.NS_GML); properties.setAttribute(ODataConstants.XMLNS_GEORSS, ODataConstants.NS_GEORSS); } catch (ParserConfigurationException e) { LOG.error("Failure building entry content", e); } return properties; } @Override public <T extends Feed> T getFeed(final ODataEntitySet feed, final Class<T> reference) { final T feedResource = ResourceFactory.newFeed(reference); final List<Entry> entries = new ArrayList<Entry>(); feedResource.setEntries(entries); final URI next = feed.getNext(); if (next != null) { feedResource.setNext(next); } for (ODataEntity entity : feed.getEntities()) { entries.add(getEntry(entity, ResourceFactory.entryClassForFeed(reference))); } feedResource.setEntries(entries); return feedResource; } @Override public <T extends Entry> T getEntry(final ODataEntity entity, final Class<T> reference) { return getEntry(entity, reference, true); } @Override @SuppressWarnings("unchecked") public <T extends Entry> T getEntry(final ODataEntity entity, final Class<T> reference, final boolean setType) { final T entry = ResourceFactory.newEntry(reference); entry.setType(entity.getName()); // ------------------------------------------------------------- // Add edit and self link // ------------------------------------------------------------- final URI editLink = entity.getEditLink(); if (editLink != null) { final Link entryEditLink = ResourceFactory.newLinkForEntry(reference); entryEditLink.setTitle(entity.getName()); entryEditLink.setHref(editLink.toASCIIString()); entryEditLink.setRel(ODataConstants.EDIT_LINK_REL); entry.setEditLink(entryEditLink); } if (entity.isReadOnly()) { final Link entrySelfLink = ResourceFactory.newLinkForEntry(reference); entrySelfLink.setTitle(entity.getName()); entrySelfLink.setHref(entity.getLink().toASCIIString()); entrySelfLink.setRel(ODataConstants.SELF_LINK_REL); entry.setSelfLink(entrySelfLink); } // ------------------------------------------------------------- // ------------------------------------------------------------- // Append navigation links (handling inline entry / feed as well) // ------------------------------------------------------------- // handle navigation links for (ODataLink link : entity.getNavigationLinks()) { // append link LOG.debug("Append navigation link\n{}", link); entry.addNavigationLink(getLinkResource(link, ResourceFactory.linkClassForEntry(reference))); } // ------------------------------------------------------------- // ------------------------------------------------------------- // Append edit-media links // ------------------------------------------------------------- for (ODataLink link : entity.getEditMediaLinks()) { LOG.debug("Append edit-media link\n{}", link); entry.addMediaEditLink(getLinkResource(link, ResourceFactory.linkClassForEntry(reference))); } // ------------------------------------------------------------- // ------------------------------------------------------------- // Append association links // ------------------------------------------------------------- for (ODataLink link : entity.getAssociationLinks()) { LOG.debug("Append association link\n{}", link); entry.addAssociationLink(getLinkResource(link, ResourceFactory.linkClassForEntry(reference))); } // ------------------------------------------------------------- final Element content = newEntryContent(); if (entity.isMediaEntity()) { entry.setMediaEntryProperties(content); entry.setMediaContentSource(entity.getMediaContentSource()); entry.setMediaContentType(entity.getMediaContentType()); } else { entry.setContent(content); } for (ODataProperty prop : entity.getProperties()) { content.appendChild(toDOMElement(prop, content.getOwnerDocument(), setType)); } return entry; } @Override public Element toDOMElement(final ODataProperty prop) { try { return toDOMElement(prop, XMLUtils.DOC_BUILDER_FACTORY.newDocumentBuilder().newDocument(), true); } catch (ParserConfigurationException e) { LOG.error("Error retrieving property DOM", e); throw new IllegalArgumentException(e); } } @Override public ODataLinkCollection getLinkCollection(final LinkCollection linkCollection) { final ODataLinkCollection collection = new ODataLinkCollection(linkCollection.getNext()); collection.setLinks(linkCollection.getLinks()); return collection; } @Override public ODataServiceDocument getODataServiceDocument(final ServiceDocument resource) { final ODataServiceDocument serviceDocument = new ODataServiceDocument(); for (ServiceDocumentElement entitySet : resource.getEntitySets()) { // handles V3 JSON format oddities, where title is not contained serviceDocument.getEntitySets().put( StringUtils.isBlank(entitySet.getTitle()) ? entitySet.getName() : entitySet.getTitle(), URIUtils.getURI(resource.getBaseURI(), entitySet.getHref())); } return serviceDocument; } @Override public ODataEntitySet getODataEntitySet(final Feed resource) { return getODataEntitySet(resource, null); } @Override public ODataEntitySet getODataEntitySet(final Feed resource, final URI defaultBaseURI) { if (LOG.isDebugEnabled()) { final StringWriter writer = new StringWriter(); client.getSerializer().feed(resource, writer); writer.flush(); LOG.debug("FeedResource -> ODataEntitySet:\n{}", writer.toString()); } final URI base = defaultBaseURI == null ? resource.getBaseURI() : defaultBaseURI; final URI next = resource.getNext(); final ODataEntitySet entitySet = next == null ? client.getObjectFactory().newEntitySet() : client.getObjectFactory().newEntitySet(URIUtils.getURI(base, next.toASCIIString())); if (resource.getCount() != null) { entitySet.setCount(resource.getCount()); } for (Entry entryResource : resource.getEntries()) { entitySet.addEntity(getODataEntity(entryResource)); } return entitySet; } @Override public ODataEntity getODataEntity(final Entry resource) { return getODataEntity(resource, null); } @Override public ODataEntity getODataEntity(final Entry resource, final URI defaultBaseURI) { if (LOG.isDebugEnabled()) { final StringWriter writer = new StringWriter(); client.getSerializer().entry(resource, writer); writer.flush(); LOG.debug("EntryResource -> ODataEntity:\n{}", writer.toString()); } final URI base = defaultBaseURI == null ? resource.getBaseURI() : defaultBaseURI; final ODataEntity entity = resource.getSelfLink() == null ? client.getObjectFactory().newEntity(resource.getType()) : client.getObjectFactory().newEntity(resource.getType(), URIUtils.getURI(base, resource.getSelfLink().getHref())); if (StringUtils.isNotBlank(resource.getETag())) { entity.setETag(resource.getETag()); } if (resource.getEditLink() != null) { entity.setEditLink(URIUtils.getURI(base, resource.getEditLink().getHref())); } for (Link link : resource.getAssociationLinks()) { entity.addLink(client.getObjectFactory().newAssociationLink(link.getTitle(), base, link.getHref())); } for (Link link : resource.getNavigationLinks()) { final Entry inlineEntry = link.getInlineEntry(); final Feed inlineFeed = link.getInlineFeed(); if (inlineEntry == null && inlineFeed == null) { entity.addLink( client.getObjectFactory().newEntityNavigationLink(link.getTitle(), base, link.getHref())); } else if (inlineFeed == null) { entity.addLink(client.getObjectFactory().newInlineEntity(link.getTitle(), base, link.getHref(), getODataEntity(inlineEntry, inlineEntry.getBaseURI() == null ? base : inlineEntry.getBaseURI()))); } else { entity.addLink(client.getObjectFactory().newInlineEntitySet(link.getTitle(), base, link.getHref(), getODataEntitySet(inlineFeed, inlineFeed.getBaseURI() == null ? base : inlineFeed.getBaseURI()))); } } for (Link link : resource.getMediaEditLinks()) { entity.addLink(client.getObjectFactory().newMediaEditLink(link.getTitle(), base, link.getHref())); } for (ODataOperation operation : resource.getOperations()) { operation.setTarget(URIUtils.getURI(base, operation.getTarget())); entity.addOperation(operation); } final Element content; if (resource.isMediaEntry()) { entity.setMediaEntity(true); entity.setMediaContentSource(resource.getMediaContentSource()); entity.setMediaContentType(resource.getMediaContentType()); content = resource.getMediaEntryProperties(); } else { content = resource.getContent(); } if (content != null) { for (Node property : XMLUtils.getChildNodes(content, Node.ELEMENT_NODE)) { try { entity.addProperty(getProperty((Element) property)); } catch (IllegalArgumentException e) { LOG.warn("Failure retrieving EdmType for {}", property.getTextContent(), e); } } } return entity; } @Override public <T extends Link> T getLinkResource(final ODataLink link, final Class<T> reference) { final T linkResource = ResourceFactory.newLink(reference); linkResource.setRel(link.getRel()); linkResource.setTitle(link.getName()); linkResource.setHref(link.getLink() == null ? null : link.getLink().toASCIIString()); linkResource.setType(link.getType().toString()); if (link instanceof ODataInlineEntity) { // append inline entity final ODataEntity inlineEntity = ((ODataInlineEntity) link).getEntity(); LOG.debug("Append in-line entity\n{}", inlineEntity); linkResource.setInlineEntry(getEntry(inlineEntity, ResourceFactory.entryClassForLink(reference))); } else if (link instanceof ODataInlineEntitySet) { // append inline feed final ODataEntitySet InlineFeed = ((ODataInlineEntitySet) link).getEntitySet(); LOG.debug("Append in-line feed\n{}", InlineFeed); linkResource.setInlineFeed(getFeed(InlineFeed, ResourceFactory.feedClassForLink(reference))); } return linkResource; } @Override public ODataProperty getProperty(final Element property) { final ODataProperty res; final Node nullNode = property.getAttributes().getNamedItem(ODataConstants.ATTR_NULL); if (nullNode == null) { final EdmType edmType = StringUtils.isBlank(property.getAttribute(ODataConstants.ATTR_M_TYPE)) ? null : newEdmType(property.getAttribute(ODataConstants.ATTR_M_TYPE)); final PropertyType propType = edmType == null ? guessPropertyType(property) : edmType.isCollection() ? PropertyType.COLLECTION : edmType.isSimpleType() ? PropertyType.PRIMITIVE : PropertyType.COMPLEX; switch (propType) { case COLLECTION: res = fromCollectionPropertyElement(property, edmType); break; case COMPLEX: res = fromComplexPropertyElement(property, edmType); break; case PRIMITIVE: res = fromPrimitivePropertyElement(property, edmType); break; case EMPTY: default: res = client.getObjectFactory().newPrimitiveProperty(XMLUtils.getSimpleName(property), null); } } else { res = client.getObjectFactory().newPrimitiveProperty(XMLUtils.getSimpleName(property), null); } return res; } protected PropertyType guessPropertyType(final Element property) { PropertyType res = null; if (property.hasChildNodes()) { final NodeList children = property.getChildNodes(); for (int i = 0; res == null && i < children.getLength(); i++) { final Node child = children.item(i); if (child.getNodeType() == Node.ELEMENT_NODE && !child.getNodeName().startsWith(ODataConstants.PREFIX_GML)) { res = ODataConstants.ELEM_ELEMENT.equals(XMLUtils.getSimpleName(child)) ? PropertyType.COLLECTION : PropertyType.COMPLEX; } } } else { res = PropertyType.EMPTY; } if (res == null) { res = PropertyType.PRIMITIVE; } return res; } protected Element toDOMElement(final ODataProperty prop, final Document doc, final boolean setType) { final Element element; if (prop.hasNullValue()) { // null property handling element = toNullPropertyElement(prop, doc); } else if (prop.hasPrimitiveValue()) { // primitive property handling element = toPrimitivePropertyElement(prop, doc, setType); } else if (prop.hasCollectionValue()) { // collection property handling element = toCollectionPropertyElement(prop, doc, setType); } else { // complex property handling element = toComplexPropertyElement(prop, doc, setType); } element.setAttribute(ODataConstants.XMLNS_METADATA, client.getWorkingVersion().getNamespaceMap().get(ODataVersion.NS_METADATA)); element.setAttribute(ODataConstants.XMLNS_DATASERVICES, client.getWorkingVersion().getNamespaceMap().get(ODataVersion.NS_DATASERVICES)); element.setAttribute(ODataConstants.XMLNS_GML, ODataConstants.NS_GML); element.setAttribute(ODataConstants.XMLNS_GEORSS, ODataConstants.NS_GEORSS); return element; } protected Element toNullPropertyElement(final ODataProperty prop, final Document doc) { final Element element = doc.createElement(ODataConstants.PREFIX_DATASERVICES + prop.getName()); element.setAttribute(ODataConstants.ATTR_NULL, Boolean.toString(true)); return element; } protected Element toPrimitivePropertyElement(final ODataProperty prop, final Document doc, final boolean setType) { return toPrimitivePropertyElement(prop.getName(), prop.getPrimitiveValue(), doc, setType); } protected Element toPrimitivePropertyElement(final String name, final ODataPrimitiveValue value, final Document doc, final boolean setType) { final Element element = doc.createElement(ODataConstants.PREFIX_DATASERVICES + name); if (setType) { element.setAttribute(ODataConstants.ATTR_M_TYPE, value.getTypeName()); } if (value instanceof ODataGeospatialValue) { element.appendChild(doc.importNode(((ODataGeospatialValue) value).toTree(), true)); } else { element.setTextContent(value.toString()); } return element; } protected Element toCollectionPropertyElement(final ODataProperty prop, final Document doc, final boolean setType) { if (!prop.hasCollectionValue()) { throw new IllegalArgumentException( "Invalid property value type " + prop.getValue().getClass().getSimpleName()); } final ODataCollectionValue value = prop.getCollectionValue(); final Element element = doc.createElement(ODataConstants.PREFIX_DATASERVICES + prop.getName()); if (value.getTypeName() != null && setType) { element.setAttribute(ODataConstants.ATTR_M_TYPE, value.getTypeName()); } for (ODataValue el : value) { if (el.isPrimitive()) { element.appendChild( toPrimitivePropertyElement(ODataConstants.ELEM_ELEMENT, el.asPrimitive(), doc, setType)); } else { element.appendChild( toComplexPropertyElement(ODataConstants.ELEM_ELEMENT, el.asComplex(), doc, setType)); } } return element; } protected Element toComplexPropertyElement(final ODataProperty prop, final Document doc, final boolean setType) { return toComplexPropertyElement(prop.getName(), prop.getComplexValue(), doc, setType); } protected Element toComplexPropertyElement(final String name, final ODataComplexValue value, final Document doc, final boolean setType) { final Element element = doc.createElement(ODataConstants.PREFIX_DATASERVICES + name); if (value.getTypeName() != null && setType) { element.setAttribute(ODataConstants.ATTR_M_TYPE, value.getTypeName()); } for (ODataProperty field : value) { element.appendChild(toDOMElement(field, doc, true)); } return element; } protected ODataPrimitiveValue fromPrimitiveValueElement(final Element prop, final EdmType edmType) { final ODataPrimitiveValue value; if (edmType != null && edmType.getSimpleType().isGeospatial()) { final Element geoProp = ODataConstants.PREFIX_GML.equals(prop.getPrefix()) ? prop : (Element) XMLUtils.getChildNodes(prop, Node.ELEMENT_NODE).get(0); value = client.getGeospatialValueBuilder().setType(edmType.getSimpleType()).setTree(geoProp).build(); } else { value = client.getPrimitiveValueBuilder().setType(edmType == null ? null : edmType.getSimpleType()) .setText(prop.getTextContent()).build(); } return value; } protected ODataProperty fromPrimitivePropertyElement(final Element prop, final EdmType edmType) { return client.getObjectFactory().newPrimitiveProperty(XMLUtils.getSimpleName(prop), fromPrimitiveValueElement(prop, edmType)); } protected ODataComplexValue fromComplexValueElement(final Element prop, final EdmType edmType) { final ODataComplexValue value = new ODataComplexValue(edmType == null ? null : edmType.getTypeExpression()); for (Node child : XMLUtils.getChildNodes(prop, Node.ELEMENT_NODE)) { value.add(getProperty((Element) child)); } return value; } protected ODataProperty fromComplexPropertyElement(final Element prop, final EdmType edmType) { return client.getObjectFactory().newComplexProperty(XMLUtils.getSimpleName(prop), fromComplexValueElement(prop, edmType)); } protected ODataProperty fromCollectionPropertyElement(final Element prop, final EdmType edmType) { final ODataCollectionValue value = new ODataCollectionValue( edmType == null ? null : edmType.getTypeExpression()); final EdmType type = edmType == null ? null : newEdmType(edmType.getBaseType()); final NodeList elements = prop.getChildNodes(); for (int i = 0; i < elements.getLength(); i++) { if (elements.item(i).getNodeType() != Node.TEXT_NODE) { final Element child = (Element) elements.item(i); switch (guessPropertyType(child)) { case COMPLEX: value.add(fromComplexValueElement(child, type)); break; case PRIMITIVE: value.add(fromPrimitiveValueElement(child, type)); break; default: // do not add null or empty values } } } return client.getObjectFactory().newCollectionProperty(XMLUtils.getSimpleName(prop), value); } protected abstract EdmType newEdmType(String expression); }