com.sapportals.portal.prt.service.usermanagement

Interface IPortalBasicRoleFactory

Deprecated. only used internally by PCD *

public interface IPortalBasicRoleFactory

Interface for Portal Basic Role Factory

Field Summary

static String	ATTR_PCD_ATOMICNAME Deprecated. The attribute name for the PCD atomic name.
static String	ATTR_PCD_TITLE Deprecated. The attribute name for the PCD tile (language dependent).

Method Summary

boolean	checkExistenceByShortName(String roleShortName) Deprecated. Check role existence
String	convertRoleNameToShortName(String roleName) Deprecated. Convert the name (PCD URL) to the short name.
String	convertRoleShortNameToName(String roleShortName) Deprecated. Convert the short name to the name (PCD URL).
String	escapeSearchAttributeValue(String searchAttributeValue) Deprecated. Make the search attribute value RFC 2254 compliant.
IPortalBasicRole	getRoleByShortName(String roleShortName) Deprecated. Get the role by its short name.
IPortalBasicRole	getRoleByShortName(String roleShortName, com.sap.security.api.IPrincipal principal) Deprecated. Get the role by its short name.
boolean	isAlive() Deprecated.
void	registerEventListener(String name, IPortalBasicRoleEventListener listener) Deprecated. Registration of an event listener.
void	registerFactoryEventListener(IPortalBasicRoleFactoryEventListener listener) Deprecated. Register for shutdown/startup events from the PCD
Enumeration	searchRoleShortNames(Set allowedPcdNamespaces, String searchFilter, Locale searchLocale, long maxNumber, int timeout) Deprecated. Search for roles with a given attribute filtered for a set of PCD Namespaces.
Enumeration	searchRoleShortNames(Set allowedPcdNamespaces, String attributeName, String attributeValue, Locale searchLocale, long maxNumber, int timeout, boolean caseSensitive) Deprecated. Search for roles with a given attribute.
void	unregisterEventListener(String name) Deprecated. Unregistration of an event listener.

Field Detail

ATTR_PCD_TITLE

static final String ATTR_PCD_TITLE

Deprecated.

The attribute name for the PCD tile (language dependent).

See Also:

Constant Field Values

ATTR_PCD_ATOMICNAME

static final String ATTR_PCD_ATOMICNAME

Deprecated.

The attribute name for the PCD atomic name.

See Also:

Constant Field Values

Method Detail

getRoleByShortName

IPortalBasicRole getRoleByShortName(String roleShortName)
                                    throws NamingException

Deprecated.

Get the role by its short name.

Parameters:

roleShortName -

Returns:

the role

Throws:

NamingException - if the role can not be found

See Also:

IPortalBasicRole.getShortName()

getRoleByShortName

IPortalBasicRole getRoleByShortName(String roleShortName,
                                    com.sap.security.api.IPrincipal principal)
                                    throws NamingException

Deprecated.

Get the role by its short name.

Parameters:

roleShortName -

principal - user for role assignment

Returns:

the role

Throws:

NamingException - if the role could not be found or if the user has no permissions for role assignment

searchRoleShortNames

Enumeration searchRoleShortNames(Set allowedPcdNamespaces,
                                 String searchFilter,
                                 Locale searchLocale,
                                 long maxNumber,
                                 int timeout)
                                 throws NamingException

Deprecated.

Search for roles with a given attribute filtered for a set of PCD Namespaces.

Parameters:

allowedPcdNamespaces - a Set of allowed namespaces; if values are provided, only roles with a namespace contained in this Set will be returned; the empty namespace can be specified providing an empty String in this set; if empty, the method behaves like the unfiltered version

searchFilter - the RFC2254 compatible search filter, for example (|(att1=val1)(att2=val2))

searchLocale - the Locale in which to search; if this is null, the search will be performed in the "Empty" Locale, i.e. the fallback Locale of the object

maxNumber -

timeout -

Returns:

an Enumeration of Role short names (as String)

Throws:

NamingException

searchRoleShortNames

Enumeration searchRoleShortNames(Set allowedPcdNamespaces,
                                 String attributeName,
                                 String attributeValue,
                                 Locale searchLocale,
                                 long maxNumber,
                                 int timeout,
                                 boolean caseSensitive)
                                 throws NamingException

Deprecated.

Search for roles with a given attribute.

Parameters:

allowedPcdNamespaces - a Set of allowed namespaces; if values are provided, only roles with a namespace contained in this Set will be returned; the empty namespace can be specified providing an empty String in this set; if empty, the method behaves like the unfiltered version

attributeName - the attribute name including the namespace

attributeValue - the value (with '*' as wildcard)

searchLocale - the Locale in which to search; if this is null, the search will be performed in the "Empty" Locale, i.e. the fallback Locale of the object

maxNumber - the maximum number of roles to return; 0 for all objects

timeout - timeout in milliseconds, 0 for no timeout

caseSensitive -

Returns:

an Enumeration of Role short names (as String)

Throws:

NamingException

registerEventListener

void registerEventListener(String name,
                           IPortalBasicRoleEventListener listener)
                           throws NamingException

Deprecated.

Registration of an event listener.

Parameters:

name - a unique name for registration. Only one registration per name is possible

listener -

Throws:

NamingException

unregisterEventListener

void unregisterEventListener(String name)

Deprecated.

Unregistration of an event listener.

Parameters:

name -

convertRoleShortNameToName

String convertRoleShortNameToName(String roleShortName)
                                  throws NamingException

Deprecated.

Convert the short name to the name (PCD URL). No existence check is performed for the role

Parameters:

roleShortName - the short (hashed) name without provider prefix

Returns:

the PCD URL including the prefix ("pcd:")

Throws:

NamingException

convertRoleNameToShortName

String convertRoleNameToShortName(String roleName)
                                  throws NamingException

Deprecated.

Convert the name (PCD URL) to the short name. No existence check is performed for the role

Parameters:

roleName - the PCD URL including the prefix ("pcd:")

Returns:

the short (hashed) name

Throws:

NamingException

checkExistenceByShortName

boolean checkExistenceByShortName(String roleShortName)

Deprecated.

Check role existence

Parameters:

roleShortName - the short (hashed) role name without provider prefix

Returns:

true if the role exists, otherwise false

escapeSearchAttributeValue

String escapeSearchAttributeValue(String searchAttributeValue)

Deprecated.

Make the search attribute value RFC 2254 compliant. This will only escape '(', ')', and '\\' in order to make the resulting search String parseable; NUL is ignored, and '*' will be kept as wildcard.

Parameters:

searchAttributeValue - search attribute value to be escaped

Returns:

escaped search attribute value

registerFactoryEventListener

void registerFactoryEventListener(IPortalBasicRoleFactoryEventListener listener)

Deprecated.

Register for shutdown/startup events from the PCD

Parameters:

listener -

isAlive

boolean isAlive()

Deprecated.

Returns:

true as long as the PCD is available; see also registerEventListener(String, IPortalBasicRoleEventListener)

Access Rights

This class can be accessed from:

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