public interface IRoleSystem
Modifier and Type | Method and 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
IThing s which
are portlets which implement the IRoleProvider interface and are currently configured. |
IThingIDList |
getRoleProviders(IThingID userID)
Retrieves the list of
IThing s 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
|
void shutdown()
IRoleProvider getRoleProviderFromThing(IThingID thingID) throws PortalException
IRoleProvider
portlet which is associated with this IThingIDthingID
- IRoleProvider
PortalException
IThingIDList getRoleProviders() throws PortalException
IThing
s which
are portlets which implement the IRoleProvider
interface and are currently configured.PortalException
IThingIDList getRoleProviders(IThingID userID) throws PortalException
IThing
s which
are portlets which implement the IRoleProvider
interface and are currently configured.userID
- filtered for the current userPortalException
IThingIDList getRoles() throws PortalException
PortalException
IThingIDList getRoles(IThingID userID) throws PortalException
userID
- filtered for the current userPortalException
IDirRole getRoleFromThing(IThingID thingID) throws PortalException
IDirRole
portlet which is associated with this IThingIDthingID
- IDirRole
PortalException
IDirRole getAdminRole() throws PortalException
PortalException
IThingID findRoleByDN(String dn) throws PortalException
PortalException
IDirRole lookupRoleByID(String uid) throws PortalException
uid
- PortalException
default IListView<IDirRole> lookupRoles(IPagingCookie pagingCookie, int maxResults) throws PortalException, BizException
PortalException
BizException
default IListView<IDirRole> lookupRoles(IPagingCookie pagingCookie, int maxResults, String regEx) throws PortalException, BizException
PortalException
BizException
default IPagingCookie createRoleCookie(IContext context) throws PortalException
PortalException
IPrincipalAttributeProvider getDefaultPrincipalAttributeProvider()
void registerResolver(IRoleResolver resolver)
resolver
- boolean unregisterResolver(IRoleResolver resolver)
List<IRoleResolver> getRoleResolvers()
void clearCache(IDirPrincipal principal) throws PortalException
principal
- the principal to clear the cache forPortalException