Package se.litsec.opensaml.utils

Class ObjectUtils

  • public class ObjectUtils
extends Object
    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 (martin.lindstrom@litsec.se)

    • Method Detail

      • createSamlObject

        @Deprecated(forRemoval=true)
public static <T extends SAMLObject> T createSamlObject​(Class<T> clazz)
        Deprecated, for removal: This API element is subject to removal in a future version.
        use XMLObjectSupport.buildXMLObject(QName) instead
        Utility method for creating an OpenSAML 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.

        Type Parameters:
        T - the type of the class to create
        Parameters:
        clazz - the class to create
        Returns:
        the SAML object
        See Also:
        createSamlObject(Class, QName)

      • createSamlObject

        @Deprecated(forRemoval=true)
public static <T extends SAMLObject> T createSamlObject​(Class<T> clazz,
                                                        QName elementName)
        Deprecated, for removal: This API element is subject to removal in a future version.
        use XMLObjectSupport.buildXMLObject(QName, QName) instead
        Utility method for creating an OpenSAML SAMLObject given its element name.
        Type Parameters:
        T - the type
        Parameters:
        clazz - the class to create
        elementName - the element name to assign the object that is created.
        Returns:
        the SAML object

      • createXMLObject

        @Deprecated(forRemoval=true)
public static <T extends XMLObject> T createXMLObject​(Class<T> clazz,
                                                      QName elementName)
        Deprecated, for removal: This API element is subject to removal in a future version.
        use XMLObjectSupport.buildXMLObject(QName) instead
        Utility method for creating an XMLObject given its element name.
        Type Parameters:
        T - the type
        Parameters:
        clazz - the class to create
        elementName - the element name for the XML object to create
        Returns:
        the XML object

      • createXMLObject

        @Deprecated(forRemoval=true)
public static <T extends XMLObject> T createXMLObject​(Class<T> clazz,
                                                      QName registeredElementName,
                                                      QName elementNameToAssign)
        Deprecated, for removal: This API element is subject to removal in a future version.
        use XMLObjectSupport.buildXMLObject(QName, QName) instead
        Utility method for creating an XMLObject given its registered element name but where the elementNameToAssign is assigned to the object created.
        Type Parameters:
        T - the type
        Parameters:
        clazz - the class to create
        registeredElementName - the element name that the object is registered under
        elementNameToAssign - the element to assign to the object that is created
        Returns:
        the XML object

      • getDefaultElementName

        public static <T extends SAMLObject> QName getDefaultElementName​(Class<T> clazz)
        Returns the default element name for the supplied class
        Type Parameters:
        T - the type
        Parameters:
        clazz - class to check
        Returns:
        the default QName

      • getBuilder

        @Deprecated(forRemoval=true)
public static <T extends SAMLObject> XMLObjectBuilder<T> getBuilder​(Class<T> clazz)
        Deprecated, for removal: This API element is subject to removal in a future version.
        use XMLObjectSupport.getBuilder(QName) instead
        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.

        Type Parameters:
        T - the type
        Parameters:
        clazz - the class which we want a builder for
        Returns:
        a builder object
        See Also:
        getBuilder(QName)

      • getBuilder

        @Deprecated(forRemoval=true)
public static <T extends XMLObject> XMLObjectBuilder<T> getBuilder​(QName elementName)
        Deprecated, for removal: This API element is subject to removal in a future version.
        use XMLObjectSupport.getBuilder(QName) instead
        Returns the builder object that can be used to build object for the given element name.
        Type Parameters:
        T - the type
        Parameters:
        elementName - the element name for the XML object that the builder should return
        Returns:
        a builder object

      • unmarshall

        public static <T extends XMLObject> T unmarshall​(Element xml,
                                                 Class<T> targetClass)
                                          throws UnmarshallingException
        Unmarshalls the supplied element into the given type.
        Type Parameters:
        T - the type
        Parameters:
        xml - the DOM (XML) to unmarshall
        targetClass - the required class
        Returns:
        an XMLObject of the given type
        Throws:
        UnmarshallingException - for unmarshalling errors

      • toString

        public static <T extends SAMLObject> String toString​(T object)
                                              throws MarshallingException
        Returns the given SAML object in its "pretty print" XML string form.
        Type Parameters:
        T - the type of object to "print"
        Parameters:
        object - the object to display as a string
        Returns:
        the XML as a string
        Throws:
        MarshallingException - for marshalling errors

      • toStringSafe

        public static <T extends SAMLObject> String toStringSafe​(T object)
        The same as Object.toString() but the method never throws (returns the empty string instead). Useful for logging statements.
        Type Parameters:
        T - the type of object to "print"
        Parameters:
        object - the object to display as a string
        Returns:
        the XML as a string