com.sapportals.wcm.protocol.ice.protocol.handler

Interface IICESubRequestHandler

All Known Implementing Classes:

DefaultICESubRequestHandler

public interface IICESubRequestHandler

An IICESubRequestHandler handles the requests a subscriber might send to a syndicator. A syndicator (therefore) has to provide an implementation of this interface. An IICEISubRequestHandler is registered at the ICEInput of an incomming ICE payload.

Copyright 2004 SAP AG

See Also:

ICEInput

Method Summary

void	handleCancel(ICECancel cancel, ICEContext context) Handle an ICE cancel request (a request for subscription cancelation).
void	handleGetCatalog(ICEGetCatalog getCatalog, ICEContext context) Handle an ICE get catalog request.
void	handleGetPackage(ICEGetPackage getPackage, ICEContext context) Handle an ICE get package request.
void	handleGetSequence(ICEGetSequence getSequence, ICEContext context) Handle an ICE get sequence request.
void	handleOffer(ICEOffer offer, ICEContext context) Handle an ICE offer request (a request for subscription).
void	handleRepairItem(ICERepairItem repairItem, ICEContext context) Handle an ICE repair item request.

Method Detail

handleGetPackage

void handleGetPackage(ICEGetPackage getPackage,
                      ICEContext context)

Handle an ICE get package request. ICEInput invokes this method once it encounters an ice-get-package element inside an ice-request.

Detailed informations about ICE get package requests could be found in the ICE 1.1 specification Section 5.3 .

Parameters:

getPackage - The get package request

context - The context informations of the request

handleRepairItem

void handleRepairItem(ICERepairItem repairItem,
                      ICEContext context)

Handle an ICE repair item request. ICEInput invokes this method once if encounters and ice-repair-item element inside an ice-request.

Detailed informations about ICE repair item requests could be found in the ICE 1.1 specification Section 5.5.3 .

Parameters:

repairItem - The repair item request

context - The context informations of the request

handleGetCatalog

void handleGetCatalog(ICEGetCatalog getCatalog,
                      ICEContext context)

Handle an ICE get catalog request. ICEInput invokes this method once it encounters an ice-get-catalog element inseide an ice-request.

Detailed informations about ICE get catalog requests could be found in the ICE 1.1 specification Section 4.3.4 .

Parameters:

getCatalog - The ICE get catalog request

context - The context informations of the request

handleGetSequence

void handleGetSequence(ICEGetSequence getSequence,
                       ICEContext context)

Handle an ICE get sequence request. ICEInput invokes this method once it encounters an ice-get-sequence element inside an ice-request.

Detailed informations about ICE get sequence requests could be found in the ICE 1.1 specification Section 5.5.2 .

Parameters:

getSequence - The ICE get sequence request

context - The context informations of the request

handleOffer

void handleOffer(ICEOffer offer,
                 ICEContext context)

Handle an ICE offer request (a request for subscription). ICEInput invokes this method once it encounters an ice-offer element inside an ice-request.

Detailed informations about the ICE offer request and subscription establishment could be found in the ICE 1.1 specification Section 4.4

Parameters:

offer - The ICE offer request

context - The context informations of the request

handleCancel

void handleCancel(ICECancel cancel,
                  ICEContext context)

Handle an ICE cancel request (a request for subscription cancelation). ICEInput invokes this method once it encounters an ice-cancel element inside an ice-request.

Detailed informations about the ICE cancel request could be found in the ICE 1.1 specification 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