com.sapportals.wcm.protocol.ice.protocol.response

Class ICEEventMsg

java.lang.Object
  com.sapportals.wcm.protocol.ice.protocol.response.ICEEventMsg

All Implemented Interfaces:

IICEElementHandler, IICEElement, IDOMStorable

public class ICEEventMsg
extends Object
implements IICEElement, IICEElementHandler, IDOMStorable

ICEEventMsg represents an ice-event-msg element.

Detailed information about ICE event log could be found in the ICE 1.1 specification Section 6.3 . ice-event-info format

 <!ELEMENT ice-event-msg         (ice-code?,
                                   ice-event-data?) >
 <!ATTLIST ice-event-msg
           other-id              CDATA           #IMPLIED
           request               CDATA           #REQUIRED
           request-id            CDATA           #REQUIRED
           request-start         CDATA           #REQUIRED
           request-type          CDATA           #IMPLIED
           response              CDATA           #REQUIRED
           response-id           CDATA           #IMPLIED
           response-stop         CDATA           #REQUIRED
           response-type         CDATA           #IMPLIED
           role                  (requestor | responder)
                                                 #REQUIRED
           subscription-id       CDATA           #IMPLIED
 >

Copyright 2004 SAP AG

See Also:

ICEGetEvents

Field Summary

static String

TAGNAME

Constructor Summary

ICEEventMsg(Attributes attributes)
Create a new ICE event msg.

ICEEventMsg(Element element)
Create an ICEEventMsg object from a DOM-element.

ICEEventMsg(String request, String requestID, Date requestStart, String response, String responseID, Date responseStop, String subscriptionID, ICEEventRole role, ICECode code, ICEEventData data)
Create a new ICE event msg.

Method Summary

boolean	endElement(String name) Receive notification of the end of an element.
Date	getRequestStart() Get the time at which the request was received.
Date	getResponseStop() Get the time at which the processing was completed and the response was sent.
IICECharacterHandler	startElement(String name, Attributes attributes, PreparsedXML input) Receive notification of the beginning of an element.
Node	store(Document document) Store the informations into a DOM.
void	write(ContentHandler handler) Write the XML representation of the ICE element to a SAX ContentHandler.
boolean	writeChunk(ContentHandler handler) Write a chunk of XML to a SAX ContentHandler.

Methods inherited from class java.lang.Object

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

Field Detail

TAGNAME

public static final String TAGNAME

See Also:

Constant Field Values

Constructor Detail

ICEEventMsg

public ICEEventMsg(String request,
                   String requestID,
                   Date requestStart,
                   String response,
                   String responseID,
                   Date responseStop,
                   String subscriptionID,
                   ICEEventRole role,
                   ICECode code,
                   ICEEventData data)

Create a new ICE event msg.

Parameters:

request - The name of the request

requestID - The identifier of the request

requestStart - The timestamp of the request (start processing)

responseStop - The timestamp of the response (end of precessing)

subscriptionID - The identifier of the subscription

role - The role

code - The ice-code (might be null)

data - Additional data

response -

responseID -

ICEEventMsg

public ICEEventMsg(Attributes attributes)

Create a new ICE event msg. This constructor is used by ICEInput to decode an ICE event msg from an ICE payload.

Parameters:

attributes -

ICEEventMsg

public ICEEventMsg(Element element)

Create an ICEEventMsg object from a DOM-element.

Parameters:

element - A DOM-element containing the data of the event message

Method Detail

getRequestStart

public Date getRequestStart()

Get the time at which the request was received.

Returns:

The RequestStart value

getResponseStop

public Date getResponseStop()

Get the time at which the processing was completed and the response was sent.

Returns:

The time at which the processing was completed

startElement

public IICECharacterHandler startElement(String name,
                                         Attributes attributes,
                                         PreparsedXML input)
                                  throws SAXException

Receive notification of the beginning of an element. ICEInput invokes this method upon a start element event from the underlying SAX parser.

Specified by:

startElement in interface IICEElementHandler

Parameters:

name - The local name of the XML element (we don't need namespaces at this point)

input - The preparsed XML stream to get the element content

attributes -

Returns:

An IICECharacterHandler to receive the character events from the SAX parser or null if the character events could be ignored

Throws:

SAXException - on error (might wrap another exception)

endElement

public boolean endElement(String name)
                   throws SAXException

Receive notification of the end of an element. ICEInput invokes this method upon an end element event from the underlying SAX parser.

Specified by:

endElement in interface IICEElementHandler

Parameters:

name - The local name of the XML element (we don't need namespaces at this point)

Returns:

true if this handler should still receive SAX element events, false if this handler isn't interested in the following SAX element events

Throws:

SAXException - on error (might wrap another exception)

write

public void write(ContentHandler handler)
           throws SAXException

Write the XML representation of the ICE element to a SAX ContentHandler. This method is used by ICEOutput to create an ICE payload.

Specified by:

write in interface IICEElement

Parameters:

handler - The SAX ContentHandler (usually an XMLSerializer)

Throws:

SAXException - on error (might wrap another exception)

writeChunk

public boolean writeChunk(ContentHandler handler)
                   throws SAXException

Write a chunk of XML to a SAX ContentHandler. This method is used by ICEOutput to write an ICE payload in chunked mode.

Specified by:

writeChunk in interface IICEElement

Parameters:

handler - The SAX ContentHandler (usually a XMLSerializer)

Returns:

true if there are more chunks in the queue

Throws:

SAXException - on error (might wrap another exception)

store

public Node store(Document document)

Store the informations into a DOM.

Specified by:

store in interface IDOMStorable

Parameters:

document - The DOM document that should be used as factory for the DOM elements

Returns:

A Node containing the informations of the configuration object (this might be the document element of the XML that is eventually written to the repository)

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM