com.sapportals.wcm.service.webdav

Interface IWebDAVSite

public interface IWebDAVSite

Manages all configuration data of a WebDAVSite, e.g. access to a WebDAV server as managed by IWebDAVSiteController.

Notice that implementations of this interface are immutable objects. All setter methods create new instances and leave the called one unchanged. For changes to have any effect, you must use the IWebDAVSiteController.add(IWebDAVSite, boolean) or IWebDAVSiteController.update(IWebDAVSite) methods.

Note that the name of a IWebDAVSite also acts as its identifier. It must be unique and it cannot be changed. If you want to renamed a site, you have to create a new one and delete the old.

Copyright (c) SAP AG 2006

Field Summary

static String	TYPE_GENERIC
static String	TYPE_IIS
static String	TYPE_MODDAV

Method Summary

String	getName() Get the name under which this site is accessible.
String	getPortalLandscapeSystemName() Get the name of the server as used in the portal landscape, e.g. for user mapping of credentials.
HttpUrl	getServer() Get the URL of the server this site connects to.
String	getServerType() Get the type of server the remote WebDAV site runs on.
UserInfo	getStandardUser() Return the stanard user credentials or null for authentication at the server.
boolean	isInSameUserDomain() Determine if the server is believed to be in the same user domain and may therefore understand our SSO tickets (single sign on).
IWebDAVSite	setName(String name) Create a site object with the given name.
IWebDAVSite	setPortalLandscapeSystemName(String lName) Create a site with the given landscape name to use for usermapping, e.g.
IWebDAVSite	setSameUserDomain(boolean active) Create a site with the given user domain setting to use.
IWebDAVSite	setServer(HttpUrl url) Create a site with the given server url to use.
IWebDAVSite	setServerType(String serverType) Create a site with the given server type to use.
IWebDAVSite	setStandardUser(UserInfo ui) Create a site with the given credentials to use.

Field Detail

TYPE_GENERIC

static final String TYPE_GENERIC

See Also:

Constant Field Values

TYPE_IIS

static final String TYPE_IIS

See Also:

Constant Field Values

TYPE_MODDAV

static final String TYPE_MODDAV

See Also:

Constant Field Values

Method Detail

getName

String getName()

Get the name under which this site is accessible. This will also determine the name of the IResource which represents this site in the repository.

Returns:

name of the site

getServer

HttpUrl getServer()

Get the URL of the server this site connects to.

Returns:

URL of server

isInSameUserDomain

boolean isInSameUserDomain()

Determine if the server is believed to be in the same user domain and may therefore understand our SSO tickets (single sign on). Only sites where this is set to true will forward SSO tickets to the server.

Returns:

if SSO ticket forwarding is enabled

getPortalLandscapeSystemName

String getPortalLandscapeSystemName()

Get the name of the server as used in the portal landscape, e.g. for user mapping of credentials. If no system name is defined null is returned.

Returns:

system name for user mapping or null

getServerType

String getServerType()

Get the type of server the remote WebDAV site runs on. This parameter exists purely for performance optimizations. The type TYPE_GENERIC works against all servers.

Returns:

type of server

getStandardUser

UserInfo getStandardUser()

Return the stanard user credentials or null for authentication at the server. If standard user credentials are defined, no user mapping is applied and all requests to the server are done as standard user.

Returns:

stanard user credentials to use or null

setName

IWebDAVSite setName(String name)
                    throws InvalidArgumentException

Create a site object with the given name. To actually create such a site, you must give the new object to the IWebDAVSiteController.

The name must be a valid part of a RID and may not contain any slashes for example.

Parameters:

name - of new site object

Returns:

site object with name

Throws:

InvalidArgumentException - if name is not valid

setServer

IWebDAVSite setServer(HttpUrl url)
                      throws InvalidArgumentException

Create a site with the given server url to use. To actually take this change into operation you must pass the new object to the IWebDAVSiteController.

Parameters:

url - of server to work against

Returns:

site object with that server url

Throws:

InvalidArgumentException - if url is not valid

setSameUserDomain

IWebDAVSite setSameUserDomain(boolean active)

Create a site with the given user domain setting to use. To actually take this change into operation you must pass the new object to the IWebDAVSiteController.

Parameters:

active - iff SSO ticket forwarding is enabled

Returns:

new site object with settings

setPortalLandscapeSystemName

IWebDAVSite setPortalLandscapeSystemName(String lName)

Create a site with the given landscape name to use for usermapping, e.g. mapping of user credentials for this system. To actually take this change into operation you must pass the new object to the IWebDAVSiteController.

In order to disable any use of user mapping pass a null as argument

Parameters:

lName - portal landscape name to use or null

Returns:

new site object with landscape name

setServerType

IWebDAVSite setServerType(String serverType)
                          throws InvalidArgumentException

Create a site with the given server type to use. To actually take this change into operation you must pass the new object to the IWebDAVSiteController.

Parameters:

serverType - to use

Returns:

new site object with given server type

Throws:

InvalidArgumentException - when the type is not known

setStandardUser

IWebDAVSite setStandardUser(UserInfo ui)

Create a site with the given credentials to use. To actually take this change into operation you must pass the new object to the IWebDAVSiteController.

Use a null argument to disable standard user credentials.

Parameters:

ui - standard user credentials to use or null

Returns:

new site object with given credentials

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