com.sap.security.api.umap.system

Interface ISystemLandscapeWrapper

public interface 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 UMFactory.getSystemLandscapeWrappers().
An implementation can register itself in UME via UMFactory.addSystemLandscapeWrapper(ISystemLandscapeWrapper).
Unregistering is possible using UMFactory.removeSystemLandscapeWrapper(ISystemLandscapeWrapper).

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.

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.
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	getUniqueKeyForAlias(String alias) Returns a unique key for a given system alias.

Method Detail

getAllAliases

public 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).

Returns:

Enumeration of system aliases (as Strings)

Throws:

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

getAllAliases

public 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.

Returns:

Enumeration of system aliases

Throws:

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

getUniqueKeyForAlias

public String getUniqueKeyForAlias(String alias)
                            throws ExceptionInImplementationException

Returns a unique key for a given system alias.

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

public Enumeration getAllUniqueKeys()
                             throws ExceptionInImplementationException

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

Returns:

Enumeration containing all unique keys (as Strings)

Throws:

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

getSystemByUniqueKey

public ISystemLandscapeObject getSystemByUniqueKey(String uniqueKey)
                                            throws ExceptionInImplementationException

Retrieves a system landscape object stored under this unique key.

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

public ISystemLandscapeObject getSystemByAlias(String alias)
                                        throws ExceptionInImplementationException

Retrieves a system landscape object stored under this alias.

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.