public interface IWebDAVSiteController
IWebDAVSite
s inside a collection.
Collections allowing multiple IWebDAVSite
s as child resources
should support this interface. The caller will invoke the
IResource.as(Class)
or
IResource.isA(Class)
methods to
test for support and in order to retrieve an instance.
Via this interface the caller can inspect the existing IWebDAVSite
s,
create new ones or tear down existing ones.
If the caller has insufficient access rights, all methods will throw
AccessDeniedException
s, even on
non-modifying calls. What the necessary access rights are is handled
by the underlying implementation.
Copyright (c) SAP AG 2006
Modifier and Type | Method and Description |
---|---|
IWebDAVSite |
add(IWebDAVSite site,
boolean replaceExisting)
Add a new site with the given settings.
|
IWebDAVSite |
get(String name)
Get the
IWebDAVSite for the given name. |
IWebDAVSite |
getNewInstance(String name,
HttpUrl server)
Create a new site object with given parameters.
|
IWebDAVSite[] |
getSites()
Get all sites managed by this controller.
|
void |
remove(String name)
Remove a site of given name.
|
IWebDAVSite |
update(IWebDAVSite site)
Update a site with the settings from the given object.
|
IWebDAVSite get(String name) throws ResourceException
IWebDAVSite
for the given name.name
- of site to retrievenull
ResourceException
- on general failuresIWebDAVSite[] getSites() throws ResourceException
null
.ResourceException
- on general failuresIWebDAVSite update(IWebDAVSite site) throws ResourceException
site
- site with parameters for updateResourceException
- on general failureIWebDAVSite add(IWebDAVSite site, boolean replaceExisting) throws ResourceException
replaceExisting=true means that the add behaves as if update was called
replaceExisting=false means that the call will fail and throw a NameAlreadyExistsException
site
- to addreplaceExisting
- true iff existing sites shall be overwrittenNameAlreadyExistsException
- on name collisionsResourceException
- on general failurevoid remove(String name) throws ResourceException
name
- name of site to removecom.sapportals.wcm.repository.ResourceNotFoundException}
- if no site under that name existsResourceException
- on genernal failureIWebDAVSite getNewInstance(String name, HttpUrl server) throws InvalidArgumentException
add(IWebDAVSite, boolean)
or update(IWebDAVSite)
.name
- of new siteserver
- url of server to connect oInvalidArgumentException
- if parameters are not valid, see also
IWebDAVSite
for restrictionsAccess 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