com.sapportals.wcm.protocol.ice.protocol.request

Class ICEGetStatus

java.lang.Object
  com.sapportals.wcm.protocol.ice.protocol.request.ICEGetStatus

All Implemented Interfaces:

IICEElement, IICERequestElement

public class ICEGetStatus
extends Object
implements IICERequestElement

ICEGetStatus represents an ice-get-status request element.

Detailed informations about ICE get status requests could be found in the ICE 1.1 specification Section 4.6.3 . ice-get-status format

 <!ELEMENT ice-get-status        EMPTY >
 <!ATTLIST ice-get-status
           subscription-id       CDATA           #IMPLIED
 >

Copyright 2004 SAP AG

See Also:

ICEStatus

Field Summary

static String

TAGNAME

Constructor Summary

ICEGetStatus()
Create a default ICE get status request.

ICEGetStatus(Attributes attributes)
Create a new ICE get status request.

ICEGetStatus(String subscriptionID)
Create a new ICE get status request.

Method Summary

String	getSubscriptionID() Get the id of the subscription which status should be reported.
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

ICEGetStatus

public ICEGetStatus()

Create a default ICE get status request. With no explicit subscription id given the syndictor is required to report every subscription of the sender.

ICEGetStatus

public ICEGetStatus(String subscriptionID)

Create a new ICE get status request.

Parameters:

subscriptionID - The id of the subscription which status should be reported

ICEGetStatus

public ICEGetStatus(Attributes attributes)

Create a new ICE get status request. This constructor is used by ICEInput to decode an ICE nop request from an ICE payload.

Parameters:

attributes - The attributes of the ice-get-status element

Method Detail

getSubscriptionID

public String getSubscriptionID()

Get the id of the subscription which status should be reported.

Returns:

The id of the subscription

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-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