Package com.webmethods.portal.mech.dir

Interface IPrincipalMechanics

All Superinterfaces:

IComponent, IInitializable, IMechanics, ISystemHandler, IViewableContainerMechanics, IViewableMechanics

All Known Subinterfaces:

IGroupMechanics, IRoleMechanics, IUserMechanics

public interface IPrincipalMechanics
extends IViewableContainerMechanics

This operates on both the metadata store's IUser, IGroup and IRole

and also deals with the directory server's IDirPrincipal and it's related subclasses

Field Summary

Fields inherited from interface com.webmethods.portal.mech.view.IViewableMechanics

COMMENTS_LINK_TYPE, CONTENT_LINK_TYPE, DEFAULT_ORDER, DEFAULT_PAGE_SIZE, DEFAULT_SORT, DETAILS_LINK_TYPE, LARGE_ICON_TYPE, LINK_TYPE, LINK_TYPE_COMMENTS, LINK_TYPE_CONTENT, LINK_TYPE_DETAILS, LINK_TYPE_EDIT, LINK_TYPE_HELP, LINK_TYPE_HELP_MAXIMIZED, LINK_TYPE_MAXIMIZED, LINK_TYPE_MINIMIZED, LINK_TYPE_PERMISSIONS, LINK_TYPE_PORTAL_CONTENT, LINK_TYPE_PORTLET_STANDALONE, LINK_TYPE_PROPERTIES, LINK_TYPE_RESTORED, LINK_TYPE_SUBSCRIPTIONS, LINK_TYPE_THUMBNAILS, LINK_TYPE_VERSIONS, PERMISSIONS_LINK_TYPE, PORTAL_CONTENT_LINK_TYPE, PROPERTIES_LINK_TYPE, PROPERTY_LINK_TARGET, PROPERTY_OWNER_NAME, PROPERTY_PARENT_NAME, PROPERTY_TOOLTIP, REFERENCE_ICON_TYPE, SUBSCRIPTIONS_LINK_TYPE, THUMBNAIL_ICON_TYPE, THUMBNAILS_LINK_TYPE, VERSIONS_LINK_TYPE

Method Summary

Modifier and Type	Method	Description
void	checkAccess(IThingID userID, IURI principalURI)	whether this user can access this principal
void	fireDNUpdationEventEvent(String oldDN, String newDN, boolean isUpdationRequired)	DN has changed
void	fireGroupMembershipEvent(IThingID userID, IURI principalURI, IDirPrincipalList origPrincipalList, IDirPrincipalList newPrincipalList)	Group membership has changed
void	fireGroupMembershipEvent(IThingID userID, IURI principalURI, IDirPrincipalList origPrincipalList, IDirPrincipalList newPrincipalList, int newAction)	Group membership has changed
void	fireRoleMembershipEvent(IThingID userID, IURI principalURI, IDirPrincipalList origPrincipalList, IDirPrincipalList newPrincipalList)	Membership has changed
void	fireRoleMembershipEvent(IThingID userID, IURI principalURI, IDirPrincipalList origPrincipalList, IDirPrincipalList newPrincipalList, int newAction)	Membership has changed
IDirPrincipalList	getGroupMembership(IURI principalURI)	Retrieve the group membership for this principal
IDirPrincipalList	getMembers(IURI principalURI)	Get the members of this collection.
IThingID	getPrincipalThingID(IURI principalURI)	Takes a principal's IURI (directory uri) and returns the metadata store's IThingID Guarantees that this principal is initalized with the metadata store
IURI	getPrincipalURI(IThingID principalThingID)	Takes a metadata store's IThingID and returns the directory URI
IDirPrincipalList	getRoleMembership(IURI principalURI)	Retrieve the role membership for this principal
boolean	hasAccess(IThingID userID, IURI principalURI)	whether this user can access this principal

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

Methods inherited from interface com.webmethods.portal.mech.view.IViewableContainerMechanics

createPagingCookie

Methods inherited from interface com.webmethods.portal.mech.view.IViewableMechanics

canView, checkView, fireViewEvent, getCss, getCss, getDefaultLinkType, getFormattedProperty, getHierachicalUri, getIcon, getIcon, getLink, getLink, getListProperty, getListPropertyHTML, getListPropertyJS, isEnabled, view, view

Method Details

getPrincipalThingID

IThingID getPrincipalThingID(IURI principalURI)
                      throws PortalException

Takes a principal's IURI (directory uri) and returns the metadata store's IThingID Guarantees that this principal is initalized with the metadata store

Parameters:

principalURI -

Throws:

PortalException

See Also:

• getPrincipalURI(com.webmethods.portal.service.meta2.thing.IThingID)

getPrincipalURI

IURI getPrincipalURI(IThingID principalThingID)
              throws PortalException

Takes a metadata store's IThingID and returns the directory URI

Parameters:

principalThingID -

Throws:

PortalException

See Also:

• getPrincipalThingID(com.webmethods.portal.system.IURI)

getGroupMembership

IDirPrincipalList getGroupMembership(IURI principalURI)
                              throws PortalException

Retrieve the group membership for this principal

Parameters:

principalURI -

Returns:

the IDirPrincipalList

Throws:

PortalException

getRoleMembership

IDirPrincipalList getRoleMembership(IURI principalURI)
                             throws PortalException

Retrieve the role membership for this principal

Parameters:

principalURI -

Returns:

the IDirPrincipalList

Throws:

PortalException

getMembers

IDirPrincipalList getMembers(IURI principalURI)
                      throws PortalException

Get the members of this collection. Not valid for users, only groups and roles

Parameters:

principalURI -

Returns:

a membership list

Throws:

PortalException

hasAccess

boolean hasAccess(IThingID userID,
 IURI principalURI)
           throws PortalException

whether this user can access this principal

Parameters:

userID -

principalURI -

Returns:

Throws:

PortalAccessException

PortalException

checkAccess

void checkAccess(IThingID userID,
 IURI principalURI)
          throws PortalException,
PortalAccessException

whether this user can access this principal

Parameters:

userID -

principalURI -

Throws:

PortalAccessException

PortalException

fireRoleMembershipEvent

void fireRoleMembershipEvent(IThingID userID,
 IURI principalURI,
 IDirPrincipalList origPrincipalList,
 IDirPrincipalList newPrincipalList)
                      throws PortalException

Membership has changed

Parameters:

userID - who did the change

principalURI - the role

origPrincipalList - the original role membership

newPrincipalList - the new membership

Throws:

PortalException

fireRoleMembershipEvent

void fireRoleMembershipEvent(IThingID userID,
 IURI principalURI,
 IDirPrincipalList origPrincipalList,
 IDirPrincipalList newPrincipalList,
 int newAction)
                      throws PortalException

Membership has changed

Parameters:

userID - who did the change

principalURI - the role

origPrincipalList - the original role membership

newPrincipalList - the new membership

newAction - the action

Throws:

PortalException

fireGroupMembershipEvent

void fireGroupMembershipEvent(IThingID userID,
 IURI principalURI,
 IDirPrincipalList origPrincipalList,
 IDirPrincipalList newPrincipalList)
                       throws PortalException

Group membership has changed

Parameters:

userID - who did the change

principalURI - the group

origPrincipalList - the original group membership

newPrincipalList - the new membership

Throws:

PortalException

fireGroupMembershipEvent

void fireGroupMembershipEvent(IThingID userID,
 IURI principalURI,
 IDirPrincipalList origPrincipalList,
 IDirPrincipalList newPrincipalList,
 int newAction)
                       throws PortalException

Group membership has changed

Parameters:

userID - who did the change

principalURI - the group

origPrincipalList - the original group membership

newPrincipalList - the new membership

newAction - the action

Throws:

PortalException

fireDNUpdationEventEvent

void fireDNUpdationEventEvent(String oldDN,
 String newDN,
 boolean isUpdationRequired)
                       throws PortalException

DN has changed

Parameters:

oldDN - the previous DN

newDN - the new DN

isUpdationRequired - true or false

Throws:

PortalException