com.sapportals.wcm.service.ice.syndicator

Interface ISyndicatorConfig

public interface ISyndicatorConfig

ISubscriberConfig is used to read and manipulate the configuration of the subscriber part.

Copyright 2004 SAP AG

Method Summary

IOffer	createOffer(String offerId, IResourceContext context) Create a new offer.
ISynSubscriber	createSubscriber(String name, String description, com.sapportals.wcm.util.uuid.UUID uuid, IResourceContext context) Create a new subscriber.
String	getContentAccessURL() Get the content access base URL for the subscribers.
Date	getCreationDate() The creation date of the SyndicatorConfig singleton.
String	getDefaultUser() Get the id of the default user.
IOffer	getGlobalOffer() Get the global offer.
InputStream	getGlobalPackage(boolean incremental, boolean compressed, IResourceContext context) Get an ICE package containing the content of the global offer.
Date	getLastModified() The last modification date of the SyndicatorConfig singleton.
URL	getLocation() Get the location of the ICE servlet on this machine.
String	getName() Get the name/description of the syndicator.
IOffer	getOffer(String offerId) Get an offer by its identifier.
IOfferList	getOfferList() Get a list of all offers.
ISynSubscriber	getSubscriber(String name) Get the SynSubscriber configuration object by its internal name.
ISynSubscriber	getSubscriber(com.sapportals.wcm.util.uuid.UUID uuid) Get a subscriber by its uuid.
ISynSubscriberList	getSubscriberList() Get a list of all registered subscribers.
com.sapportals.wcm.util.uuid.UUID	getUUID() Get the uuid of the local syndicator (this server).
void	removeOffer(IOffer offer, IResourceContext context) Remove an offer from the configuration.
void	removeSubscriber(ISynSubscriber subscriber, IResourceContext context) Remove a subscriber from the configuration.
void	setContentAccessURL(String contentAccessURL, IResourceContext context) Set the content access base URL for the subscribers.
void	setDefaultLogin(String user, String password, IResourceContext context) Set the login informations of the default user.
void	setLocation(URL location, IResourceContext context) Set the location of the ICE servlet on this machine.
void	setName(String syndicatorName, IResourceContext context) Set the name/description of the syndicator.
void	setUUID(com.sapportals.wcm.util.uuid.UUID syndicatorUUID, IResourceContext context) Set the uuid of the syndicator.

Method Detail

createSubscriber

ISynSubscriber createSubscriber(String name,
                                String description,
                                com.sapportals.wcm.util.uuid.UUID uuid,
                                IResourceContext context)
                                throws ResourceException

Create a new subscriber.

Parameters:

name - The name of the subscriber

description - The description of the subscriber

uuid - The uuid of the subscriber

context - The current resource context (containing an authenticated user)

Returns:

The newly created subscriber

Throws:

ResourceException - on error

removeSubscriber

void removeSubscriber(ISynSubscriber subscriber,
                      IResourceContext context)
                      throws ResourceException

Remove a subscriber from the configuration.

Parameters:

subscriber - The subscriber to be removed

context - The current resource context (conataining an authenticated user)

Throws:

ResourceException - on error

getSubscriber

ISynSubscriber getSubscriber(String name)

Get the SynSubscriber configuration object by its internal name.

Parameters:

name - @todo: Description of the incoming method parameter

Returns:

The SynSubscriber object that matches internal or null if no information for internalName was found in the configration

getSubscriber

ISynSubscriber getSubscriber(com.sapportals.wcm.util.uuid.UUID uuid)

Get a subscriber by its uuid.

Parameters:

uuid - The uuid of the subscriber

Returns:

The subscriber with UUID uuid or null

getSubscriberList

ISynSubscriberList getSubscriberList()

Get a list of all registered subscribers.

Returns:

A list of all registered subscribers

createOffer

IOffer createOffer(String offerId,
                   IResourceContext context)
                   throws ResourceException

Create a new offer.

Parameters:

offerId - The identifier of the new offer

context - The current resource context (conataining an authenticated user)

Returns:

The newly created offer

Throws:

ResourceException - on error

removeOffer

void removeOffer(IOffer offer,
                 IResourceContext context)
                 throws ResourceException

Remove an offer from the configuration.

Parameters:

offer - The offer to be removed

context - The current resource context (conataining an authenticated user)

Throws:

ResourceException - on error

getOffer

IOffer getOffer(String offerId)

Get an offer by its identifier.

Parameters:

offerId - The identifier of the offer

Returns:

The offer with identifier offerId or null

getOfferList

IOfferList getOfferList()

Get a list of all offers.

Returns:

A list of all offers

getUUID

com.sapportals.wcm.util.uuid.UUID getUUID()

Get the uuid of the local syndicator (this server).

Returns:

The uuid of the local syndicator

setUUID

void setUUID(com.sapportals.wcm.util.uuid.UUID syndicatorUUID,
             IResourceContext context)
             throws ResourceException

Set the uuid of the syndicator. WARNING: Changing the UUID of a syndicator will (implicitly) invalid all its subscriptions.

Parameters:

syndicatorUUID - The uuid of the syndicator

context - The current resource context

Throws:

ResourceException - on error

getName

String getName()

Get the name/description of the syndicator.

Returns:

The name/description of the syndicator

setName

void setName(String syndicatorName,
             IResourceContext context)
             throws ResourceException

Set the name/description of the syndicator.

Parameters:

syndicatorName - The name/description of the syndicator

context - The current resource context

Throws:

ResourceException - on error

getLocation

URL getLocation()

Get the location of the ICE servlet on this machine.

Returns:

The location of the ICE servlet on this machine (null if unknown).

setLocation

void setLocation(URL location,
                 IResourceContext context)
                 throws ResourceException

Set the location of the ICE servlet on this machine.

Parameters:

location - The location of the ICE servlet

context - The current resource context

Throws:

ResourceException - on error

getDefaultUser

String getDefaultUser()

Get the id of the default user.

Returns:

The id of the default user

setDefaultLogin

void setDefaultLogin(String user,
                     String password,
                     IResourceContext context)
                     throws ResourceException

Set the login informations of the default user.

Parameters:

user - The default user id

password - The password of the default user

context - The current resource context

Throws:

ResourceException - on error

getContentAccessURL

String getContentAccessURL()

Get the content access base URL for the subscribers. If a resource is transfered as ice-item-ref the subscribers need an URL to access the content.

Returns:

The content access base URL

setContentAccessURL

void setContentAccessURL(String contentAccessURL,
                         IResourceContext context)
                         throws ResourceException

Set the content access base URL for the subscribers.

Parameters:

contentAccessURL - The content access base URL

context - The current resource context

Throws:

ResourceException - on error

getCreationDate

Date getCreationDate()

The creation date of the SyndicatorConfig singleton. This date is presented as creation date of the resources in the virtual ICE repository.

Returns:

The creation date of the SyndicatorConfig singleton

See Also:

com.sapportals.wcm.repository.manager.ice.ICERepositoryManager

getLastModified

Date getLastModified()

The last modification date of the SyndicatorConfig singleton. This date is presented as last modified date of the resource in the virtual ICE respository.

Returns:

The last modification date of the Syndicator singleton

See Also:

com.sapportals.wcm.repository.manager.ice.ICERepositoryManager

getGlobalOffer

IOffer getGlobalOffer()

Get the global offer. The global offer defines the content of the global subscription.

Returns:

The global offer

getGlobalPackage

InputStream getGlobalPackage(boolean incremental,
                             boolean compressed,
                             IResourceContext context)
                             throws ResourceException

Get an ICE package containing the content of the global offer. The ICE payload will contain a subscription with the identifier "GLOBAL".

Parameters:

incremental - true if the package should only contain the changes since the last update

compressed - true if the package should be ziped

context - The current resource context

Returns:

An InputStream containing the ICE payload

Throws:

ResourceException - on error

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