com.webmethods.portal.service.dir

Interface IRoleProvider

All Superinterfaces:

IComponent, IDirSystemManagementObject, IInitializable

public interface IRoleProvider
extends IDirSystemManagementObject

The IRole provider manages the configuration and contents of all the registered roles.

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 and Description
IThingID	getImplementationID(IDirRole dirRole) Get the thingID that is the 'storage' or 'implementation' for the dir role.
IDirPrincipalList	getRoleMembership(IDirRole dirRole) Return the membership of this role.
boolean	isMemberOfRole(IURI principalURI, IDirRole dirRole) Determines whether the user/group is a member of the role
void	modifyRoleMembership(IURI principalURI, IDirRole dirRole, boolean add) Adds or removes a principal to the role
boolean	supportsRoleMembershipLookup() Not all role providers support looking up role membership; in fact most don't.
boolean	supportsRoleModification() Whether or not this IRoleProvider supports modifications of its roles.

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

getPortletBean

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 Detail

isMemberOfRole

boolean isMemberOfRole(IURI principalURI,
                       IDirRole dirRole)
                throws PortalException

Determines whether the user/group is a member of the role

Parameters:

principalURI -

dirRole -

Returns:

true if a member, false otherwise

Throws:

PortalException

supportsRoleModification

boolean supportsRoleModification()
                          throws PortalException

Whether or not this IRoleProvider supports modifications of its roles. For isntance, an LDAP Role Provider does not

Throws:

PortalException

modifyRoleMembership

void modifyRoleMembership(IURI principalURI,
                          IDirRole dirRole,
                          boolean add)
                   throws PortalException

Adds or removes a principal to the role

Throws:

PortalException

getImplementationID

IThingID getImplementationID(IDirRole dirRole)
                      throws PortalException

Get the thingID that is the 'storage' or 'implementation' for the dir role. It's found via it's relation

Throws:

PortalException

supportsRoleMembershipLookup

boolean supportsRoleMembershipLookup()
                              throws PortalException

Not all role providers support looking up role membership; in fact most don't. For instance, a HttpRule based role provider can never know the full membership list

Returns:

true if supported, false otherwise

Throws:

PortalException

See Also:

getRoleMembership(IDirRole)

getRoleMembership

IDirPrincipalList getRoleMembership(IDirRole dirRole)
                             throws PortalException

Return the membership of this role. NOTE: most providers don't support this

Parameters:

dirRole -

Returns:

a list of the (known) members of this role

Throws:

PortalException

See Also:

supportsRoleMembershipLookup()