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)ISystemLandscapeWrapper
implementation.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 perhapsgetAllAliases()
to be able to present a list of system aliases available.Modifier and Type | Field and Description |
---|---|
static String |
TYPE_DESTINATION_SERVICE |
static String |
TYPE_ENTERPRISE_PORTAL |
static String |
TYPE_UME_INTEGRATED |
Modifier and Type | Method and Description |
---|---|
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 (!)
|
String |
getUniqueKeyForAlias(String alias)
Returns a unique key for a given system alias.
|
static final String TYPE_ENTERPRISE_PORTAL
static final String TYPE_DESTINATION_SERVICE
static final String TYPE_UME_INTEGRATED
String getType()
The return value should be a rather short string that can be displayed on the UI as well as saved in configuration data.
String getDisplayName(Locale locale)
locale
- The locale for which the display name should be provided.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).
getAllAliases
in interface ISystemLandscapeWrapper
String
s)ExceptionInImplementationException
- If the underlying system landscape implementation throws an exception.Enumeration getAllAliases(IPrincipal principal) throws ExceptionInImplementationException
getAllAliases
in interface ISystemLandscapeWrapper
principal
- The principal for which all aliases are requestedExceptionInImplementationException
- If the underlying system landscape implementation throws an exception.String getUniqueKeyForAlias(String alias) throws ExceptionInImplementationException
getUniqueKeyForAlias
in interface ISystemLandscapeWrapper
alias
- The alias pointing to a systemExceptionInImplementationException
- If the underlying system landscape implementation throws an exception.Enumeration getAllUniqueKeys() throws ExceptionInImplementationException
getAllUniqueKeys
in interface ISystemLandscapeWrapper
String
s)ExceptionInImplementationException
- If the underlying system landscape implementation throws an exception.ISystemLandscapeObject getSystemByUniqueKey(String uniqueKey) throws ExceptionInImplementationException
getSystemByUniqueKey
in interface ISystemLandscapeWrapper
uniqueKey
- The unique key of a systemExceptionInImplementationException
- If the underlying system landscape implementation throws an exception.ISystemLandscapeObject getSystemByAlias(String alias) throws ExceptionInImplementationException
getSystemByAlias
in interface ISystemLandscapeWrapper
alias
- The alias of the system that should be retrieved.ExceptionInImplementationException
- If the underlying system landscape implementation throws an exception.String getStorageKeyPrefix()
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.
Access Rights |
---|
SC | DC | Public Part | ACH |
---|---|---|---|
[sap.com] ENGFACADE
|
[sap.com] tc/je/usermanagement/api
|
api
|
BC-JAS-SEC
|
[sap.com] ENGINEAPI
|
[sap.com]
|
-
|
BC-JAS-SEC-UME
|
Copyright 2018 SAP AG Complete Copyright Notice