com.sap.security.api.umap.system
Interface ISystemLandscape

All Superinterfaces:

ISystemLandscapeWrapper

public interface ISystemLandscape
extends ISystemLandscapeWrapper

This interface serves as wrapper for a system landscape to be plugged into UME. The ISystemLandscapeObject objects provided by an ISystemLandscapeWrapper will be used by the User Mapping functionality of UME (see IUserMapping as an entry point).

At runtime, all available implementations of this interface can be retrieved by calling ISystemLandscapeFactory.getAllLandscapes().
An implementation can register itself in UME via ISystemLandscapeFactory.registerLandscape(ISystemLandscape).
Unregistering is possible using ISystemLandscapeFactory.unregisterLandscape(ISystemLandscape).

The concept knows two naming principles:

Unique keys (GUIDs)

• Each system must have exactly one unique key.
• Unique keys must be unique inside of a system landscape represented by an ISystemLandscapeWrapper implementation.
• Unique keys are unique in the sense that two systems are distinct if and only if their unique keys are distinct.

System aliases

• One system can have an arbitrary number of system aliases (please note that at least one alias is required to make the system available for user mapping).
• Systems can not be distinguished based on system aliases (because different aliases may belong to the same system).
• System aliases must be unique inside of a system landscape represented by an ISystemLandscapeWrapper implementation.

An application using user mapping will usually call only two methods of this interface:

• getSystemByAlias(String) to retrieve a system object that can be passed on to IUserMapping methods to retrieve user mapping data for that system, and perhaps
• getAllAliases() to be able to present a list of system aliases available.

Field Summary

static String	TYPE_DESTINATION_SERVICE
static String	TYPE_ENTERPRISE_PORTAL
static String	TYPE_UME_INTEGRATED

Method Summary

Enumeration	getAllAliases() Returns all aliases for systems known to the underlying system landscape implementation.
Enumeration	getAllAliases(IPrincipal principal) Returns all aliases for systems known to this landscape object wrapper for which the specified principal has end-user permissions.
Enumeration	getAllUniqueKeys() Returns a list of all unique keys of systems in the underlying system landscape.
String	getDisplayName(Locale locale) Provide a potentially localized name for the system landscape that can be displayed on the UI.
String	getStorageKeyPrefix() Return the system landscape specific prefix for user mapping data being saved in UME database tables.
ISystemLandscapeObject	getSystemByAlias(String alias) Retrieves a system landscape object stored under this alias.
ISystemLandscapeObject	getSystemByUniqueKey(String uniqueKey) Retrieves a system landscape object stored under this unique key.
String	getType() Determine the unique (!) type identifier of the system landscape wrapper.
String	getUniqueKeyForAlias(String alias) Returns a unique key for a given system alias.

Field Detail

TYPE_ENTERPRISE_PORTAL

static final String TYPE_ENTERPRISE_PORTAL

See Also:

Constant Field Values

TYPE_DESTINATION_SERVICE

static final String TYPE_DESTINATION_SERVICE

See Also:

Constant Field Values

TYPE_UME_INTEGRATED

static final String TYPE_UME_INTEGRATED

See Also:

Constant Field Values

Method Detail

getType

String getType()

Determine the unique (!) type identifier of the system landscape wrapper.

The return value should be a rather short string that can be displayed on the UI as well as saved in configuration data.

Returns:

the type identifier of the system landscape wrapper

getDisplayName

String getDisplayName(Locale locale)

Provide a potentially localized name for the system landscape that can be displayed on the UI.

Parameters:

locale - The locale for which the display name should be provided.

Returns:

the display name

getAllAliases

Enumeration getAllAliases()
                          throws ExceptionInImplementationException

Returns all aliases for systems known to the underlying system landscape implementation.

If the underlying system landscape implementation supports more than one system alias per system, an implementation should return only one alias per system, if possible, i.e. something like a "default" system alias. Applications calling this method are usually just interested in a list of all systems in form of system aliases (i.e. no duplicate systems) instead of a list of all aliases (containing duplicate systems).

Specified by:

getAllAliases in interface ISystemLandscapeWrapper

Returns:

Enumeration of system aliases (as Strings)

Throws:

ExceptionInImplementationException - If the underlying system landscape implementation throws an exception.

getAllAliases

Enumeration getAllAliases(IPrincipal principal)
                          throws ExceptionInImplementationException

Returns all aliases for systems known to this landscape object wrapper for which the specified principal has end-user permissions.

Specified by:

getAllAliases in interface ISystemLandscapeWrapper

Returns:

Enumeration of system aliases

Throws:

ExceptionInImplementationException - If the underlying system landscape implementation throws an exception.

getUniqueKeyForAlias

String getUniqueKeyForAlias(String alias)
                            throws ExceptionInImplementationException

Returns a unique key for a given system alias.

Specified by:

getUniqueKeyForAlias in interface ISystemLandscapeWrapper

Parameters:

alias - The alias pointing to a system

Returns:

GUID that corresponds to this alias

Throws:

ExceptionInImplementationException - If the underlying system landscape implementation throws an exception.

getAllUniqueKeys

Enumeration getAllUniqueKeys()
                             throws ExceptionInImplementationException

Returns a list of all unique keys of systems in the underlying system landscape.

Specified by:

getAllUniqueKeys in interface ISystemLandscapeWrapper

Returns:

Enumeration containing all unique keys (as Strings)

Throws:

ExceptionInImplementationException - If the underlying system landscape implementation throws an exception.

getSystemByUniqueKey

ISystemLandscapeObject getSystemByUniqueKey(String uniqueKey)
                                            throws ExceptionInImplementationException

Retrieves a system landscape object stored under this unique key.

Specified by:

getSystemByUniqueKey in interface ISystemLandscapeWrapper

Parameters:

uniqueKey - The unique key of a system

Returns:

ISystemLandscapeObject representing this system

Throws:

ExceptionInImplementationException - If the underlying system landscape implementation throws an exception.

getSystemByAlias

ISystemLandscapeObject getSystemByAlias(String alias)
                                        throws ExceptionInImplementationException

Retrieves a system landscape object stored under this alias.

Specified by:

getSystemByAlias in interface ISystemLandscapeWrapper

Parameters:

alias - The alias of the system that should be retrieved.

Returns:

ISystemLandscapeObject representing this system

Throws:

ExceptionInImplementationException - If the underlying system landscape implementation throws an exception.

getStorageKeyPrefix

String getStorageKeyPrefix()

Return the system landscape specific prefix for user mapping data being saved in UME database tables.

This must be the same value that is returned by the ISystemLandscapeObject.getStorageKeyPrefix() method of all system objects for handled by the system landscape wrapper.

Each system landscape wrapper must have its own unique prefix, which allows to determine the responsible system landscape wrapper from the respective database entry.

This key will be <prefix>:<unique key>. To avoid conflicts with other ISystemLandscape implementations, this value must be unique per ISystemLandscapeWrapper implementation.

Returns:

the prefix for the system key