com.sap.portal.pcm.system

Interface ISystems

All Superinterfaces:

com.sap.portal.pcm.IObjectsManager

public interface ISystems
extends com.sap.portal.pcm.IObjectsManager

The interface for the system landscape service that provides helper methods for working with systems. The methods retrieve aliases and the system associated with a specific alias, and check whether an alias is a default alias.

Since:

EP6 SP2

Field Summary

static String	KEY The key to identify the service
static String	OCLASS The Semantics OClass

Method Summary

String[]	getAliases() Gets all aliases in the PCD.
String[]	getAliases(com.sap.security.api.IPrincipal principal, boolean usePersonalized) Gets all aliases from the PCD that are assigned to systems that a specific user has permission to access.
List	getAliasesObjects(com.sap.security.api.IPrincipal principal, boolean usePersonalized)
String[]	getDefaultAliases() Gets all default aliases in the PCD.
List	getDefaultAliasObjects() This method gets all default aliases of all systems (only system default aliases are returned).
String	getSystemId(String alias) Gets the system ID for a specific alias.
boolean	isDefaultAlias(String alias) Indicates whether a specific alias is a default alias.

Methods inherited from interface com.sap.portal.pcm.IObjectsManager

getDefaultAttributes, instantiateDescriptor, instantiateDescriptor, instantiateDescriptor

Field Detail

KEY

static final String KEY

The key to identify the service

See Also:

Constant Field Values

OCLASS

static final String OCLASS

The Semantics OClass

See Also:

Constant Field Values

Method Detail

getDefaultAliases

String[] getDefaultAliases()

Gets all default aliases in the PCD.

Returns:

an array of alias names

getDefaultAliasObjects

List getDefaultAliasObjects()

This method gets all default aliases of all systems (only system default aliases are returned). If there is a problem during one of the aliases loading, partial list of aliases will be returned

Returns:

all retrieved default aliases of all available systems.

getAliasesObjects

List getAliasesObjects(com.sap.security.api.IPrincipal principal,
                       boolean usePersonalized)

Parameters:

principal -

usePersonalized -

Returns:

list of aliases that the user principal has the permitions to see.

getAliases

String[] getAliases()

Gets all aliases in the PCD.

Returns:

an array of alias names

getAliases

String[] getAliases(com.sap.security.api.IPrincipal principal,
                    boolean usePersonalized)

Gets all aliases from the PCD that are assigned to systems that a specific user has permission to access.

Parameters:

principal - a user

usePersonalized - Indicates whether to get aliases associated with systems for which the user has end-user permissions (true), or aliases associated with systems for which the user does not have end-user permissions (false)

Returns:

an array of aliases

getSystemId

String getSystemId(String alias)

Gets the system ID for a specific alias.
Dynamic system resolution is supported, so this method first tries to retrieve the system ID from a registered resolving service if one is registered for this alias in the portal registry. Otherwise, it searches for the alias in the PCD and returns the system to which the alias is associated.

Parameters:

alias - an alias for which to get the corresponding system ID

Returns:

the ID of system associated with the specified alias

Throws:

AmbiguousAliasException - if the alias is defined both in the portal registry and in the PCD

isDefaultAlias

boolean isDefaultAlias(String alias)

Indicates whether a specific alias is a default alias.

Parameters:

alias - a system alias

Returns:

true if the specified alias is a default alias, false if it is not a default alias

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] EP-RUNTIME	[sap.com] tc/ep/semantics/api	api	EP-PIN