public interface ISyndicatorConfig
Copyright 2004 SAP AG
Modifier and Type | Method and Description |
---|---|
IOffer |
createOffer(String offerId,
IResourceContext context)
Create a new offer.
|
ISynSubscriber |
createSubscriber(String name,
String description,
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(UUID uuid)
Get a subscriber by its uuid.
|
ISynSubscriberList |
getSubscriberList()
Get a list of all registered subscribers.
|
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(UUID syndicatorUUID,
IResourceContext context)
Set the uuid of the syndicator.
|
ISynSubscriber createSubscriber(String name, String description, UUID uuid, IResourceContext context) throws ResourceException
name
- The name of the subscriberdescription
- The description of the subscriberuuid
- The uuid of the subscribercontext
- The current resource context (containing an authenticated user)ResourceException
- on errorvoid removeSubscriber(ISynSubscriber subscriber, IResourceContext context) throws ResourceException
subscriber
- The subscriber to be removedcontext
- The current resource context (conataining an authenticated user)ResourceException
- on errorISynSubscriber getSubscriber(String name)
name
- Description of the incoming method parameterISynSubscriber getSubscriber(UUID uuid)
uuid
- The uuid of the subscriberISynSubscriberList getSubscriberList()
IOffer createOffer(String offerId, IResourceContext context) throws ResourceException
offerId
- The identifier of the new offercontext
- The current resource context (conataining an authenticated user)ResourceException
- on errorvoid removeOffer(IOffer offer, IResourceContext context) throws ResourceException
offer
- The offer to be removedcontext
- The current resource context (conataining an authenticated user)ResourceException
- on errorIOffer getOffer(String offerId)
offerId
- The identifier of the offerIOfferList getOfferList()
UUID getUUID()
void setUUID(UUID syndicatorUUID, IResourceContext context) throws ResourceException
syndicatorUUID
- The uuid of the syndicatorcontext
- The current resource contextResourceException
- on errorString getName()
void setName(String syndicatorName, IResourceContext context) throws ResourceException
syndicatorName
- The name/description of the syndicatorcontext
- The current resource contextResourceException
- on errorURL getLocation()
void setLocation(URL location, IResourceContext context) throws ResourceException
location
- The location of the ICE servletcontext
- The current resource contextResourceException
- on errorString getDefaultUser()
void setDefaultLogin(String user, String password, IResourceContext context) throws ResourceException
user
- The default user idpassword
- The password of the default usercontext
- The current resource contextResourceException
- on errorString getContentAccessURL()
void setContentAccessURL(String contentAccessURL, IResourceContext context) throws ResourceException
contentAccessURL
- The content access base URLcontext
- The current resource contextResourceException
- on errorDate getCreationDate()
Date getLastModified()
IOffer getGlobalOffer()
InputStream getGlobalPackage(boolean incremental, boolean compressed, IResourceContext context) throws ResourceException
incremental
- true if the package should only contain the changes since the last updatecompressed
- true if the package should be zipedcontext
- The current resource contextResourceException
- on errorAccess Rights |
---|
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
|
Copyright 2018 SAP AG Complete Copyright Notice