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

Class WCMCheckMail

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

All Implemented Interfaces:

IICEElement, IICEExtensionRequest, IICERequestElement

public class WCMCheckMail
extends Object
implements IICEExtensionRequest

WCMCheckMail represents a wcm-check-mail extension request. With this request the client informs the server that it should check the INBOX of his mail repository for new ICE payloads.

Detailed information about ICE extensions could be found in the ICE 1.1 specification section 8.4 . wcm-check-mail format

 <!ELEMENT wcm-check-mail               EMPTY >
 <!ATTLIST wcm-check-mail
           subscription-id            CDATA           #REQUIRED
 >

Copyright 2004 SAP AG

Field Summary

static String

TAGNAME

Constructor Summary

WCMCheckMail(Attributes attributes)
Create a new WCMCheckMail extension request.

WCMCheckMail(String subscriptionID)
Create a new WCMCheckMail extension request.

Method Summary

String	getSubscriptionID() Get the id of the subscription to be pulled.
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

WCMCheckMail

public WCMCheckMail(String subscriptionID)

Create a new WCMCheckMail extension request.

Parameters:

subscriptionID - The id of the subscription which references should be updated

WCMCheckMail

public WCMCheckMail(Attributes attributes)

Create a new WCMCheckMail extension request. This constructor is used by ICEInput to decode an WCMResolveReferences request from an ICE payload.

Parameters:

attributes - The attributes of the wcm-check-mail tag

Method Detail

getSubscriptionID

public String getSubscriptionID()

Get the id of the subscription to be pulled.

Returns:

The if of the subscription to be pulled

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