Package com.webmethods.portal.service.dir

Interface IRoleSystem

public interface IRoleSystem

Date: Oct 19, 2004

Method Summary

Modifier and Type	Method	Description
void	clearCache(IDirPrincipal principal)	Clear any cached information for the supplied principal
default IPagingCookie	createRoleCookie(IContext context)
IThingID	findRoleByDN(String dn)	Given a dn, find the role
IDirRole	getAdminRole()	Returns the admin role
IPrincipalAttributeProvider	getDefaultPrincipalAttributeProvider()
IDirRole	getRoleFromThing(IThingID thingID)	Returns the IDirRole portlet which is associated with this IThingID
IRoleProvider	getRoleProviderFromThing(IThingID thingID)	Returns the IRoleProvider portlet which is associated with this IThingID
IThingIDList	getRoleProviders()	Retrieves the list of IThings which are portlets which implement the IRoleProvider interface and are currently configured.
IThingIDList	getRoleProviders(IThingID userID)	Retrieves the list of IThings which are portlets which implement the IRoleProvider interface and are currently configured.
List<IRoleResolver>	getRoleResolvers()	Get all available resolvers
IThingIDList	getRoles()	Returns a list of IThingIDs that is all of the defined roles in the portal
IThingIDList	getRoles(IThingID userID)	Returns a list of IThingIDs that is all of the defined roles in the portal
IDirRole	lookupRoleByID(String uid)	Lookup a role based on its uid
default IListView<IDirRole>	lookupRoles(IPagingCookie pagingCookie, int maxResults)
default IListView<IDirRole>	lookupRoles(IPagingCookie pagingCookie, int maxResults, String regEx)
void	registerResolver(IRoleResolver resolver)	Register a new resolver
void	shutdown()	Called during shutdown to allow the object to release resources
boolean	unregisterResolver(IRoleResolver resolver)	un register

Method Details

shutdown

void shutdown()

Called during shutdown to allow the object to release resources

getRoleProviderFromThing

IRoleProvider getRoleProviderFromThing(IThingID thingID)
                                throws PortalException

Returns the IRoleProvider portlet which is associated with this IThingID

Parameters:

thingID -

Returns:

an IRoleProvider

Throws:

PortalException

getRoleProviders

IThingIDList getRoleProviders()
                       throws PortalException

Retrieves the list of IThings which are portlets which implement the IRoleProvider interface and are currently configured.

Returns:

list of IThingIDs

Throws:

PortalException

getRoleProviders

IThingIDList getRoleProviders(IThingID userID)
                       throws PortalException

Retrieves the list of IThings which are portlets which implement the IRoleProvider interface and are currently configured.

Parameters:

userID - filtered for the current user

Returns:

list of IThingIDs

Throws:

PortalException

getRoles

IThingIDList getRoles()
               throws PortalException

Returns a list of IThingIDs that is all of the defined roles in the portal

Throws:

PortalException

getRoles

IThingIDList getRoles(IThingID userID)
               throws PortalException

Returns a list of IThingIDs that is all of the defined roles in the portal

Parameters:

userID - filtered for the current user

Throws:

PortalException

getRoleFromThing

IDirRole getRoleFromThing(IThingID thingID)
                   throws PortalException

Returns the IDirRole portlet which is associated with this IThingID

Parameters:

thingID -

Returns:

an IDirRole

Throws:

PortalException

getAdminRole

IDirRole getAdminRole()
               throws PortalException

Returns the admin role

Throws:

PortalException

findRoleByDN

IThingID findRoleByDN(String dn)
               throws PortalException

Given a dn, find the role

Throws:

PortalException

lookupRoleByID

IDirRole lookupRoleByID(String uid)
                 throws PortalException

Lookup a role based on its uid

Parameters:

uid -

Throws:

PortalException

lookupRoles

default IListView<IDirRole> lookupRoles(IPagingCookie pagingCookie,
 int maxResults)
                                 throws PortalException,
BizException

Throws:

PortalException

BizException

lookupRoles

default IListView<IDirRole> lookupRoles(IPagingCookie pagingCookie,
 int maxResults,
 String regEx)
                                 throws PortalException,
BizException

Throws:

PortalException

BizException

createRoleCookie

default IPagingCookie createRoleCookie(IContext context)
                                throws PortalException

Throws:

PortalException

getDefaultPrincipalAttributeProvider

IPrincipalAttributeProvider getDefaultPrincipalAttributeProvider()

Returns:

the default pap for roles

registerResolver

void registerResolver(IRoleResolver resolver)

Register a new resolver

Parameters:

resolver -

unregisterResolver

boolean unregisterResolver(IRoleResolver resolver)

un register

getRoleResolvers

List<IRoleResolver> getRoleResolvers()

Get all available resolvers

clearCache

void clearCache(IDirPrincipal principal)
         throws PortalException

Clear any cached information for the supplied principal

Parameters:

principal - the principal to clear the cache for

Throws:

PortalException