com.sapportals.wcm.service.ice.subscriber

Interface ISubscriberConfig

public interface ISubscriberConfig

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

Copyright 2004 SAP AG

Method Summary

ISubSyndicator	createSyndicator(String name, String description, com.sapportals.wcm.util.uuid.UUID uuid, URL url, IResourceContext context) Create a new syndicator.
Date	getCreationDate() The creation date of the SyndicatorConfig singleton.
String	getDefaultUser() Get the id of the default user.
IICEHttpConnection	getInitialConnection(URL url, String user, String password) Open an intial connection to a syndicator.
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 subscriber.
ISubSyndicator	getSyndicator(String name) Get the SubSyndicator configuration object by its name.
ISubSyndicator	getSyndicator(com.sapportals.wcm.util.uuid.UUID uuid) Get a syndicator by its uuid.
ISubSyndicatorList	getSyndicatorList() Get a list of all registered syndicators.
com.sapportals.wcm.util.uuid.UUID	getUUID() Get the uuid of the local subscriber (this server).
void	removeSyndicator(ISubSyndicator syndicator, IResourceContext context) Remove a syndicator from the configuration.
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 subscriberName, IResourceContext context) Set the name/description of the subscriber.
void	setUUID(com.sapportals.wcm.util.uuid.UUID subscriberUUID, IResourceContext context) Set the uuid of the subscriber.

Method Detail

createSyndicator

ISubSyndicator createSyndicator(String name,
                                String description,
                                com.sapportals.wcm.util.uuid.UUID uuid,
                                URL url,
                                IResourceContext context)
                                throws ResourceException

Create a new syndicator.

Parameters:

name - The name of the syndicator

description - The description of the syndicator

uuid - The uuid of the syndicator

url - The url of the ice servlet of the syndicator

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

Returns:

The newly created syndicator

Throws:

ResourceException - on error

removeSyndicator

void removeSyndicator(ISubSyndicator syndicator,
                      IResourceContext context)
                      throws ResourceException

Remove a syndicator from the configuration.

Parameters:

syndicator - The syndicator to be removed

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

Throws:

ResourceException - on error

getSyndicator

ISubSyndicator getSyndicator(String name)

Get the SubSyndicator configuration object by its name.

Parameters:

name - The name of the syndicator

Returns:

The SubSyndicator object that matches name or null if no information for name was found in the configration

getSyndicator

ISubSyndicator getSyndicator(com.sapportals.wcm.util.uuid.UUID uuid)

Get a syndicator by its uuid.

Parameters:

uuid - The uuid of the syndicator

Returns:

The syndicator with UUID uuid or null

getSyndicatorList

ISubSyndicatorList getSyndicatorList()

Get a list of all registered syndicators.

Returns:

A list of all registered syndicators

getUUID

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

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

Returns:

The uuid of the local subscriber

setUUID

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

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

Parameters:

subscriberUUID - The uuid of the subscriber

context - The current resource context

Throws:

ResourceException - on error

getName

String getName()

Get the name/description of the subscriber.

Returns:

The name/description of the subscriber

setName

void setName(String subscriberName,
             IResourceContext context)
             throws ResourceException

Set the name/description of the subscriber.

Parameters:

subscriberName - The name/description of the subscriber

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

getInitialConnection

IICEHttpConnection getInitialConnection(URL url,
                                        String user,
                                        String password)

Open an intial connection to a syndicator.

Parameters:

url - The url of the syndicator

user - The user id

password - The password

Returns:

An intial connection to a syndicator.

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

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