Package com.sapportals.wcm.service.landscape

Provides a service for information on configured systems and logon credentials.

See:
Description

Interface Summary

ICredential	Informations for mapping user data between a CM system and 'external' systems.
ICredentialList	A list of ICredentials .
ICredentialListIterator	An iterator for a ICredentialList .
ICredentialsFactory	Factory to retrieve the ICredential s.
ILandscapeService	Main entry point to retrieve the ISystemFactory and check the cluster mode.
ISystem	Abstraction of an 'external' system, like a web server or a R/3-System.
ISystemFactory	Factory to retrieve ISystem s and the ICredentialFactory .
ISystemList	A list of ISystem s.
ISystemListIterator	An iterator for a ISystemList .

Class Summary

AutoID	The good old "Nummernkreis" is back: This class generates sequential numbers for use as primary keys in (OpenSQL) database tables.
LandscapeServiceFactory	The landscape service factory.
SystemInfo	Allows to set the id of the local CM system, before starting the landscape service.

Exception Summary

CredentialExistsException	(internal use only) Indicates that a credential already exists.
LandscapeException	(internal use only) Indicates that an internal error occured in the landscape service.
LandscapePersistenceException	(internal use only) Indicates that an internal error occured in the landscape service while trying to save or retrieve data.
SystemExistsException	(internal use only) Indicates that a system already exists.

Package com.sapportals.wcm.service.landscape Description

Provides a service for information on configured systems and logon credentials.

System Landscape

Purpose
Detailed_Concept
Interfaces
Configuration

Purpose

Content Management systems often have to access data that is stored in repositories on external systems. The system landscapes service stores the information that is required to connect to these external systems and allows applications to access this information through its interfaces.

The service distinguishes between systems and their credentials. A system represents a server within the landscape, like a Web server or a remote system like an SAP Enterprise system. It has a unique ID, a description, type and properties. The properties define the details required to establish a connection to the system, for example, a URL and domain.. A credential represents the data that is required to log on to the system as an individual user. This can be standard logon information like user name and password, but also additional information like a start directory, access protocol or logon mode.

As mentioned above, systems always have a type. The available types are predefined for the system landscape service in the configuration framework of Content Management. Currently valid types are: Windows, Lotus Notes and http (for proxy or web servers). Each type is associated with a predefined set of credentials. For example, the system type http is associated with the credentials user and password. Users are only granted access to a http system, if a password and user are specified. In theory, other system types could require a different set of credentials, for example, user, password, language, and start folder.

The interfaces of the system landscape service only offer methods to access information about systems and credentials. They do not allow the entry of information. Information can only be entered with the help of the user interface of the configuration framework for Content Management.

Although the system landscape service stores credentials, it does not enforce them. It is the task of the application to determine whether access to a system is to be granted by obtaining the information specified in a credential from user management and checking the validity.

Detailed Concept

The landscape service can be addressed with the help of three central, interrelated interfaces:

• ILandscapeService
• ISystemFactory
• ICredentialsFactory

The ILandscapeService defines a method to get an instance of an ISystemFactory and this in turn offers a method to get an instance of an ICredentialsFactory . These factories perform the main task of the landscape service. They retrieve the objects that store information about systems and their credentials. The ISystemFactory retrieves ISystem objects that store information about a system including its type, name and description. The ICredentialFactory retrieves ICredential objects that store requirements that must be met by individual users who want to access a specific system type. A credential is always associated with a specific system type like a Lotus Notes or http server. To get all the requirements for a particular system type, several ICredential objects are needed. Each object stores the name of the credential and properties that represent the individual access requirements.

Interfaces

The following briefly introduces the main interfaces of the landscape service.

• ILandscapeService
  Defines a method which is the starting point for work with the landscape service. This method fetches an instance of the ISystemFactory which is a prerequisite for all the steps that follow. The interface also provides a method to determine whether the local CM system is installed on a cluster with several instances.
  
• ISystemFactory
  Offers methods to retrieve ISystem objects which store information about systems. It also offers a method to get an instance of the credentials factory.
  
• ISystem
  Stores information about a specific server or system that contains data which Content Management needs to access. It holds a system ID, a description, type and set of properties. The type identifies the kind of server that is running on the system, for example, Lotus Notes, http or Windows system.
• ICredent ialsFactory
  This interface is similar to that of the ISystemFactory. It offers a method to retrieve credential objects for a particular system and a method to get the set of credentials required for a specific system type.
  
• An ICredential object stores a credential for accessing a specific system type. A credential is simply a container for a unit of information that is required to permit access to a system of a specific type. Within a credential, individual elements of information are stored as properties.

The graphic shows the main interfaces of the landscape service:

Configuration

The information that is stored by the system landscape service can be entered with parameters that are available on the user interface of the Content Management configuration framework. The tables show the parameters that are available for the service and the currently predefined system types.

Parameters for landscape service:

Property	Required	Description
active	yes	Activate/deactivate the service
iscluster	yes	true if this system is running in clustered mode
clustercachingtimeout	yes	Sets the time that must expire before the validity of a cache entry is checked in a cluster.

Parameters for all systems:

Property	Required	Description
systemid	yes	A unique Id for this system
description	no	An optional description for the system

In the configuration, each System belongs to a specific type. This type defines the set of credentials to be used for such a system. Furthermore these systems can have additional parameters, as described shown in the next table.

Additional parameters for a http System:

Property	Required	Description
server	yes	The servers main URL in the form protocol://host:port, for example, http://www.sap.com
user	no	A specific user id to be used for login to that server. Default is blank (not used).
password	no	The password to be used with the login to the server. Default is blank (not used).
sameUserDomain	no	True, if the server is in the same domain as the CM system (this will eliminate some additional user checks but lower the security level). Default is false.
http.maxConnections	no	The maximum number of connections which are allowed to be opened in parallel to connect to the server. The default is 32768.