Package com.webmethods.portal.bizPolicy.biz.dir

Interface IPrincipalAttributeBizPolicy

All Superinterfaces:

IBizPolicy, IComponent, IInitializable, ISystemHandler

public interface IPrincipalAttributeBizPolicy
extends IBizPolicy

Provides service level biz policies (commands) for the principal attribute providers

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getAllAttributes(IContext context, IURI principalURI)	Get all of the available attributes from all of the principal attribute providers
Object	getAttribute(IContext context, IURI principalURI, IThingID principalAttributeProviderID, String attrName)	Retrieves an attribute
List<String>	getAttributeNames(IContext context, IURI principalURI, IThingID principalAttributeProviderID)	The attribute names
Map<String,Object>	getAttributes(IContext context, IURI principalURI, IThingID principalAttributeProviderID)	Get all of the attributes managed by this principal provider
List<String>	getAttributeTitles(IContext context, IURI principalURI, IThingID principalAttributeProviderID, Locale locale)	The attribute titles
TypedAttribute	getTypedAttribute(IContext context, IURI principalURI, IThingID principalAttributeProviderID, String attrName)	Retrieves an attribute as a TypedAttribute object
Map<String,TypedAttribute>	getTypedAttributes(IContext context, IURI principalURI, IThingID principalAttributeProviderID)	Get all of the attributes managed by this principal provider as a Map of name/TypedAttribute pairs
void	modifyPrincipal(IContext context, IURI principalURI, IThingID principalAttributeProviderID, String attrName, Object attrValue)	Sets a new attribute on this provider
void	modifyPrincipalEx(IContext context, IURI principalURI, IThingID principalAttributeProviderID, Map<String,?> attrMap)	Sets a Map of attribute name/value pairs on this provider
void	modifyRole(IContext context, IURI principalURI, IThingID roleProviderID, Map<String,?> roleProps)	Sets new properties on a role

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

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

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

init, shutdown

Method Details

getAllAttributes

Map<String,Object> getAllAttributes(IContext context,
 IURI principalURI)
                             throws BizException

Get all of the available attributes from all of the principal attribute providers

Parameters:

principalURI -

Returns:

a map of name-value string pairs

Throws:

BizException

getAttributes

Map<String,Object> getAttributes(IContext context,
 IURI principalURI,
 IThingID principalAttributeProviderID)
                          throws BizException

Get all of the attributes managed by this principal provider

Parameters:

principalURI -

principalAttributeProviderID -

Returns:

a map of name-value string pairs

Throws:

BizException

getAttribute

Object getAttribute(IContext context,
 IURI principalURI,
 IThingID principalAttributeProviderID,
 String attrName)
             throws PortalException

Retrieves an attribute

Parameters:

principalURI -

principalAttributeProviderID -

attrName -

Throws:

PortalException

getTypedAttributes

Map<String,TypedAttribute> getTypedAttributes(IContext context,
 IURI principalURI,
 IThingID principalAttributeProviderID)
                                       throws BizException

Get all of the attributes managed by this principal provider as a Map of name/TypedAttribute pairs

Parameters:

principalURI -

principalAttributeProviderID -

Returns:

a map of name/TypedAttribute pairs

Throws:

BizException

getTypedAttribute

TypedAttribute getTypedAttribute(IContext context,
 IURI principalURI,
 IThingID principalAttributeProviderID,
 String attrName)
                          throws PortalException

Retrieves an attribute as a TypedAttribute object

Parameters:

principalURI -

principalAttributeProviderID -

attrName -

Returns:

a TypedAttribute containing attribute information

Throws:

PortalException

modifyPrincipal

void modifyPrincipal(IContext context,
 IURI principalURI,
 IThingID principalAttributeProviderID,
 String attrName,
 Object attrValue)
              throws PortalException

Sets a new attribute on this provider

Parameters:

principalURI -

principalAttributeProviderID -

attrName -

attrValue -

Throws:

PortalException

modifyPrincipalEx

void modifyPrincipalEx(IContext context,
 IURI principalURI,
 IThingID principalAttributeProviderID,
 Map<String,?> attrMap)
                throws PortalException

Sets a Map of attribute name/value pairs on this provider

Parameters:

principalURI -

principalAttributeProviderID -

attrMap - - a map of name/value pairs representing attributes for this provider

Throws:

PortalException

modifyRole

void modifyRole(IContext context,
 IURI principalURI,
 IThingID roleProviderID,
 Map<String,?> roleProps)
         throws BizException

Sets new properties on a role

Parameters:

principalURI -

roleProviderID -

roleProps -

Throws:

BizException

getAttributeNames

List<String> getAttributeNames(IContext context,
 IURI principalURI,
 IThingID principalAttributeProviderID)
                        throws PortalException

The attribute names

Parameters:

principalURI -

principalAttributeProviderID -

Returns:

the attribute names

Throws:

PortalException

getAttributeTitles

List<String> getAttributeTitles(IContext context,
 IURI principalURI,
 IThingID principalAttributeProviderID,
 Locale locale)
                         throws PortalException

The attribute titles

Parameters:

principalURI -

principalAttributeProviderID -

locale - (not currently used)

Returns:

the attribute titles

Throws:

PortalException