CBE Parser

This Parser extends the XML Parser, and is designed to read XML from the input stream and convert this XML to a CBE object; alternatively to write XML based on CBE objects as attributes provided. It operates similar to the CBE Function Component, except it is now packaged as a Parser. This means it can be attached to an input and/or output stream as part of a Connector's configuration instead of having to be deployed separately as another component in an AssemblyLine flow.

For example, it is possible you might want to save in a file all CBE objects received in some AssemblyLine; you could use a File system Connector in AddOnly mode with the CBE Parser and pass the CBE object itself to the "event" attribute of the Output Map.

We can read those CBE objects back in again using a File system Connector in Iterator mode with the CBE Parser configured, and you will receive the objects in the "event" attribute of the Input Map.

Using the Parser

When the CBE Parser reads from XML it returns all standard CBE attributes and the CBE object as attribute of the Input Map.

When the CBE Parser writes to XML it expects the CBE object to be set to the "event" attribute of the Output Map. In case the "event" is not set the CBE Parser expects that at least all the required CBE attributes are set in the Output Map otherwise an error will be thrown.

The XML passed to this parser should comply with the CBE specification and the CBE schema.

CBE Input and Output Map Attributes

The CBE specification has a complex structure. To enable you to define the attributes, a dotted notation for the attributes is supported in the attribute map for some of the components. To know more about these attributes and their suggested values please refer to the Autonomic Computing Toolkit Developer's Guide at: http://www-128.ibm.com/developerworks/autonomic/books/fpy0mst.html#ToC_91.

The following CBE Attributes list are the attributes that are used to create a CBE event object or the attributes that are going to be filled out from a CBE object provided to the event attribute or to the eventXml attribute of the Output Map.

Table 34. CBE attributes

Attribute Name	Attribute Type	Description
CreationTime	String	The time the event was created. Default value will be the time when the event object is created in the CBEGeneratorFC.
GlobalInstanceId	String	Primary Identifier of event. A unique id will be generated if not passed by user.
Message	String	Optional property
Severity	Integer	Optional property. Value ranges from 0 - 70
ExtensionName	String	Optional property.
SequenceNumber	Integer	Optional property
RepeatCount	Integer	Optional property.
ElapsedTime	Integer	Optional property if RepeatCount is not set.
Priority	Integer	Optional property. Values range from 0 - 100.
situation.		This notation defines properties of the situation object.
situation.CategoryName	String	Describes the type of Situation. Defined Values are StartSituation StopSituation ConnectSituation ConfigureSituation RequestSituation FeatureSituation DependencySituation CreateSituationDestroy SituationReportSituation AvailableSituation OtherSituation This is a required property.
situation.reasoningScope		Describes scope of the situation. This is a required property.
availableSituation.operationDisposition	String	Required if CategoryName is AvailableSituation
availableSituation.processingDisposition	String	Required if CategoryName is AvailableSituation
availableSituation.availabilityDisposition	String	Required if CategoryName is AvailableSituation
configureSituation.successDisposition	String	Required if CategoryName is ConfigureSituation
connectSituation.successDisposition	String	Required if CategoryName is ConnectSituation
connectSituation.situationDisposition	String	Required if CategoryName is ConnectSituation
createSituation.successDisposition	String	Required if CategoryName is CreateSituation
dependencySituation.dependencyDisposition	String	Required if CategoryName is DependencySituation
destroySituation.successDisposition	String	Required if CategoryName is DestroySituation
featureSituation.featureDisposition	String	Required if CategoryName is FeatureSituation
reportSituation.reportCategory	String	Required if CategoryName is ReportSituation
requestSituation.successDisposition	String	Required if CategoryName is RequestSituation
requestSituation.situationQualifier	String	Required if CategoryName is RequestSituation
startSituation.successDisposition	String	Required if CategoryName is StartSituation
startSituation.situationQualifier	String	Required if CategoryName is StartSituation
stopSituation.successDisposition	String	Required if CategoryName is StopSituation
stopSituation.situationQualifier	String	Required if CategoryName is StopSituation
otherSituation.any	String	Required if CategoryName is OtherSituation The value must be represented as an XML element in order for the XML to comply with the CBE 1.0.1 Schema (for example, <someTag> Any Text Value Inside </someTag>). The value should be wrapped in only one element (for example, this is not valid value: <someTag>val</someTag> <anotherTag>val2</anotherTag>).
SCI.		This notation describes the source component identification. These are required properties for a CommonBaseEvent.
SCI.location	String
SCI.locationType	String
SCI.executionEnvironment	String
SCI.component	String
SCI.subcomponent	String
SCI.componentIdType	String
SCI.componentType	String
RCI.		This notation describes component identification information for the reporter component. This is not a required property.
RCI.location	String
RCI.locationType	String
RCI.executionEnvironment	String
RCI.component	String
RCI.subcomponent	String
RCI.componentIdType	String
RCI.componentType	String
X.		This notation describes an ExtendedDataElement (EDE). This is not a required property.
X.attributeName	String	Creates EDE with name attribute Name and value defined by user
X.attributeName.childAttributeName	String	Creates EDE with name attribute Name and child element with name childAttributeName

When working with CBE objects using either the CBE FC or CBE Parser in an AssemblyLine, we will need to deal with Input and Output maps.

Table 35. Input map attributes

Attribute Name	Attribute Type	Description
Event	org.eclipse.hyades.logging.events.cbe.CommonBaseEvent	The CBE object converted from the attributes.
eventXml	String	The XML representation of the converted CBE object.
Including all the CBE attributes from table Table 34.

Table 36. Output map attributes

Attribute Name	Attribute Type	Description
Event	org.eclipse.hyades.logging.events.cbe.CommonBaseEvent	The CBE object that is going to be converted to attributes.
eventXml	String	The XML that is going to be parsed to CBE object and then converted to attributes.
Including all the CBE attributes from table Table 34.

Configuration

The CBE Parser uses the following parameters:

Character Encoding

Sets Character encoding to use when reading or writing. The default value is UTF-8.

When reading XML, this parameter will be used only if the input source does not already have encoding defined.

Since this parser extends the XML Parser, the same considerations as for that Parser apply.

Omit XML Declaration

When set, this causes the Parser to omit an XML declaration header in the output stream.

Validate XML

When set, this causes the Parser to validate the read XML with the XSD schema from the CBE specification.

Detailed Log

Checking this causes the Parser to output additional log messages.

See also

CBE Function Component,

XML Parser,

Simple XML Parser.