se.litsec.opensaml.utils.ObjectUtils Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of opensaml3-ext Show documentation
Show all versions of opensaml3-ext Show documentation
OpenSAML 3.X utility extension library
/*
* Copyright 2016-2018 Litsec AB
*
* Licensed 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 se.litsec.opensaml.utils;
import java.io.InputStream;
import javax.xml.namespace.QName;
import org.opensaml.core.xml.XMLObject;
import org.opensaml.core.xml.XMLObjectBuilder;
import org.opensaml.core.xml.XMLObjectBuilderFactory;
import org.opensaml.core.xml.XMLRuntimeException;
import org.opensaml.core.xml.config.XMLObjectProviderRegistrySupport;
import org.opensaml.core.xml.io.MarshallingException;
import org.opensaml.core.xml.io.Unmarshaller;
import org.opensaml.core.xml.io.UnmarshallingException;
import org.opensaml.core.xml.util.XMLObjectSupport;
import org.opensaml.saml.common.SAMLObject;
import org.w3c.dom.Element;
import net.shibboleth.utilities.java.support.xml.SerializeSupport;
import net.shibboleth.utilities.java.support.xml.XMLParserException;
/**
* Utility methods for creating OpenSAML objects within directly having to make use of the builders for each object you
* are creating and methods for marshalling and unmarshalling.
*
* @author Martin Lindström ([email protected])
*/
public class ObjectUtils {
/**
* Utility method for creating an OpenSAML {@code SAMLObject} using the default element name of the class.
*
* Note: The field DEFAULT_ELEMENT_NAME of the given class will be used as the object's element name.
*
*
* @param clazz
* the class to create
* @param
* the type of the class to create
* @return the SAML object
* @see #createSamlObject(Class, QName)
*/
public static T createSamlObject(Class clazz) {
return createSamlObject(clazz, getDefaultElementName(clazz));
}
/**
* Utility method for creating an OpenSAML {@code SAMLObject} given its element name.
*
* @param clazz
* the class to create
* @param elementName
* the element name to assign the object that is created.
* @param
* the type
* @return the SAML object
*/
public static T createSamlObject(Class clazz, QName elementName) {
XMLObjectBuilderFactory builderFactory = XMLObjectProviderRegistrySupport.getBuilderFactory();
XMLObjectBuilder builder = builderFactory.getBuilder(elementName);
if (builder == null) {
// No builder registered for the given element name. Try creating a builder for the default element name.
QName defaultElementName = getDefaultElementName(clazz);
if (!defaultElementName.equals(elementName)) {
builder = builderFactory.getBuilder(defaultElementName);
}
}
if (builder == null) {
// Still no builder? Time to fail.
throw new XMLRuntimeException("No builder registered for " + clazz.getName());
}
Object object = builder.buildObject(elementName);
return clazz.cast(object);
}
/**
* Utility method for creating an {@code XMLObject} given its element name.
*
* @param clazz
* the class to create
* @param elementName
* the element name for the XML object to create
* @param
* the type
* @return the XML object
*/
public static T createXMLObject(Class clazz, QName elementName) {
return XMLObjectProviderRegistrySupport.getBuilderFactory(). getBuilderOrThrow(elementName).buildObject(elementName);
}
/**
* Utility method for creating an {@code XMLObject} given its registered element name but where the
* {@code elementNameToAssign} is assigned to the object created.
*
* @param clazz
* the class to create
* @param registeredElementName
* the element name that the object is registered under
* @param elementNameToAssign
* the element to assign to the object that is created
* @param
* the type
* @return the XML object
*/
public static T createXMLObject(Class clazz, QName registeredElementName, QName elementNameToAssign) {
return XMLObjectProviderRegistrySupport.getBuilderFactory(). getBuilderOrThrow(registeredElementName).buildObject(
elementNameToAssign);
}
/**
* Returns the default element name for the supplied class
*
* @param clazz
* class to check
* @param
* the type
* @return the default QName
*/
public static QName getDefaultElementName(Class clazz) {
try {
return (QName) clazz.getDeclaredField("DEFAULT_ELEMENT_NAME").get(null);
}
catch (NoSuchFieldException | IllegalArgumentException | IllegalAccessException | SecurityException e) {
throw new XMLRuntimeException(e);
}
}
/**
* Returns the builder object that can be used to create objects of the supplied class type.
*
* Note: The field DEFAULT_ELEMENT_NAME of the given class will be used as the object's element name.
*
*
* @param clazz
* the class which we want a builder for
* @param
* the type
* @return a builder object
* @see #getBuilder(QName)
*/
public static XMLObjectBuilder getBuilder(Class clazz) {
return getBuilder(getDefaultElementName(clazz));
}
/**
* Returns the builder object that can be used to build object for the given element name.
*
* @param elementName
* the element name for the XML object that the builder should return
* @param
* the type
* @return a builder object
*/
@SuppressWarnings("unchecked")
public static XMLObjectBuilder getBuilder(QName elementName) {
return (XMLObjectBuilder) XMLObjectSupport.getBuilder(elementName);
}
/**
* Marshalls the supplied {@code XMLObject} into an {@code Element}.
*
* @param object
* the object to marshall
* @param
* the type
* @return an XML element
* @throws MarshallingException
* for marshalling errors
*/
public static Element marshall(T object) throws MarshallingException {
return XMLObjectSupport.marshall(object);
}
/**
* Unmarshalls the supplied element into the given type.
*
* @param xml
* the DOM (XML) to unmarshall
* @param targetClass
* the required class
* @param
* the type
* @return an {@code XMLObject} of the given type
* @throws UnmarshallingException
* for unmarshalling errors
*/
public static T unmarshall(Element xml, Class targetClass) throws UnmarshallingException {
Unmarshaller unmarshaller = XMLObjectSupport.getUnmarshaller(xml);
if (unmarshaller == null) {
throw new UnmarshallingException("No unmarshaller found for " + xml.getNodeName());
}
XMLObject xmlObject = unmarshaller.unmarshall(xml);
return targetClass.cast(xmlObject);
}
/**
* Unmarshalls the supplied input stream into the given type.
*
* @param inputStream
* the input stream of the XML resource
* @param targetClass
* the required class
* @param
* the type
* @return an {@code XMLObject} of the given type
* @throws XMLParserException
* for XML parsing errors
* @throws UnmarshallingException
* for unmarshalling errors
*/
public static T unmarshall(InputStream inputStream, Class targetClass) throws XMLParserException,
UnmarshallingException {
return unmarshall(XMLObjectProviderRegistrySupport.getParserPool().parse(inputStream).getDocumentElement(), targetClass);
}
/**
* Returns the given SAML object in its "pretty print" XML string form.
*
* @param
* the type of object to "print"
* @param object
* the object to display as a string
* @return the XML as a string
* @throws MarshallingException
* for marshalling errors
*/
public static String toString(T object) throws MarshallingException {
Element elm = ObjectUtils.marshall(object);
return SerializeSupport.prettyPrintXML(elm);
}
/**
* The same as {@link #toString()} but the method never throws (returns the empty string instead). Useful for logging
* statements.
*
* @param
* the type of object to "print"
* @param object
* the object to display as a string
* @return the XML as a string
*/
public static String toStringSafe(T object) {
try {
return toString(object);
}
catch (Exception e) {
return "";
}
}
// Hidden constructor.
private ObjectUtils() {
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy