org.eclipse.persistence.internal.oxm.XMLBinaryAttachmentHandler Maven / Gradle / Ivy
Show all versions of eclipselink Show documentation
/*
* Copyright (c) 1998, 2021 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0,
* or the Eclipse Distribution License v. 1.0 which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
*/
// Contributors:
// Oracle - initial API and implementation from Oracle TopLink
package org.eclipse.persistence.internal.oxm;
import jakarta.activation.DataHandler;
import org.eclipse.persistence.exceptions.XMLMarshalException;
import org.eclipse.persistence.internal.core.queries.CoreContainerPolicy;
import org.eclipse.persistence.internal.oxm.mappings.BinaryDataCollectionMapping;
import org.eclipse.persistence.internal.oxm.mappings.Field;
import org.eclipse.persistence.internal.oxm.mappings.Mapping;
import org.eclipse.persistence.internal.oxm.mappings.XMLConverterMapping;
import org.eclipse.persistence.internal.oxm.record.UnmarshalRecord;
import org.eclipse.persistence.internal.oxm.record.XMLReader;
import org.eclipse.persistence.oxm.attachment.XMLAttachmentUnmarshaller;
import org.xml.sax.Attributes;
import org.xml.sax.SAXException;
/**
* INTERNAL:
* Purpose:This class is a content handler that specifically handles the "Include" element in an mtom style
* attachment.
* @author mmacivor
*/
public class XMLBinaryAttachmentHandler extends org.eclipse.persistence.internal.oxm.record.UnmarshalRecordImpl {
UnmarshalRecord record;
Mapping mapping;
String c_id = null;
XMLConverterMapping converter;
NodeValue nodeValue;
boolean isCollection = false;
private static final String INCLUDE_ELEMENT_NAME = "Include";
private static final String HREF_ATTRIBUTE_NAME = "href";
public XMLBinaryAttachmentHandler(UnmarshalRecord unmarshalRecord, NodeValue nodeValue, Mapping mapping, XMLConverterMapping converter, boolean isCollection) {
super(null);
record = unmarshalRecord;
this.mapping = mapping;
this.nodeValue = nodeValue;
this.converter = converter;
this.isCollection = isCollection;
}
@Override
public void characters(char[] ch, int offset, int length) throws SAXException {
//we don't care about characters here. Probably a whitespace
}
@Override
public void startElement(String namespaceURI, String localName, String qName, Attributes atts) throws SAXException {
if(INCLUDE_ELEMENT_NAME.equals(localName) || INCLUDE_ELEMENT_NAME.equals(qName)) {
if(record.isNamespaceAware()){
if(Constants.XOP_URL.equals(namespaceURI)){
this.c_id = atts.getValue(Constants.EMPTY_STRING, HREF_ATTRIBUTE_NAME);
}
}else{
this.c_id = atts.getValue(Constants.EMPTY_STRING, HREF_ATTRIBUTE_NAME);
}
} else if(c_id == null ){
//Return control to the UnmarshalRecord
XMLReader xmlReader = record.getXMLReader();
xmlReader.setContentHandler(record);
xmlReader.setLexicalHandler(record);
record.startElement(namespaceURI, localName, qName, atts);
}
}
@Override
public void endElement(String namespaceURI, String localName, String qName) throws SAXException {
Field xmlField = null;
if(isCollection) {
xmlField = (Field) mapping.getField();
} else {
xmlField = (Field) mapping.getField();
}
if(INCLUDE_ELEMENT_NAME.equals(localName) || INCLUDE_ELEMENT_NAME.equals(qName)) {
if(record.isNamespaceAware() && !Constants.XOP_URL.equals(namespaceURI)){
return;
}
//Get the attachment and set it in the object.
XMLAttachmentUnmarshaller attachmentUnmarshaller = record.getUnmarshaller().getAttachmentUnmarshaller();
Object data = null;
Class attributeClassification = null;
if(isCollection) {
attributeClassification = ((BinaryDataCollectionMapping)mapping).getAttributeElementClass();
} else {
attributeClassification = mapping.getAttributeClassification();
}
if(attachmentUnmarshaller == null) {
//if there's no attachment unmarshaller, it isn't possible to retrieve
//the attachment. Throw an exception.
throw XMLMarshalException.noAttachmentUnmarshallerSet(this.c_id);
}
if(attributeClassification.equals(XMLBinaryDataHelper.getXMLBinaryDataHelper().DATA_HANDLER)) {
data = attachmentUnmarshaller.getAttachmentAsDataHandler(this.c_id);
} else {
data = attachmentUnmarshaller.getAttachmentAsByteArray(this.c_id);
}
CoreContainerPolicy cp = null;
if(isCollection){
cp = mapping.getContainerPolicy();
}
data = XMLBinaryDataHelper.getXMLBinaryDataHelper().convertObject(data, mapping.getAttributeClassification(), record.getSession(), cp);
data = converter.convertDataValueToObjectValue(data, record.getSession(), unmarshaller);
//check for collection case
if (isCollection) {
if(data != null) {
record.addAttributeValue((ContainerValue)nodeValue, data);
}
} else {
record.setAttributeValue(data, mapping);
}
//Return control to the UnmarshalRecord
if(!xmlField.isSelfField()){
XMLReader xmlReader = record.getXMLReader();
xmlReader.setContentHandler(record);
xmlReader.setLexicalHandler(record);
}
} else if(c_id == null){
if(!xmlField.isSelfField()){
//Return control to the parent record
XMLReader xmlReader = record.getXMLReader();
xmlReader.setContentHandler(record);
xmlReader.setLexicalHandler(record);
record.endElement(namespaceURI, localName, qName);
}
}
}
@Override
public void processingInstruction(String target, String data) throws SAXException {
}
public String getCID() {
return this.c_id;
}
public Object getObjectValueFromDataHandler(DataHandler handler, Class cls) {
CoreContainerPolicy cp = null;
if(isCollection){
cp = mapping.getContainerPolicy();
}
return XMLBinaryDataHelper.getXMLBinaryDataHelper().convertObject(handler, cls, record.getSession(), cp);
}
}