org.eclipse.tptp.logging.events.cbe.util
Class EventHelpers

java.lang.Object
  org.eclipse.tptp.logging.events.cbe.util.EventHelpers

public class EventHelpers

extends java.lang.Object

Miscellaneous routines to support functions such as validation, mapping and comparison.

Since:

1.0.1

Constructor Summary

EventHelpers()

Method Summary

static boolean	compareUnorderedLists(java.util.List listOne, java.util.List listTwo) Compare two unordered List objects ignoring order.
static void	convertObjectToCommonBaseEvent(CommonBaseEvent commonBaseEvent, java.lang.Object object, int maxReferences) Converts the parameter object to a CommonBaseEvent based on the Common Base Event v1.0.1 schema and sets the Common Base Event properties on the parameter Common Base Event.
static CommonBaseEvent	convertObjectToCommonBaseEvent(java.lang.Object object, int maxReferences) Converts the parameter object to a CommonBaseEvent based on the Common Base Event v1.0.1 schema.
static ExtendedDataElement	convertToExtendedDataElement(java.lang.Throwable throwable) Maps data of the parameter java.lang.Throwable object to an Extended Data Element.
static ExtendedDataElement	convertToExtendedDataElement(java.lang.Throwable throwable, java.lang.String name) Maps data of the parameter java.lang.Throwable object to an Extended Data Element with the parameter name.
static long	dateToLong(java.lang.String xsdDateTimeString) Converts the creationTime from a string in XML Schema dateTime format (CCYY-MM-DDThh:mm:ss) to a long representing the milliseconds since 1970-01-01T00:00:00
static java.lang.String[]	getExtendedDataElementValuesArray(java.lang.String values) Convenience API to transpose a values string to a values array, thereby ensuring the parameter values string does not exceed the 1024 character limit, as stated in the Common Base Event v1.0.1 specification.
static java.lang.String	getFormattedDateString(long dateInMillis) Converts a long representing a coordinated universal time (UTC) date in milliseconds to a formatted string using the default date format pattern.
static java.lang.String	getFormattedDateString(long dateInMillis, java.lang.String dateFormatPattern) Converts a long representing a coordinated universal time (UTC) date in milliseconds to a formatted string using the parameter date format pattern.
static java.lang.String	getFormattedDateString(java.lang.String xsdDateTimeString) Converts a string representing an XML Schema dateTime (e.g.
static java.lang.String	getFormattedDateString(java.lang.String xsdDateTimeString, java.lang.String dateFormatPattern) Converts a string representing an XML Schema dateTime (e.g.
static java.lang.String	getString(java.lang.String key)
static java.lang.String	getString(java.lang.String key, java.lang.Object argument)
static java.lang.String	getString(java.lang.String key, java.lang.Object[] arguments)
static java.lang.String	getString(java.lang.String key, java.lang.Object argumentA, java.lang.Object argumentB)
static java.lang.String	getString(java.lang.String key, java.lang.Object argumentA, java.lang.Object argumentB, java.lang.Object argumentC)
static java.lang.String	getString(java.lang.String key, java.lang.Object argumentA, java.lang.Object argumentB, java.lang.Object argumentC, java.lang.Object argumentD)
static java.lang.String	longToDate(long dateInMillis) Converts a long representing UTC in milliseconds to the XML Schema datetime format (CCYY-MM-DDThh:mm:ssZ)

Methods inherited from class java.lang.Object

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

Constructor Detail

EventHelpers

public EventHelpers()

Method Detail

dateToLong

public static long dateToLong(java.lang.String xsdDateTimeString)

Converts the creationTime from a string in XML Schema dateTime format (CCYY-MM-DDThh:mm:ss) to a long representing the milliseconds since 1970-01-01T00:00:00

Parameters:

xsdDateTimeString - A string representing an XML Schema dateTime (e.g. yyyy-MM-ddTHH:mm:ss) date.

Returns:

The date in milliseconds since 1970-01-01T00:00:00Z. If the input cannot be converted or the date is older than 1970 then zero will be returned.

Throws:

java.lang.IllegalArgumentException - If the string representing an XML Schema dateTime (e.g. yyyy-MM-ddTHH:mm:ss) date is invalid.

See Also:

CommonBaseEvent.getCreationTimeAsLong()

longToDate

public static java.lang.String longToDate(long dateInMillis)

Converts a long representing UTC in milliseconds to the XML Schema datetime format (CCYY-MM-DDThh:mm:ssZ)

Parameters:

dateInMillis - A long representing a coordinated universal time (UTC) time stamp in milliseconds.

Returns:

The date in string format (CCYY-MM-DDThh:mm:ssZ)

Throws:

java.lang.IllegalArgumentException - If the long representing a coordinated universal time (UTC) time stamp in milliseconds is negative.

See Also:

CommonBaseEvent.setCreationTimeAsLong(long)

getString

public static java.lang.String getString(java.lang.String key)

getString

public static java.lang.String getString(java.lang.String key,
                                         java.lang.Object argument)

getString

public static java.lang.String getString(java.lang.String key,
                                         java.lang.Object argumentA,
                                         java.lang.Object argumentB)

getString

public static java.lang.String getString(java.lang.String key,
                                         java.lang.Object argumentA,
                                         java.lang.Object argumentB,
                                         java.lang.Object argumentC)

getString

public static java.lang.String getString(java.lang.String key,
                                         java.lang.Object argumentA,
                                         java.lang.Object argumentB,
                                         java.lang.Object argumentC,
                                         java.lang.Object argumentD)

getString

public static java.lang.String getString(java.lang.String key,
                                         java.lang.Object[] arguments)

convertToExtendedDataElement

public static ExtendedDataElement convertToExtendedDataElement(java.lang.Throwable throwable)

Maps data of the parameter java.lang.Throwable object to an Extended Data Element.

This API provides a structured representation of the parameter java.lang.Throwable object as an Extended Data Element with the following advantages:

• Efficient specialized parsibility and de-/serialization.
• Identifiable Extended Data Element name s (e.g. "Throwable" and "Cause")
• Captures all nested causal java.lang.Throwables.
• Adheres to the 1024-character restriction imposed on the Extended Data Element values.

NOTE: This API invoked in JRE 1.3.x and below run-time environments parses the stack trace produced by the java.lang.Throwable 'sprintStackTrace() API (e.g. no causal java.lang.Throwable (s)). Alternatively, this API invoked in JRE 1.4.x and above run-time environments utilizes the java.lang.Throwable's causal java.lang.Throwable and StackTraceElement (s) properties.

This API uses the following mapping to convert the parameter java.lang.Throwable object to an Extended Data Element:

• name = "Throwable"
• type = "stringArray"
• values[0...n] = < java.lang.Throwable's class name>[: < java.lang.Throwable's localized message>]
• values[(n + 1)...m] = < java.lang.Throwable's stackTraceElement[0...(m - (n + 1))]>
• children[0] = < java.lang.Throwable's cause>

This API uses the following mapping to convert the parameter java.lang.Throwable object to an Extended Data Element if the parameter java.lang.Throwable object is null:

• name = <name>
• type = "stringArray"
• values[0] =null

Causal java.lang.Throwable s are recursively converted to Extended Data Elements using the following mapping:

• name = "Cause"
• type = "stringArray"
• values[0...n] = <cause's class name>[: <cause's localized message>]
• values[(n + 1)...m] = <cause's stackTraceElement[0...(m - (n + 1))]>
• [children[0] = <cause's cause>]

...

NOTE: When the java.lang.Throwable's class name and localized message are greater than 1024 characters, the resultant class name and localized message string is segmented into a the first 1024-character elements of the values property. As such, the java.lang.Throwable's stack trace elements are transposed by the number of 1024-character elements in the values property.

Parameters:

throwable - The java.lang.Throwable object to be converted to an Extended Data Element.

Returns:

The Extended Data Element representation of the parameter java.lang.Throwable object.

convertToExtendedDataElement

public static ExtendedDataElement convertToExtendedDataElement(java.lang.Throwable throwable,
                                                               java.lang.String name)

Maps data of the parameter java.lang.Throwable object to an Extended Data Element with the parameter name.

This API provides a structured representation of the parameter java.lang.Throwable object as an Extended Data Element with the following advantages:

• Efficient specialized parsibility and de-/serialization.
• Identifiable Extended Data Element name s (e.g. <name> and "Cause")
• Captures all nested causal java.lang.Throwables.
• Adheres to the 1024-character restriction imposed on the Extended Data Element values.

NOTE: This API invoked in JRE 1.3.x and below run-time environments parses the stack trace produced by the java.lang.Throwable 'sprintStackTrace() API (e.g. no causal java.lang.Throwable (s)). Alternatively, this API invoked in JRE 1.4.x and above run-time environments utilizes the java.lang.Throwable's causal java.lang.Throwable and StackTraceElement (s) properties.

This API uses the following mapping to convert the parameter java.lang.Throwable object to an Extended Data Element:

• name = <name>
• type = "stringArray"
• values[0...n] = < java.lang.Throwable's class name>[: < java.lang.Throwable's localized message>]
• values[(n + 1)...m] = < java.lang.Throwable's stackTraceElement[0...(m - (n + 1))]>
• children[0] = < java.lang.Throwable's cause>

This API uses the following mapping to convert the parameter java.lang.Throwable object to an Extended Data Element if the parameter java.lang.Throwable object is null:

• name = <name>
• type = "stringArray"
• values[0] =null

Causal java.lang.Throwable s are recursively converted to Extended Data Elements using the following mapping:

• name = "Cause"
• type = "stringArray"
• values[0...n] = <cause's class name>[: <cause's localized message>]
• values[(n + 1)...m] = <cause's stackTraceElement[0...(m - (n + 1))]>
• [children[0] = <cause's cause>]

...

NOTE: When the java.lang.Throwable's class name and localized message are greater than 1024 characters, the resultant class name and localized message string is segmented into a the first 1024-character elements of the values property. As such, the java.lang.Throwable's stack trace elements are transposed by the number of 1024-character elements in the values property.

Parameters:

throwable - The java.lang.Throwable object to be converted to an Extended Data Element.

name - The name property of the Extended Data Element.

Returns:

The Extended Data Element representation of the parameter java.lang.Throwable object.

getExtendedDataElementValuesArray

public static java.lang.String[] getExtendedDataElementValuesArray(java.lang.String values)

Convenience API to transpose a values string to a values array, thereby ensuring the parameter values string does not exceed the 1024 character limit, as stated in the Common Base Event v1.0.1 specification.

If the parameter values property is larger than 1024 characters, the string is segmented into a String array of 1024-character elements. However, if the parameter values property is 1024 or less characters or null, the string is set directly on the first element a String array.

Parameters:

values - The values string to be transposed to a values array.

getFormattedDateString

public static java.lang.String getFormattedDateString(long dateInMillis)
                                               throws java.lang.IllegalArgumentException

Converts a long representing a coordinated universal time (UTC) date in milliseconds to a formatted string using the default date format pattern.

The default date format is:

MMMM d, yyyy h:mm:ss.SSS a z

For more information on the meaning of the individual symbols in the default date format pattern, see the class comment header for java.util.SimpleTimeZone.

The time zone of the returned string is coordinated universal time (UTC), represented as Greenwich Mean Time (GMT).

Parameters:

dateInMillis - A long representing a coordinated universal time (UTC) time stamp in milliseconds.

Returns:

The date as a formatted string using the default date format pattern (e.g. MMMM d, yyyy h:mm:ss.SSS a z).

Throws:

java.lang.IllegalArgumentException - If the long representing a coordinated universal time (UTC) time stamp in milliseconds is negative.

See Also:

SimpleTimeZone

getFormattedDateString

public static java.lang.String getFormattedDateString(long dateInMillis,
                                                      java.lang.String dateFormatPattern)
                                               throws java.lang.IllegalArgumentException

Converts a long representing a coordinated universal time (UTC) date in milliseconds to a formatted string using the parameter date format pattern.

For more information on the syntax and meaning of the individual symbols in the parameter date format pattern, see the class comment header for java.util.SimpleTimeZone.

The time zone of the returned string is coordinated universal time (UTC), represented as Greenwich Mean Time (GMT).

Parameters:

dateInMillis - A long representing a coordinated universal time (UTC) time stamp in milliseconds.

dateFormatPattern - The date format pattern (see java.util.SimpleTimeZone).

Returns:

The date as a formatted string using the parameter date format pattern.

Throws:

java.lang.IllegalArgumentException - If the long representing a coordinated universal time (UTC) time stamp in milliseconds is negative or the date format pattern (see java.util.SimpleTimeZone) is null or invalid.

See Also:

SimpleTimeZone

getFormattedDateString

public static java.lang.String getFormattedDateString(java.lang.String xsdDateTimeString)
                                               throws java.lang.IllegalArgumentException

Converts a string representing an XML Schema dateTime (e.g. yyyy-MM-ddTHH:mm:ss) date to a formatted string using the default date format pattern.

For more information on the XML Schema dateTime (e.g. yyyy-MM-ddTHH:mm:ss) date, see http://www.w3.org/TR/NOTE-datetime .

The default date format is:

MMMM d, yyyy h:mm:ss.SSS a z

For more information on the meaning of the individual symbols in the default date format pattern, see the class comment header for java.util.SimpleTimeZone.

If the parameter string representing an XML Schema dateTime (e.g. yyyy-MM-ddTHH:mm:ss) date does not contain any time zone information, the time zone of the returned string is coordinated universal time (UTC), represented as Greenwich Mean Time (GMT). Otherwise, the time zone of the returned string is represented as a signed offset from Greenwich Mean Time (GMT). For example, 'GMT-05:00' for Eastern Standard Time.

Parameters:

xsdDateTimeString - A string representing an XML Schema dateTime (e.g. yyyy-MM-ddTHH:mm:ss) date.

Returns:

The date as a formatted string using the default date format pattern (e.g. MMMM d, yyyy h:mm:ss.SSS a z).

Throws:

java.lang.IllegalArgumentException - If the string representing an XML Schema dateTime (e.g. yyyy-MM-ddTHH:mm:ss) date is invalid.

See Also:

SimpleTimeZone

getFormattedDateString

public static java.lang.String getFormattedDateString(java.lang.String xsdDateTimeString,
                                                      java.lang.String dateFormatPattern)
                                               throws java.lang.IllegalArgumentException

Converts a string representing an XML Schema dateTime (e.g. yyyy-MM-ddTHH:mm:ss) date to a formatted string using the parameter date format pattern.

For more information on the XML Schema dateTime (e.g. yyyy-MM-ddTHH:mm:ss) date, see http://www.w3.org/TR/NOTE-datetime .

For more information on the syntax and meaning of the individual symbols in the parameter date format pattern, see the class comment header for java.util.SimpleTimeZone.

If the parameter string representing an XML Schema dateTime (e.g. yyyy-MM-ddTHH:mm:ss) date does not contain any time zone information, the time zone of the returned string is coordinated universal time (UTC), represented as Greenwich Mean Time (GMT). Otherwise, the time zone of the returned string is represented as a signed offset from Greenwich Mean Time (GMT). For example, 'GMT-05:00' for Eastern Standard Time.

Parameters:

xsdDateTimeString - A string representing an XML Schema dateTime (e.g. yyyy-MM-ddTHH:mm:ss) date.

dateFormatPattern - The date format pattern (see java.util.SimpleTimeZone).

Returns:

The date as a formatted string using the parameter date format pattern.

Throws:

java.lang.IllegalArgumentException - If the string representing an XML Schema dateTime (e.g. yyyy-MM-ddTHH:mm:ss) date is invalid or the date format pattern (see java.util.SimpleTimeZone) is null or invalid.

See Also:

SimpleTimeZone

compareUnorderedLists

public static boolean compareUnorderedLists(java.util.List listOne,
                                            java.util.List listTwo)

Compare two unordered List objects ignoring order.

Parameters:

listOne - The first list in the comparison.

listTwo - The second list in the comparison.

Returns:

True if both parameter lists are equal ignoring order, otherwise false.

convertObjectToCommonBaseEvent

public static CommonBaseEvent convertObjectToCommonBaseEvent(java.lang.Object object,
                                                             int maxReferences)

Converts the parameter object to a CommonBaseEvent based on the Common Base Event v1.0.1 schema.

This method uses the following rules:

1. The creationTime Common Base Event property is set to the current time.
2. The globalInstanceId Common Base Event property is set to a unique GUID.
3. The situation Common Base Event property is set to an internal, log and report situation.
4. The sourceComponentId Common Base Event property is set to a default component ID for the calling logging facility.
5. All simple instance properties of the object are the value(s) of a ExtendedDataElement with the package and class name of the object as the 'name' property of the ExtendedDataElement.
6. All complex instance properties of the object are child ExtendedDataElement(s) of a ExtendedDataElement with the package and class name of the object as the 'name' property of the ExtendedDataElement.

Simple type of objects include:

• Java primitives (e.g. Boolean, Character, Byte, Short, Integer, Long, Float and Double)
• StringBuffer
• String
• BigDecimal
• BigInteger

If the parameter object is an instance of a CommonBaseEvent, it is cast to a CommonBaseEvent and returned.

Parameters:

object - The object to be converted to a Common Base Event.

maxReferences - The maximum number of referenced complex objects traversed.

Returns:

The generated Common Base Event from the parameter object.

convertObjectToCommonBaseEvent

public static void convertObjectToCommonBaseEvent(CommonBaseEvent commonBaseEvent,
                                                  java.lang.Object object,
                                                  int maxReferences)

Converts the parameter object to a CommonBaseEvent based on the Common Base Event v1.0.1 schema and sets the Common Base Event properties on the parameter Common Base Event.

This method uses the following rules:

1. The creationTime Common Base Event property is set to the current time, if not previously set.
2. The globalInstanceId Common Base Event property is set to a unique GUID, if not previously set.
3. The situation Common Base Event property is set to an internal, log and report situation, if not previously set.
4. The sourceComponentId Common Base Event property is set to a default component ID for the calling logging facility, if not previously set.
5. All simple instance properties of the object are the value(s) of a ExtendedDataElement with the package and class name of the object as the 'name' property of the ExtendedDataElement.
6. All complex instance properties of the object are child ExtendedDataElement(s) of a ExtendedDataElement with the package and class name of the object as the 'name' property of the ExtendedDataElement.

Simple type of objects include:

• Java primitives (e.g. Boolean, Character, Byte, Short, Integer, Long, Float and Double)
• StringBuffer
• String
• BigDecimal
• BigInteger

If the parameter object is an instance of a CommonBaseEvent, its properties are set on the parameter CommonBaseEvent using the precedence rules defined org.eclipse.hyades.logging.events.cbe.impl.TemplateContentHandlerImpl.

NOTE: The parameter CommonBaseEvent's existing ContentHandler, if any, is preserved for future use.

Parameters:

commonBaseEvent - The Common Base Event generated from converting the parameter object.

object - The object to be converted to a Common Base Event.

maxReferences - The maximum number of referenced complex objects traversed.