Package com.webmethods.portal.service.dir

Interface IPrincipalAttributeProvider

All Superinterfaces:

IComponent, IDirSystemManagementObject, IInitializable

All Known Subinterfaces:

IDirService, IPrincipalAttributeProviderEx

public interface IPrincipalAttributeProvider
extends IDirSystemManagementObject

This interface provides external providers to extend a principal's schema by plugging in new attributes for a specific type of principal (user, group or role)

Field Summary

Fields inherited from interface com.webmethods.portal.service.dir.IDirSystemManagementObject

CREATE_GROUP_MODE, CREATE_USER_MODE, CURRENT_PRINCIPAL

Method Summary

Modifier and Type	Method	Description
Object	getAttribute(IURI principalURI, String attrName)	Retrieves an attribute
List<String>	getAttributeNames(int principalType, IURI principalURI)	The attribute names
Map<String,Object>	getAttributes(IURI principalURI)	Retrieve all of the attributes for this principal and this provider
String	getAttributeTitle(int principalType, String attributeName, IURI principalURI, Locale currentLocale)	The attribute title for this attribute name
List<String>	getAttributeTitles(int principalType, IURI principalURI, Locale currentLocale)	The attribute titles for the current locale
void	setAttribute(IURI principalURI, String attrName, Object attrValue)	Sets a new attribute on this provider

Methods inherited from interface com.webmethods.portal.system.IComponent

getComponentData, getComponentName, getComponentProvider, getURI, isInitialized, setComponentData, setComponentProvider

Methods inherited from interface com.webmethods.portal.service.dir.IDirSystemManagementObject

getPortletBean

Methods inherited from interface com.webmethods.portal.system.init.IInitializable

init, shutdown

Method Details

getAttribute

Object getAttribute(IURI principalURI,
 String attrName)
             throws PortalException

Retrieves an attribute

Parameters:

principalURI -

attrName -

Throws:

PortalException

setAttribute

void setAttribute(IURI principalURI,
 String attrName,
 Object attrValue)
           throws PortalException

Sets a new attribute on this provider

Parameters:

principalURI -

attrName -

attrValue -

Throws:

PortalException

getAttributeNames

List<String> getAttributeNames(int principalType,
 IURI principalURI)
                        throws PortalException

The attribute names

Parameters:

principalType - either TYPE_USER, TYPE_GROUP or TYPE_ROLE

principalURI -

Throws:

PortalException

getAttributeTitles

List<String> getAttributeTitles(int principalType,
 IURI principalURI,
 Locale currentLocale)
                         throws PortalException

The attribute titles for the current locale

Parameters:

principalType - either TYPE_USER, TYPE_GROUP or TYPE_ROLE

principalURI -

Throws:

PortalException

getAttributeTitle

String getAttributeTitle(int principalType,
 String attributeName,
 IURI principalURI,
 Locale currentLocale)
                  throws PortalException

The attribute title for this attribute name

Parameters:

principalType - either TYPE_USER, TYPE_GROUP or TYPE_ROLE

attributeName -

principalURI -

currentLocale -

Throws:

PortalException

getAttributes

Map<String,Object> getAttributes(IURI principalURI)
                          throws PortalException

Retrieve all of the attributes for this principal and this provider

Parameters:

principalURI -

Returns:

Throws:

PortalException