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

Class ICEStatus

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

All Implemented Interfaces:

IICEElementHandler, IICEElement, IICEResponseElement

public class ICEStatus
extends Object
implements IICEResponseElement, IICEElementHandler

ICEStatus represents an ice-status response element. Detailed information about the ICE status response could be found in the ICE 1.1 specification Section 4.6.3 . ice-status format

 <!ELEMENT ice-status    (ice-contact,
                          ice-subscription+)
 >

Copyright 2004 SAP AG

See Also:

ICEGetStatus

Field Summary

static String

TAGNAME

Constructor Summary

ICEStatus(Attributes attributes)
Create a new ICEStatus response.

ICEStatus(ICEContact contact, Collection subscriptions)
Create a new ICEStatus response.

Method Summary

boolean	endElement(String name) Receive notification of the end of an element.
ICEContact	getContact(ICEContact contact) Get the contact informations.
Collection	getSubscriptions() Get the subscriptions of the subscriber.
IICECharacterHandler	startElement(String name, Attributes attributes, PreparsedXML input) Receive notification of the beginning of an element.
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

ICEStatus

public ICEStatus(ICEContact contact,
                 Collection subscriptions)

Create a new ICEStatus response.

Parameters:

contact - The conctact informations

subscriptions - @todo: Description of the incoming method parameter

ICEStatus

public ICEStatus(Attributes attributes)

Create a new ICEStatus response. This constructor is used by ICEInput to decode an ICE catalog response from an ICE payload.

Parameters:

attributes - @todo: Description of the incoming method parameter

Method Detail

getContact

public ICEContact getContact(ICEContact contact)

Get the contact informations.

Parameters:

contact - @todo: Description of the incoming method parameter

Returns:

An ICEContact containing the contact informations

getSubscriptions

public Collection getSubscriptions()

Get the subscriptions of the subscriber.

Returns:

A collection of ICESubscription objects

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 - @todo: Description of the incoming method parameter

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)

Access Rights

This class can be accessed from:

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