com.sap.portal.pcm.system

Interface ISystem

All Superinterfaces:

IAttributes, IAttributeSet, IMutableAttributes

public interface ISystem
extends IAttributeSet

The interface that represents a system and its attributes. ISystem contains methods for manipulating system aliases and for reading the system user mapping for the current user.
A system represents an external application. It wraps a set of properties that enable connecting to an application or database.
A system can have one or more aliases, which are user-friendly names that can be used to reference the system. Each alias can be associated with only one system. The first alias assigned to a system is automatically set as the default alias. You can add more aliases and then set one of these as the default alias. You cannot remove the default alias unless it is the only alias defined for the system.
ISystem can be instantiated via a JNDI lookup using the system PCD path.
ISystem inherits the interface com.sap.portal.pcm.admin.IAttributeSet, which enables manipulation of its attributes.

Since:

EP6 SP2

See Also:

IAttributeSet

Field Summary

static String

RAI_SYSTEM_CODELINK_VALUE Determines the value of the codelink property of RAI system

Fields inherited from interface com.sap.portal.pcm.IAttributes

ADMINISTRATION, ATTRIBUTE_NOT_FOUND, DIALOG, DIALOG_READ_ONLY, NONDIALOG, NONE, PERSONALIZATION, STRING_ATTRIBUTE, TEXT_ATTRIBUTE

Method Summary

void	addAlias(String aliasName) Adds an alias for this system.
void	changeDefaultAlias(String newDefaultAliasName) Sets an alias as the default alias for this system.
String[]	getAliases() Gets all aliases for this system.
String	getDefaultAlias() Gets the system's default alias.
ISystemUserMappingData	getUserMappingData(com.sap.security.api.IPrincipal principal) Gets user mapping properties associated with this system for the IPrincipal passed to this method.
boolean	isRAISystem()
void	removeAlias(String aliasName) Removes the specified alias.

Methods inherited from interface com.sap.portal.pcm.admin.IAttributeSet

save, validate

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

deleteAttribute, deleteMetaAttribute, putAttribute, putAttribute, putMetaAttribute, putMetaAttribute

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

getAttribute, getAttribute, getAttributeIds, getAttributeType, getAvailableAttributeLocales, getAvailableMetaAttributeLocales, getMetaAttribute, getMetaAttribute, getMetaAttributeIds, getMetaAttributeType

Field Detail

RAI_SYSTEM_CODELINK_VALUE

static final String RAI_SYSTEM_CODELINK_VALUE

Determines the value of the codelink property of RAI system

See Also:

Constant Field Values

Method Detail

getDefaultAlias

String getDefaultAlias()

Gets the system's default alias. If no default alias is found, an empty string is returned.

Returns:

the default alias

getAliases

String[] getAliases()

Gets all aliases for this system. If no alias is found, returns null.

Returns:

an array of aliases

getUserMappingData

ISystemUserMappingData getUserMappingData(com.sap.security.api.IPrincipal principal)

Gets user mapping properties associated with this system for the IPrincipal passed to this method. User mapping data includes the user name and password associated with a system for the current user.

Parameters:

principal - the user for which to retrieve user mapping data

Returns:

user mapping data for the specified IPrincipal

addAlias

void addAlias(String aliasName)
              throws NamingException,
                     com.sap.portal.pcm.OperationFailedException

Adds an alias for this system. If this is the first alias to be associated with this system, it is set as the default alias. The alias name must be unique throughout the portal and follow the PCD naming restrictions.

Parameters:

aliasName - the alias to associate with this system

Throws:

NamingException - if the alias already exists

com.sap.portal.pcm.OperationFailedException - if the operation fails

changeDefaultAlias

void changeDefaultAlias(String newDefaultAliasName)
                        throws NamingException,
                               DefaultAliasNotFoundException,
                               ValidationException,
                               IOException,
                               DefaultAliasAlreadyExistsException

Sets an alias as the default alias for this system. The new alias must already be defined for this system.

Parameters:

newDefaultAliasName - the alias to be set as the new default alias

Throws:

NamingException - if the alias cannot be saved in the PCD

DefaultAliasNotFoundException - if the specified alias is not defined for this system

ValidationException - if newDefaultAliasName is null

IOException - if the operation fails

DefaultAliasAlreadyExistsException - if the specified alias already is the default alias

removeAlias

void removeAlias(String aliasName)
                 throws NamingException,
                        com.sap.portal.pcm.OperationFailedException

Removes the specified alias.
If the alias to be removed is the default alias, it is removed if it is the only alias defined for this system. If there are more than one alias defined for this system, OperationFailedException is thrown.

Parameters:

aliasName - the alias to be removed

Throws:

NamingException - if the alias cannot be saved in the PCD

com.sap.portal.pcm.OperationFailedException - if the operation fails

isRAISystem

boolean isRAISystem()

Returns:

whether this system is an RAI system, the codelink attribute is checked for RAI_SYSTEM_CODELINK_VALUE value

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