com.sap.portal.pcm.system
Interface ISystem

All Superinterfaces:

com.sap.portal.pcm.admin.IAttributeSet

public interface ISystem

extends com.sap.portal.pcm.admin.IAttributeSet

The ISystem provides an interface to a system allowing properties manipulation.
A system represents an external application. It wraps a set of properties
that allow to connect to the application it represents.

A system allows aliasing manipulation. "Aliases" are friendly names that represent
a system and provides reference to the system location. Many aliases can be associated
with a system whereas only one system can be refernced from a single alias.
The basic concept is that there must be at least one default alias if aliases are
defined for the system. To enforce this concept if an alias is added to a system, it
is defined as default if it is the first one. However, removing a default alias is
allowed if it is the only alias defined for the system.

The ISystem can be instanciated when a "lookup" is performed with the proper URL.
In order to get an ISystem instance, when performing a JNDI lookup, the ISystem
must be associated with a proper JNDI object factory.

Being a semantic object the ISystem provides all the PCD capabilities as declared in
super interface com.sap.portal.pcm.admin.IAttributeSet.

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

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

Method Summary

void	addAlias(java.lang.String aliasName) Associates this ISystem instance with a given alias name.
void	changeDefaultAlias(java.lang.String newDefaultAliasName) Replaces the default alias defined for this ISystem with a new default alias name.
java.lang.String[]	getAliases() Retrieves all aliases of this system.
java.lang.String	getDefaultAlias() Retrieves the name of a default alias whose target is the URL of this system.
ISystemUserMappingData	getUserMappingData(com.sap.security.api.IPrincipal principal) Creates an ISystemUserMappingData instance with the user mapping properties of this system
void	removeAlias(java.lang.String aliasName) Removes the specified alias.

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

deleteAttribute, deleteMetaAttribute, getAttribute, getAttribute, getAttributeIds, getAttributeType, getAvailableAttributeLocales, getAvailableMetaAttributeLocales, getMetaAttribute, getMetaAttribute, getMetaAttributeIds, getMetaAttributeType, putAttribute, putAttribute, putMetaAttribute, putMetaAttribute, save, validate

Method Detail

getDefaultAlias

public java.lang.String getDefaultAlias()

Retrieves the name of a default alias whose target is the URL of this system.

Returns:

an alias name. If no default alias is found an empty String is returned.

getAliases

public java.lang.String[] getAliases()

Retrieves all aliases of this system.

Returns:

String[] - A string array containing all alias names. If no alias found, an empty array is returned

getUserMappingData

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

Creates an ISystemUserMappingData instance with the user mapping properties of this system

Parameters:

principle -

Returns:

ISystemUserMappingData - representation of mapping user mapping properties for this system

addAlias

public void addAlias(java.lang.String aliasName)
              throws javax.naming.NamingException,
                     com.sap.portal.pcm.OperationFailedException

Associates this ISystem instance with a given alias name. If this alias is the first alias to associate with this system it is defined as default.

Parameters:

aliasName - - The alias name to associate with this ISystem

Throws:

javax.naming.NamingException -

com.sap.portal.pcm.OperationFailedException -

changeDefaultAlias

public void changeDefaultAlias(java.lang.String newDefaultAliasName)
                        throws javax.naming.NamingException,
                               DefaultAliasNotFoundException,
                               com.sap.portal.pcm.admin.ValidationException,
                               java.io.IOException,
                               DefaultAliasAlreadyExistsException

Replaces the default alias defined for this ISystem with a new default alias name. The replacement must find the default alias to be replaced before hand, otherwise it throws DefaultAliasNotFoundException. The alias to be set as default should also be predefined for this system.

Parameters:

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

Throws:

javax.naming.NamingException -

DefaultAliasNotFoundException - - If no default alias is predefined

com.sap.portal.pcm.admin.ValidationException -

java.io.IOException -

removeAlias

public void removeAlias(java.lang.String aliasName)
                 throws javax.naming.NamingException,
                        com.sap.portal.pcm.OperationFailedException

Removes the specified alias. Advise that removing a default alias is allowed only if it is the only alias defined for this system, otherwise an OperationFailedException is thrown

Parameters:

aliasName - - alias to be removed.

Throws:

javax.naming.NamingException -

com.sap.portal.pcm.OperationFailedException -