com.unboundid.scim.marshal.xml.XmlStreamMarshaller Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of scim-sdk Show documentation
Show all versions of scim-sdk Show documentation
The UnboundID SCIM SDK is a library that may be used to interact with various
types of SCIM-enabled endpoints (such as the UnboundID server products) to
perform lightweight, cloud-based identity management via the SCIM Protocol.
See http://www.simplecloud.info for more information.
/*
* Copyright 2012-2019 Ping Identity Corporation
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License (GPLv2 only)
* or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see .
*/
package com.unboundid.scim.marshal.xml;
import com.unboundid.scim.data.BaseResource;
import com.unboundid.scim.marshal.StreamMarshaller;
import com.unboundid.scim.sdk.SCIMException;
import com.unboundid.scim.sdk.ServerErrorException;
import com.unboundid.scim.sdk.Debug;
import com.unboundid.scim.sdk.SCIMConstants;
import com.unboundid.scim.sdk.Resources;
import com.unboundid.scim.sdk.BulkOperation;
import com.unboundid.scim.sdk.SCIMAttribute;
import com.unboundid.scim.sdk.SCIMAttributeValue;
import com.unboundid.scim.sdk.StaticUtils;
import javax.xml.XMLConstants;
import javax.xml.bind.DatatypeConverter;
import javax.xml.stream.XMLOutputFactory;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamWriter;
import java.io.IOException;
import java.io.OutputStream;
import java.util.Collections;
import java.util.List;
import java.util.Set;
import java.util.concurrent.atomic.AtomicBoolean;
/**
* This class provides a stream marshaller implementation to write a stream of
* SCIM objects to their XML representation.
*/
public class XmlStreamMarshaller implements StreamMarshaller
{
private static final String xsiURI =
XMLConstants.W3C_XML_SCHEMA_INSTANCE_NS_URI;
private final OutputStream outputStream;
private final XMLStreamWriter xmlStreamWriter;
/**
* Create a new XML marshaller that writes to the provided output stream.
* The resulting marshaller must be closed after use.
*
* @param outputStream The output stream to be written by this marshaller.
*
* @throws SCIMException If the marshaller could not be created.
*/
public XmlStreamMarshaller(final OutputStream outputStream)
throws SCIMException
{
this.outputStream = outputStream;
try
{
final XMLOutputFactory outputFactory = XMLOutputFactory.newInstance();
xmlStreamWriter =
outputFactory.createXMLStreamWriter(outputStream, "UTF-8");
}
catch (Exception e)
{
Debug.debugException(e);
throw new ServerErrorException(
"Cannot create XML marshaller: " + e.getMessage());
}
}
/**
* {@inheritDoc}
*/
@Override
public void close() throws SCIMException
{
try
{
xmlStreamWriter.close();
}
catch (XMLStreamException e)
{
Debug.debugException(e);
}
try
{
outputStream.close();
}
catch (IOException e)
{
Debug.debugException(e);
}
}
/**
* {@inheritDoc}
*/
public void marshal(final BaseResource resource)
throws SCIMException
{
try
{
xmlStreamWriter.writeStartDocument("UTF-8", "1.0");
xmlStreamWriter.setDefaultNamespace(SCIMConstants.SCHEMA_URI_CORE);
final String resourceSchemaURI =
resource.getResourceDescriptor().getSchema();
xmlStreamWriter.writeStartElement(
SCIMConstants.DEFAULT_SCHEMA_PREFIX,
resource.getResourceDescriptor().getName(), resourceSchemaURI);
marshal(resource, xmlStreamWriter, null);
xmlStreamWriter.writeEndElement();
xmlStreamWriter.writeEndDocument();
}
catch (XMLStreamException e)
{
Debug.debugException(e);
throw new ServerErrorException(
"Cannot write resource: " + e.getMessage());
}
}
/**
* {@inheritDoc}
*/
public void marshal(final SCIMException response)
throws SCIMException
{
try
{
xmlStreamWriter.writeStartDocument("UTF-8", "1.0");
xmlStreamWriter.setPrefix(SCIMConstants.DEFAULT_SCHEMA_PREFIX,
SCIMConstants.SCHEMA_URI_CORE);
xmlStreamWriter.setPrefix("xsi", xsiURI);
xmlStreamWriter.writeStartElement(SCIMConstants.SCHEMA_URI_CORE,
"Response");
xmlStreamWriter.writeNamespace(SCIMConstants.DEFAULT_SCHEMA_PREFIX,
SCIMConstants.SCHEMA_URI_CORE);
xmlStreamWriter.writeNamespace("xsi", xsiURI);
xmlStreamWriter.writeStartElement(
SCIMConstants.SCHEMA_URI_CORE, "Errors");
xmlStreamWriter.writeStartElement(
SCIMConstants.SCHEMA_URI_CORE, "Error");
xmlStreamWriter.writeStartElement(
SCIMConstants.SCHEMA_URI_CORE, "code");
xmlStreamWriter.writeCharacters(String.valueOf(response.getStatusCode()));
xmlStreamWriter.writeEndElement();
final String description = response.getMessage();
if (description != null)
{
xmlStreamWriter.writeStartElement(
SCIMConstants.SCHEMA_URI_CORE, "description");
AtomicBoolean base64Encoded = new AtomicBoolean(false);
String cleanXML = cleanStringForXML(description, base64Encoded);
if (base64Encoded.get())
{
xmlStreamWriter.writeAttribute("base64Encoded", "true");
}
xmlStreamWriter.writeCharacters(cleanXML);
xmlStreamWriter.writeEndElement();
}
xmlStreamWriter.writeEndElement();
xmlStreamWriter.writeEndElement();
xmlStreamWriter.writeEndElement();
xmlStreamWriter.writeEndDocument();
}
catch (XMLStreamException e)
{
Debug.debugException(e);
throw new ServerErrorException(
"Cannot write error response: " + e.getMessage());
}
}
/**
* {@inheritDoc}
*/
public void marshal(final Resources response)
throws SCIMException
{
try
{
xmlStreamWriter.writeStartDocument("UTF-8", "1.0");
xmlStreamWriter.setPrefix(SCIMConstants.DEFAULT_SCHEMA_PREFIX,
SCIMConstants.SCHEMA_URI_CORE);
xmlStreamWriter.setPrefix("xsi", xsiURI);
xmlStreamWriter.writeStartElement(SCIMConstants.SCHEMA_URI_CORE,
"Response");
xmlStreamWriter.writeNamespace(SCIMConstants.DEFAULT_SCHEMA_PREFIX,
SCIMConstants.SCHEMA_URI_CORE);
xmlStreamWriter.writeNamespace("xsi", xsiURI);
xmlStreamWriter.writeStartElement("totalResults");
xmlStreamWriter.writeCharacters(
Long.toString(response.getTotalResults()));
xmlStreamWriter.writeEndElement();
xmlStreamWriter.writeStartElement("itemsPerPage");
xmlStreamWriter.writeCharacters(
Integer.toString(response.getItemsPerPage()));
xmlStreamWriter.writeEndElement();
xmlStreamWriter.writeStartElement("startIndex");
xmlStreamWriter.writeCharacters(
Long.toString(response.getStartIndex()));
xmlStreamWriter.writeEndElement();
xmlStreamWriter.writeStartElement("Resources");
for (final BaseResource resource : response)
{
xmlStreamWriter.writeStartElement("Resource");
marshal(resource, xmlStreamWriter, xsiURI);
xmlStreamWriter.writeEndElement();
}
xmlStreamWriter.writeEndElement();
xmlStreamWriter.writeEndElement();
xmlStreamWriter.writeEndDocument();
}
catch (XMLStreamException e)
{
Debug.debugException(e);
throw new ServerErrorException(
"Cannot write resources: " + e.getMessage());
}
}
/**
* {@inheritDoc}
*/
public void writeBulkStart(final int failOnErrors,
final Set schemaURIs)
throws SCIMException
{
try
{
xmlStreamWriter.writeStartDocument("UTF-8", "1.0");
xmlStreamWriter.setPrefix(SCIMConstants.DEFAULT_SCHEMA_PREFIX,
SCIMConstants.SCHEMA_URI_CORE);
xmlStreamWriter.setPrefix("xsi", xsiURI);
xmlStreamWriter.writeStartElement(SCIMConstants.SCHEMA_URI_CORE,
"Bulk");
xmlStreamWriter.writeNamespace(SCIMConstants.DEFAULT_SCHEMA_PREFIX,
SCIMConstants.SCHEMA_URI_CORE);
xmlStreamWriter.writeNamespace("xsi", xsiURI);
if (failOnErrors >= 0)
{
xmlStreamWriter.writeStartElement("failOnErrors");
xmlStreamWriter.writeCharacters(
Integer.toString(failOnErrors));
xmlStreamWriter.writeEndElement();
}
xmlStreamWriter.writeStartElement("Operations");
}
catch (XMLStreamException e)
{
Debug.debugException(e);
throw new ServerErrorException(
"Cannot write start of bulk operations: " + e.getMessage());
}
}
/**
* {@inheritDoc}
*/
public void writeBulkOperation(final BulkOperation o)
throws SCIMException
{
try
{
xmlStreamWriter.writeStartElement("Operation");
if (o.getMethod() != null)
{
xmlStreamWriter.writeStartElement("method");
xmlStreamWriter.writeCharacters(o.getMethod().name());
xmlStreamWriter.writeEndElement();
}
if (o.getBulkId() != null)
{
xmlStreamWriter.writeStartElement("bulkId");
xmlStreamWriter.writeCharacters(o.getBulkId());
xmlStreamWriter.writeEndElement();
}
if (o.getVersion() != null)
{
xmlStreamWriter.writeStartElement("version");
xmlStreamWriter.writeCharacters(o.getVersion());
xmlStreamWriter.writeEndElement();
}
if (o.getPath() != null)
{
xmlStreamWriter.writeStartElement("path");
AtomicBoolean base64Encoded = new AtomicBoolean(false);
String cleanXML = cleanStringForXML(o.getPath(), base64Encoded);
if(base64Encoded.get())
{
xmlStreamWriter.writeAttribute("base64Encoded", "true");
}
xmlStreamWriter.writeCharacters(cleanXML);
xmlStreamWriter.writeEndElement();
}
if (o.getLocation() != null)
{
xmlStreamWriter.writeStartElement("location");
AtomicBoolean base64Encoded = new AtomicBoolean(false);
String cleanXML = cleanStringForXML(o.getLocation(), base64Encoded);
if(base64Encoded.get())
{
xmlStreamWriter.writeAttribute("base64Encoded", "true");
}
xmlStreamWriter.writeCharacters(cleanXML);
xmlStreamWriter.writeEndElement();
}
if (o.getData() != null)
{
xmlStreamWriter.writeStartElement("data");
marshal(o.getData(), xmlStreamWriter, xsiURI);
xmlStreamWriter.writeEndElement();
}
if (o.getStatus() != null)
{
xmlStreamWriter.writeStartElement("status");
xmlStreamWriter.writeStartElement("code");
xmlStreamWriter.writeCharacters(o.getStatus().getCode());
xmlStreamWriter.writeEndElement();
if (o.getStatus().getDescription() != null)
{
xmlStreamWriter.writeStartElement("description");
AtomicBoolean base64Encoded = new AtomicBoolean(false);
String cleanXML =
cleanStringForXML(o.getStatus().getDescription(), base64Encoded);
if(base64Encoded.get())
{
xmlStreamWriter.writeAttribute("base64Encoded", "true");
}
xmlStreamWriter.writeCharacters(cleanXML);
xmlStreamWriter.writeEndElement();
}
xmlStreamWriter.writeEndElement();
}
xmlStreamWriter.writeEndElement();
}
catch (XMLStreamException e)
{
Debug.debugException(e);
throw new ServerErrorException(
"Cannot write bulk operation: " + e.getMessage());
}
}
/**
* {@inheritDoc}
*/
public void writeBulkFinish()
throws SCIMException
{
try
{
xmlStreamWriter.writeEndElement();
xmlStreamWriter.writeEndElement();
xmlStreamWriter.writeEndDocument();
}
catch (XMLStreamException e)
{
Debug.debugException(e);
throw new ServerErrorException(
"Cannot write end of bulk operations: " + e.getMessage());
}
}
/**
* {@inheritDoc}
*/
public void bulkMarshal(final int failOnErrors,
final List operations)
throws SCIMException
{
writeBulkStart(failOnErrors, Collections.emptySet());
for (final BulkOperation o : operations)
{
writeBulkOperation(o);
}
writeBulkFinish();
}
/**
* Write a SCIM object to an XML stream.
*
* @param resource The SCIM resource to be written.
* @param xmlStreamWriter The stream to which the SCIM object should be
* written.
* @param xsiURI The xsi URI to use for the type attribute.
* @throws XMLStreamException If the object could not be written.
*/
private void marshal(final BaseResource resource,
final XMLStreamWriter xmlStreamWriter,
final String xsiURI)
throws XMLStreamException
{
final String resourceSchemaURI =
resource.getResourceDescriptor().getSchema();
int i = 1;
for (final String schemaURI :
resource.getResourceDescriptor().getAttributeSchemas())
{
if (schemaURI.equalsIgnoreCase(resourceSchemaURI))
{
final String prefix = SCIMConstants.DEFAULT_SCHEMA_PREFIX;
xmlStreamWriter.setPrefix(prefix, schemaURI);
xmlStreamWriter.writeNamespace(prefix, schemaURI);
}
else if (resource.getScimObject().hasSchema(schemaURI))
{
final String prefix = "ns" + String.valueOf(i++);
xmlStreamWriter.setPrefix(prefix, schemaURI);
xmlStreamWriter.writeNamespace(prefix, schemaURI);
}
}
if (xsiURI != null)
{
xmlStreamWriter.writeAttribute(xsiURI, "type",
SCIMConstants.DEFAULT_SCHEMA_PREFIX + ':' +
resource.getResourceDescriptor().getName());
}
for (String schema : resource.getScimObject().getSchemas())
{
for (SCIMAttribute a : resource.getScimObject().getAttributes(schema))
{
if (a.getAttributeDescriptor().isMultiValued())
{
writeMultiValuedAttribute(a, xmlStreamWriter);
}
else
{
writeSingularAttribute(a, xmlStreamWriter);
}
}
}
}
/**
* Write a multi-valued attribute to an XML stream.
*
* @param scimAttribute The attribute to be written.
* @param xmlStreamWriter The stream to which the attribute should be
* written.
* @throws XMLStreamException If the attribute could not be written.
*/
private void writeMultiValuedAttribute(final SCIMAttribute scimAttribute,
final XMLStreamWriter xmlStreamWriter)
throws XMLStreamException
{
final SCIMAttributeValue[] values = scimAttribute.getValues();
writeStartElement(scimAttribute, xmlStreamWriter);
for (final SCIMAttributeValue value : values)
{
if (value == null)
{
continue;
}
writeChildStartElement(scimAttribute, xmlStreamWriter);
if (value.isComplex())
{
for (final SCIMAttribute a : value.getAttributes().values())
{
if (a.getAttributeDescriptor().isMultiValued())
{
writeMultiValuedAttribute(a, xmlStreamWriter);
}
else
{
writeSingularAttribute(a, xmlStreamWriter);
}
}
}
else
{
String stringValue = value.getStringValue();
AtomicBoolean base64Encoded = new AtomicBoolean(false);
String cleanXML = cleanStringForXML(stringValue, base64Encoded);
if(base64Encoded.get())
{
xmlStreamWriter.writeAttribute("base64Encoded", "true");
}
xmlStreamWriter.writeCharacters(cleanXML);
}
xmlStreamWriter.writeEndElement();
}
xmlStreamWriter.writeEndElement();
}
/**
* Write a singular attribute to an XML stream.
*
* @param scimAttribute The attribute to be written.
* @param xmlStreamWriter The stream to which the attribute should be
* written.
* @throws XMLStreamException If the attribute could not be written.
*/
private void writeSingularAttribute(final SCIMAttribute scimAttribute,
final XMLStreamWriter xmlStreamWriter)
throws XMLStreamException
{
writeStartElement(scimAttribute, xmlStreamWriter);
final SCIMAttributeValue val = scimAttribute.getValue();
if (val.isComplex())
{
for (final SCIMAttribute a : val.getAttributes().values())
{
if (a.getAttributeDescriptor().isMultiValued())
{
writeMultiValuedAttribute(a, xmlStreamWriter);
}
else
{
writeSingularAttribute(a, xmlStreamWriter);
}
}
}
else
{
String stringValue = scimAttribute.getValue().getStringValue();
AtomicBoolean base64Encoded = new AtomicBoolean(false);
String cleanXML = cleanStringForXML(stringValue, base64Encoded);
if(base64Encoded.get())
{
xmlStreamWriter.writeAttribute("base64Encoded", "true");
}
xmlStreamWriter.writeCharacters(cleanXML);
}
xmlStreamWriter.writeEndElement();
}
/**
* Helper that writes namespace when needed.
* @param scimAttribute Attribute tag to write.
* @param xmlStreamWriter Writer to write with.
* @throws XMLStreamException thrown if error writing the tag element.
*/
private void writeStartElement(final SCIMAttribute scimAttribute,
final XMLStreamWriter xmlStreamWriter)
throws XMLStreamException
{
if (scimAttribute.getSchema().equalsIgnoreCase(
SCIMConstants.SCHEMA_URI_CORE))
{
xmlStreamWriter.writeStartElement(scimAttribute.getName());
}
else
{
xmlStreamWriter.writeStartElement(scimAttribute.getSchema(),
scimAttribute.getName());
}
}
/**
* Helper that writes namespace when needed.
* @param scimAttribute Attribute tag to write.
* @param xmlStreamWriter Writer to write with.
* @throws XMLStreamException thrown if error writing the tag element.
*/
private void writeChildStartElement(final SCIMAttribute scimAttribute,
final XMLStreamWriter xmlStreamWriter)
throws XMLStreamException
{
if (scimAttribute.getSchema().equalsIgnoreCase(
SCIMConstants.SCHEMA_URI_CORE))
{
xmlStreamWriter.writeStartElement(scimAttribute.getAttributeDescriptor().
getMultiValuedChildName());
}
else
{
xmlStreamWriter.writeStartElement(scimAttribute.getSchema(),
scimAttribute.getAttributeDescriptor().getMultiValuedChildName());
}
}
/**
* This method determines whether the input string contains invalid XML
* unicode characters as specified by the XML 1.0 standard, and thus needs
* to be base-64 encoded. It also replaces any unicode characters greater
* than 0x7F with their decimal equivalent of their unicode code point
* (for example the Copyright sign (0xC2A9) becomes 슩)
*
* The returned string is either:
*
* 1) The base-64 encoding of the UTF-8 bytes of the original input string,
* iff the original input string contained any invalid XML characters,
*
* or
*
* 2) The original input string with any characters greater than 0x7f
* replaced with the corresponding unicode code point.
*
* @param input The input string value to clean
* @param base64Encoded An output parameter indicating whether the returned
* string is base64-encoded.
* @return an XML-safe version of the input string, possibly base64-encoded
* if the input contained invalid XML characters.
*/
private static String cleanStringForXML(final String input,
final AtomicBoolean base64Encoded)
{
if (input == null || input.isEmpty())
{
return "";
}
//Buffer to hold the escaped output.
StringBuilder output = new StringBuilder(input.length());
char c;
for(int i = 0; i < input.length(); i++)
{
c = input.charAt(i);
if((c == 0x9) ||
(c == 0xA) ||
(c == 0xD) ||
((c >= 0x20) && (c <= 0xD7FF)) ||
((c >= 0xE000) && (c <= 0xFFFD)) ||
((c >= 0x10000) && (c <= 0x10FFFF)))
{
//It's a valid XML character, now check if it needs escaping.
if (c > 0x7F)
{
output.append("&#").append(Integer.toString(c, 10)).append(";");
}
else
{
output.append(c);
}
continue;
}
else
{
//It's an invalid XML character, so base64-encode the whole thing.
if (base64Encoded != null)
{
base64Encoded.set(true);
}
return DatatypeConverter.printBase64Binary(
StaticUtils.getUTF8Bytes(input));
}
}
if(base64Encoded != null)
{
base64Encoded.set(false);
}
return output.toString();
}
}