org.openliberty.xmltooling

Class OpenLibertyHelpers

java.lang.Object

org.openliberty.xmltooling.OpenLibertyHelpers

public class OpenLibertyHelpers
extends Object

A group of methods that make it easier to build the tooling classes by modeling some string to object and visa-versa, providing some DOM clearing by modeling special cases of prepareForAssigment, cloning objects from the DOM to prevent exceptions that occur when you attempt to re-use opensaml modeled tooling objects, and some basic XML utilities.

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.opensaml.core.xml.XMLObjectBuilderFactory	builderFactory XMLObject builder factory
private static String	defaultDateFormat
private static DateTimeFormatter	defaultDateFormatter
static String	FALSE_STR
private static Logger	log
protected static org.opensaml.core.xml.io.MarshallerFactory	marshallerFactory XMLObject marshaller factory.
protected static net.shibboleth.utilities.java.support.xml.BasicParserPool	parserPool Parser pool
static String	TRUE_STR
protected static org.opensaml.core.xml.io.UnmarshallerFactory	unmarshallerFactory XMLObject marshaller factory.

Constructor Summary

Constructors

Constructor and Description
OpenLibertyHelpers()

Method Summary

Methods

Modifier and Type	Method and Description
static Boolean	booleanFromString(String booleanString) Safely create a Boolean from a String
static org.opensaml.core.xml.XMLObject	cloneXMLObject(org.opensaml.core.xml.XMLObject xmlObject) Clone an XMLObject
static org.opensaml.core.xml.XMLObject	createXMLObjectForQName(QName qname)
static DateTime	dateTimeForString(String dateTimeString) Attempt to convert a String into a DateTime object
static DateTimeFormatter	getDefaultDateFormatter() Returns a joda DateTimeFormatter for parsing and printing a DateTime
static Integer	integerFromString(String integerString) Safely create an Integer from a String
static Integer	positiveIntegerFromString(String integerString, Integer defaultValue) Safely create a positive Integer from a String
static DateTime	prepareForAssignment(DateTime oldValue, DateTime newValue, DateTimeFormatter formatter, org.opensaml.core.xml.AbstractXMLObject abstractXMLObject) Compares DateTime objects looking for change, using the specified DateTimeFormatter.
static Integer	prepareForAssignment(Integer oldValue, Integer newValue, org.opensaml.core.xml.AbstractXMLObject abstractXMLObject) Compares Integer values, releasing the DOM when oldValue and newValue are not equivalent
static String	prepareForAssignment(String oldStringValue, String newStringValue, org.opensaml.core.xml.AbstractXMLObject abstractXMLObject) Use this utility method to reset the DOM if required based on a change to the objects (element value or attribute value)
static <T> T	prepareForAssignment(T oldValue, T newValue, org.opensaml.core.xml.AbstractXMLObject abstractXMLObject) Compares two objects.
static String	prettyPrintXMLObject(org.opensaml.core.xml.XMLObject xmlObject) Takes an XMLObject as a parameter, marshalls it, and returns a pretty printed version of the generated XML.
static <E> E	selectFromAList(E[] list, String name) Takes a list of objects and allows the user to specify a selection by number.
static String	stringForDateTime(DateTime dateTime) Attempt to convert a DateTime object into a String
static String	stringFromBoolean(Boolean b, String defaultString)
static org.opensaml.core.xml.XMLObject	unmarshallElementFromFile(File elementFile) Unmarshalls an element file into its XMLObject.
protected static org.opensaml.core.xml.XMLObject	unmarshallElementFromFile(String elementFileName) Unmarshalls an element file into its XMLObject.
static org.opensaml.core.xml.XMLObject	unmarshallElementFromString(String inputString)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

private static Logger log

FALSE_STR

public static String FALSE_STR

TRUE_STR

public static String TRUE_STR

defaultDateFormat

private static String defaultDateFormat

defaultDateFormatter

private static DateTimeFormatter defaultDateFormatter

marshallerFactory

protected static org.opensaml.core.xml.io.MarshallerFactory marshallerFactory

XMLObject marshaller factory.

unmarshallerFactory

protected static org.opensaml.core.xml.io.UnmarshallerFactory unmarshallerFactory

XMLObject marshaller factory.

parserPool

protected static net.shibboleth.utilities.java.support.xml.BasicParserPool parserPool

Parser pool

builderFactory

protected static org.opensaml.core.xml.XMLObjectBuilderFactory builderFactory

XMLObject builder factory

Constructor Detail

OpenLibertyHelpers

public OpenLibertyHelpers()

Method Detail

createXMLObjectForQName

public static org.opensaml.core.xml.XMLObject createXMLObjectForQName(QName qname)

stringForDateTime

public static String stringForDateTime(DateTime dateTime)

Attempt to convert a DateTime object into a String

Parameters:

dateTime -

Returns:

dateTimeForString

public static DateTime dateTimeForString(String dateTimeString)

Attempt to convert a String into a DateTime object

Parameters:

dateTimeString -

Returns:

integerFromString

public static Integer integerFromString(String integerString)

Safely create an Integer from a String

Parameters:

integerString -

Returns:

positiveIntegerFromString

public static Integer positiveIntegerFromString(String integerString,
                                Integer defaultValue)

Safely create a positive Integer from a String

Parameters:

integerString -

Returns:

booleanFromString

public static Boolean booleanFromString(String booleanString)

Safely create a Boolean from a String

Parameters:

booleanString -

Returns:

stringFromBoolean

public static String stringFromBoolean(Boolean b,
                       String defaultString)

prepareForAssignment

public static String prepareForAssignment(String oldStringValue,
                          String newStringValue,
                          org.opensaml.core.xml.AbstractXMLObject abstractXMLObject)

Use this utility method to reset the DOM if required based on a change to the objects (element value or attribute value)

Parameters:

oldValue -

newValue -

abstractXMLObject -

Returns:

prepareForAssignment

public static <T> T prepareForAssignment(T oldValue,
                         T newValue,
                         org.opensaml.core.xml.AbstractXMLObject abstractXMLObject)

Compares two objects. Use this utility method for comparing enums or other objects

Parameters:

oldValue -

newValue -

abstractXMLObject -

Returns:

prepareForAssignment

public static DateTime prepareForAssignment(DateTime oldValue,
                            DateTime newValue,
                            DateTimeFormatter formatter,
                            org.opensaml.core.xml.AbstractXMLObject abstractXMLObject)

Compares DateTime objects looking for change, using the specified DateTimeFormatter. If no DateTimeFormatter is specified, the test is done on the DateTime objects themselves.

Parameters:

oldValue -

newValue -

formatter - optional, used to compare the eventual xml output based on formatting

abstractXMLObject - required and must be Non null

Returns:

prepareForAssignment

public static Integer prepareForAssignment(Integer oldValue,
                           Integer newValue,
                           org.opensaml.core.xml.AbstractXMLObject abstractXMLObject)

Compares Integer values, releasing the DOM when oldValue and newValue are not equivalent

Parameters:

oldValue -

newValue -

abstractXMLObject -

Returns:

getDefaultDateFormatter

public static DateTimeFormatter getDefaultDateFormatter()

Returns a joda DateTimeFormatter for parsing and printing a DateTime

Returns:

cloneXMLObject

public static org.opensaml.core.xml.XMLObject cloneXMLObject(org.opensaml.core.xml.XMLObject xmlObject)

Clone an XMLObject

Parameters:

xmlObject -

Returns:

prettyPrintXMLObject

public static String prettyPrintXMLObject(org.opensaml.core.xml.XMLObject xmlObject)

Takes an XMLObject as a parameter, marshalls it, and returns a pretty printed version of the generated XML.

Parameters:

xmlObject -

Returns:

selectFromAList

public static <E> E selectFromAList(E[] list,
                    String name)

Takes a list of objects and allows the user to specify a selection by number. This is only meant for use in a console/testing environment

Parameters:

list -

name -

Returns:

unmarshallElementFromString

public static org.opensaml.core.xml.XMLObject unmarshallElementFromString(String inputString)

unmarshallElementFromFile

public static org.opensaml.core.xml.XMLObject unmarshallElementFromFile(File elementFile)

Unmarshalls an element file into its XMLObject.

Returns:

the XMLObject from the file

unmarshallElementFromFile

protected static org.opensaml.core.xml.XMLObject unmarshallElementFromFile(String elementFileName)

Unmarshalls an element file into its XMLObject.

Returns:

the XMLObject from the file