com.sapportals.portal.prt.service.usermanagement

Interface IPortalBasicRole

Deprecated. only used internally by PCD

public interface IPortalBasicRole

Interface for the Roles interface for UME

Method Summary

String	getDescription(Locale locale) Deprecated. The Locale-dependent description (long text) for the role.
String	getId() Deprecated. The ID (the PCD atomic name).
String	getLocation() Deprecated. The location (the directory) including the JNDI scheme.
String	getPcdName() Deprecated. The PCD URL including the JNDI scheme.
String	getPcdNamespace() Deprecated. The namespace of this role in the PCD.
String	getPcdRootName() Deprecated. The root name of that role in the PCD, i.e. the atomic name without the namespace.
String	getShortName() Deprecated. The short name (Hashed name).
String	getTitle(Locale locale) Deprecated. The Locale-dependent title for the role.
Attributes	getUmAttributes(String namespace) Deprecated. A subset of the role's attributes with an internal namespace.
NamingEnumeration	getUmNamespaces() Deprecated. The Usermanagement namespaces for which attributes are stored in the role.
void	saveUmAttributes(String namespace, Attributes attributesToSave) Deprecated. Saves the UM attributes.

Method Detail

getPcdName

String getPcdName()
                  throws NamingException

Deprecated.

The PCD URL including the JNDI scheme. Example: pcd:portal_content/roles/com.sap.exampleRole

Throws:

NamingException

getId

String getId()
             throws NamingException

Deprecated.

The ID (the PCD atomic name). Example: com.sap.exampleRole

Throws:

NamingException

getLocation

String getLocation()
                   throws NamingException

Deprecated.

The location (the directory) including the JNDI scheme. Example: pcd:portal_content/roles

Throws:

NamingException

getTitle

String getTitle(Locale locale)

Deprecated.

The Locale-dependent title for the role.

Parameters:

locale - the Locale for which to read the title. May be null; the title in the PCD default Locale will then be searched. If no title is found, the title in the original Locale of the role will then be returned.

getDescription

String getDescription(Locale locale)

Deprecated.

The Locale-dependent description (long text) for the role.

See Also:

getTitle(Locale)

getShortName

String getShortName()
                    throws NamingException

Deprecated.

The short name (Hashed name). This is a hashed representation of the PCD URL and thus unique within the PCD. Example: ++XI/Xc875e20oQwidGJaTd+FTw=

Throws:

NamingException

getUmAttributes

Attributes getUmAttributes(String namespace)
                           throws NamingException

Deprecated.

A subset of the role's attributes with an internal namespace. Changes to Attributes must be persisted using saveUmAttributes().

Returns:

a specific implementation of Attributes with certain restrictions, e.g. it allows only to store String objects. The namespace is not stripped off from these attributes.

Throws:

NamingException

saveUmAttributes

void saveUmAttributes(String namespace,
                      Attributes attributesToSave)
                      throws NamingException

Deprecated.

Saves the UM attributes.

Parameters:

namespace - the namespace. All existing attributes with this namespace will be deleted before saving the attributes provided in the Attributes parameter

attributesToSave - contains the attributes to save. The attrbutes are expected to have IDs that start with the proper namespace.

Throws:

NamingException

getUmNamespaces

NamingEnumeration getUmNamespaces()
                                  throws NamingException

Deprecated.

The Usermanagement namespaces for which attributes are stored in the role. If saveUmAttributes is performed with a namespace and a non-empty Attributes parameter, the given namespace will be added to this list if it wasn't there already. If saveAttributes with an empty Attributes parameter is performed (which amounts to deleting all attributes of this namespace), the namespace will be removed from the list.

Returns:

a possibly empty NamingEnumeration of Strings

Throws:

NamingException - if no namespaces are found

getPcdNamespace

String getPcdNamespace()
                       throws NamingException

Deprecated.

The namespace of this role in the PCD. Namespaces are defined by the last occurence of the '.' character in the atomic name of the role, for example if the atomic name was com.sap.exampleRole, the namespace would be com.sap, whereas the root name would be exampleRole. In the case of an atomic name ending with a '.', e.g. com.sap.dotRole., the namespace would be com.sap.dotRole and the root name would be empty. If the atomic name starts with a '.' or does not contain any '.', the namespace is empty.

Returns:

the namespace, may be empty

Throws:

NamingException

See Also:

getPcdRootName(), getId()

getPcdRootName

String getPcdRootName()
                      throws NamingException

Deprecated.

The root name of that role in the PCD, i.e. the atomic name without the namespace. Example: if the atomic name was com.sap.exampleRole, the root name would be exampleRole. If the atomic ends with a '.', the root name would be empty. If the atomic name starts with a '.', the root name is equal to the atomic name after removing the '.'.

Returns:

the namespace, may be empty

Throws:

NamingException

See Also:

getPcdNamespace(), getId()

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] EP-BASIS	[sap.com] tc/epbc/ume/ep5/deprecateddeprecated	api	EP-PIN
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM