com.sapportals.wcm.service.ice

Interface IICEService

All Superinterfaces:

IService

public interface IICEService
extends IService

This is the entry point to the ICE service (Content Exchange Service) and provides methods to access the configuration of the syndicator and subscriber parts as well as their corresponding background tasks (scheduler jobs).

Important details of the ICE service are the:
- syndicator role bundling content as offers
- subscriber role subscribing to offers

Copyright (c) SAP AG

Field Summary

static String	DEFAULT_USER_ID_SERVICE default user-id of the user which will run all ICE related tasks
static String	ICE_SERVICE constant used to identify the ICE service at the service factory

Method Summary

ISubscriberConfig	getSubscriberConfig() Gets the configuration of the subscriber role of this ICE service.
ISyndicatorConfig	getSyndicatorConfig() Gets the configuration of the syndicator role of this ICE service.
void	handlePayload(InputStream is, OutputStream os, boolean compress, IResourceContext context) Handles an incoming ICE payload and delegates it to the responsible ICE role (syndicator or subscriber) depending on the sender of the payload.

Methods inherited from interface com.sapportals.wcm.service.IService

getDescription, getDescription, getID

Field Detail

ICE_SERVICE

static final String ICE_SERVICE

constant used to identify the ICE service at the service factory

See Also:

Constant Field Values

DEFAULT_USER_ID_SERVICE

static final String DEFAULT_USER_ID_SERVICE

default user-id of the user which will run all ICE related tasks

See Also:

Constant Field Values

Method Detail

getSubscriberConfig

ISubscriberConfig getSubscriberConfig()

Gets the configuration of the subscriber role of this ICE service. An ICE service represents only one subscriber (and one syndicator).

Returns:

an ISubscriberConfig containing the configuration of the subscriber role

getSyndicatorConfig

ISyndicatorConfig getSyndicatorConfig()

Gets the configuration of the syndicator role of this ICE service. An ICE service represents only one syndicator (and one subscriber).

Returns:

an ISyndicatorConfig containing the configuration of the syndicator pole

handlePayload

void handlePayload(InputStream is,
                   OutputStream os,
                   boolean compress,
                   IResourceContext context)
                   throws IOException

Handles an incoming ICE payload and delegates it to the responsible ICE role (syndicator or subscriber) depending on the sender of the payload.

If the package comes from a syndicator, it will be handed over to the subscriber role of this ICE service. If it comes from a subscriber, it will be delegated to the syndicator role of this ICE service. Passing null as an argument for is, os or context will cause an exception.

Parameters:

is - an InputStream containing the ICE payload

os - an OutputStream to write the answer to

compress - true if the input is and the output should be zipped, false otherwise

context - an IResourceContext containing the authenticated user who sent the ICE payload

Throws:

IOException - if an I/O error occurs

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