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

Class ICEUnsolicitedNow

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

All Implemented Interfaces:

IICEElement, IICERequestElement

public class ICEUnsolicitedNow
extends Object
implements IICERequestElement

ICEUnsolicitedNow represents an ice-unsolicited-now request.

Detailed information of the unsolicited message operation of the ICE protocol in the ICE 1.1 specification section 3.10 . ice-unsolicited-now format

 <!ELEMENT ice-unsolicited-now               EMPTY >
 <!ATTLIST ice-unsolicited-now
                                    request-id CDATA #REQUIRED
 >

Copyright 2004 SAP AG

Field Summary

static String

TAGNAME

Constructor Summary

ICEUnsolicitedNow()
Create a new ICE unsolicited now request.

ICEUnsolicitedNow(Attributes attributes)
Create a new ICE unsolicited now request.

Method Summary

String	getRequestID() Get the identifier of the request.
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

ICEUnsolicitedNow

public ICEUnsolicitedNow()

Create a new ICE unsolicited now request.

ICEUnsolicitedNow

public ICEUnsolicitedNow(Attributes attributes)

Create a new ICE unsolicited now request. This constructor is used by ICEInput to decode an ICE unsolicited now request from an ICE payload.

Parameters:

attributes - The attributes of the ice-unsolicited-now tag

Method Detail

getRequestID

public String getRequestID()

Get the identifier of the request.

Returns:

The identifier of the request

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