com.sapportals.wcm.protocol.ice.protocol

Class ICEReceiver

java.lang.Object
  com.sapportals.wcm.protocol.ice.protocol.ICEReceiver

All Implemented Interfaces:

IICEElement

public class ICEReceiver
extends Object
implements IICEElement

ICEReceiver represents an ice-receiver element. An ICEReceiver is part of the header informations to identify the receiver of an ICE payload. Detailed information about ICE receiver format could be found in the ICE 1.1 specification section 3.6.2 ice-receiver format

 <!ELEMENT ice-receiver          EMPTY >
 <!ATTLIST ice-receiver
           name                  CDATA           #REQUIRED
           receiver-id           CDATA           #REQUIRED
 >
 

Copyright 2004 SAP AG

Field Summary

static String

TAGNAME

Constructor Summary

ICEReceiver(Attributes attributes)
Create a new ICEReceiver.

ICEReceiver(com.sapportals.wcm.util.uuid.UUID receiverID, String name)
Create a new ICEReceiver.

Method Summary

com.sapportals.wcm.util.uuid.UUID	getReceiverID() Get the uuid of the receiver.
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

ICEReceiver

public ICEReceiver(com.sapportals.wcm.util.uuid.UUID receiverID,
                   String name)

Create a new ICEReceiver.

Parameters:

receiverID - A unique id of the receiver.

name - A read/displayable name of the receiver

ICEReceiver

public ICEReceiver(Attributes attributes)
            throws SAXException

Create a new ICEReceiver. This constructor is used by ICEInput to create an ICEReceiver from an incomming payload.

Parameters:

attributes - The attributes of the ice-receiver tag

Throws:

SAXException - Exception raised in failure situation

SAXException - if the ice-receiver tag is invalid

Method Detail

getReceiverID

public com.sapportals.wcm.util.uuid.UUID getReceiverID()

Get the uuid of the receiver.

Returns:

The uuid of the receiver

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