public interface IDirServiceMechanics extends IViewableContainerMechanics
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
Modifier and Type | Method and Description |
---|---|
boolean |
canCreatePrincipal(IThingID userID,
IThingID dirServiceID,
String uid)
Whether this user can create a principal in the directory service
|
boolean |
canDeletePrincipal(IThingID userID,
IURI principalURI)
Whether this user can delete a principal in the directory service
|
boolean |
canDeletePrincipalInDirService(IThingID userID,
IThingID dirServiceID)
Whether this user can delete aany principal in the directory service
|
boolean |
canModifyGroupMembers(IThingID userID,
IURI groupURI)
Whether this user can change the membership of a group
|
boolean |
canModifyPrincipalMembership(IThingID userID,
IURI userURI)
Whether this user can change the groups that a user belongs to
|
boolean |
canModifyRoleMembers(IThingID userID,
IURI roleURI)
Whether this user can change the membership of a role
|
void |
checkAccess(IThingID userID,
IThingID dirServiceID)
whether this user can access this directoryService
|
void |
checkCreatePrincipal(IThingID userID,
IThingID dirServiceID,
String uid)
Whether this user can create a principal in the directory service
|
void |
checkDeletePrincipal(IThingID userID,
IURI principalURI)
Whether this user can delete a principal in the directory service
|
void |
checkDeletePrincipalInDirService(IThingID userID,
IThingID dirServiceID)
Whether this user can delete any principal in the directory service
|
void |
checkModifyGroupMembers(IThingID userID,
IURI groupURI)
Whether this user can change the membership of a group
|
void |
checkModifyPrincipalMembership(IThingID userID,
IURI userURI)
Whether this user can change the groups that a user belongs to
|
void |
checkModifyRoleMembers(IThingID userID,
IURI roleURI)
Whether this user can change the membership of a role
|
IDirPrincipal |
createPrincipal(IThingID userID,
IThingID dirServiceID,
int type,
String uid,
Map<String,? extends Object> properties)
Creates a new principal associated with this Directory Service
|
void |
deletePrincipal(IURI principalURI)
deletes a principal
|
void |
fireCreatePrincipalEvent(IDirPrincipal dirPrincipal)
fires an event that a new principal was created
|
default void |
fireDeletePrincipalEvent(IDirPrincipal principal,
IDirPrincipalList membership,
IDirPrincipalList members)
fires an event that a principal was deleted
|
void |
fireDeletePrincipalEvent(IURI principalURI,
IThingID deletedThingID,
IThingID deletedDirectoryPrincipalID,
IDirPrincipalList membership,
IDirPrincipalList members)
Deprecated.
|
void |
fireInitializePrincipalEvent(IThingID principalID)
Fires the initialize principal event
|
void |
fireModifyGroupMembershipEvent(IURI groupURI,
IURI principalURI,
boolean add)
fires an event that a group membership was modified
|
void |
fireModifyRoleMembershipEvent(IURI roleURI,
IURI principalURI,
boolean add)
fires an event that a role membership was modified
|
void |
firePreInitializePrincipalEvent(IURI principalURI)
Fires the pre-initialize principal event
|
boolean |
hasAccess(IThingID userID,
IThingID dirServiceID)
whether this user can access this directoryService
|
IInitializablePrincipal |
initializePrincipal(IURI principalURI)
Initialize the principal in the storage service.
|
IDirPrincipalList |
listPrincipals(IThingID dirServiceID,
int type,
int start,
int end)
List the registered principals, either users or roles
|
IDirPrincipalList |
listPrincipalsEx(IThingID dirServiceID,
int type,
IPagingCookie pagingCookie) |
void |
modifyGroupMembership(IURI groupURI,
IURI principalURI,
boolean add)
modify the membership of a group
|
void |
modifyRoleMembership(IURI roleURI,
IURI principalURI,
boolean add)
modify the membership of a role
|
IDirPrincipalList |
search(IThingID dirServiceID,
int type,
ISearchQuery searchQuery)
Query based on the contents of an ISearchQuery object
|
IDirPrincipalList |
search(IThingID dirServiceID,
int type,
ISearchQuery searchQuery,
IPagingCookie pagingCookie)
Query based on the contents of an ISearchQuery object
|
IDirPrincipalList |
search(IThingID dirServiceID,
int type,
String queryString)
This isn't an LDAP query, but merely a wildcard query, such as 'bob*'
|
IDirPrincipalList |
search(IThingID dirServiceID,
int type,
String queryString,
IPagingCookie pagingCookie)
This isn't an LDAP query, but merely a wildcard query, such as 'bob'
|
List<String> |
updatePrincipalUUID(int args)
Update UUID of the principals in MWS
|
createPagingCookie
canView, checkView, fireViewEvent, getCss, getCss, getDefaultLinkType, getFormattedProperty, getHierachicalUri, getIcon, getIcon, getLink, getLink, getListProperty, getListPropertyHTML, getListPropertyJS, isEnabled, view, view
getComponentData, getComponentName, getComponentProvider, getURI, isInitialized, setComponentData, setComponentProvider
init, shutdown
IInitializablePrincipal initializePrincipal(IURI principalURI) throws PortalException
principalURI
- the principal to initializePortalException
void firePreInitializePrincipalEvent(IURI principalURI) throws PortalException
principalURI
- the principalURI that is about to be initializedPortalException
void fireInitializePrincipalEvent(IThingID principalID) throws PortalException
principalID
- the principalID the event corresponds toPortalException
boolean hasAccess(IThingID userID, IThingID dirServiceID) throws PortalException
userID
- dirServiceID
- PortalAccessException
PortalException
void checkAccess(IThingID userID, IThingID dirServiceID) throws PortalException, PortalAccessException
userID
- dirServiceID
- PortalAccessException
PortalException
IDirPrincipalList listPrincipals(IThingID dirServiceID, int type, int start, int end) throws PortalException
dirServiceID
- the thingid of the directory servicetype
- either IDirConstants.TYPE_USER
or IDirConstants.TYPE_GROUP
start
- 0 is the first possible entryend
- must be greater then start or -1 for allIDirPrincipalList
PortalException
IDirPrincipalList listPrincipalsEx(IThingID dirServiceID, int type, IPagingCookie pagingCookie) throws PortalException
dirServiceID
- the thingid of the directory servicetype
- either IDirConstants.TYPE_USER
or IDirConstants.TYPE_GROUP
pagingCookie
- IPagingCookie
IDirPrincipalList
PortalException
listPrincipals(com.webmethods.portal.service.meta2.thing.IThingID, int, int, int)
IDirPrincipalList search(IThingID dirServiceID, int type, String queryString) throws PortalException
dirServiceID
- the thingid of the directory servicetype
- either IDirConstants.TYPE_USER
or IDirConstants.TYPE_GROUP
queryString
- IDirPrincipalList
PortalException
IDirPrincipalList search(IThingID dirServiceID, int type, String queryString, IPagingCookie pagingCookie) throws PortalException
dirServiceID
- the thingid of the directory servicetype
- either IDirConstants.TYPE_USER
or IDirConstants.TYPE_GROUP
queryString
- pagingCookie
- IDirPrincipalList
PortalException
IDirPrincipalList search(IThingID dirServiceID, int type, ISearchQuery searchQuery) throws PortalException
dirServiceID
- the thingid of the directory servicetype
- either IDirConstants.TYPE_USER
or IDirConstants.TYPE_GROUP
searchQuery
- pagingCookie
- IDirPrincipalList
PortalException
IDirPrincipalList search(IThingID dirServiceID, int type, ISearchQuery searchQuery, IPagingCookie pagingCookie) throws PortalException
dirServiceID
- the thingid of the directory servicetype
- either IDirConstants.TYPE_USER
or IDirConstants.TYPE_GROUP
searchQuery
- pagingCookie
- IDirPrincipalList
PortalException
boolean canCreatePrincipal(IThingID userID, IThingID dirServiceID, String uid) throws PortalException
dirServiceID
- userID
- uid
- PortalAccessException
PortalException
void checkCreatePrincipal(IThingID userID, IThingID dirServiceID, String uid) throws PortalAccessException, PortalException
dirServiceID
- userID
- uid
- PortalAccessException
PortalException
IDirPrincipal createPrincipal(IThingID userID, IThingID dirServiceID, int type, String uid, Map<String,? extends Object> properties) throws PortalException
type
- either IDirConstants.TYPE_USER
or IDirConstants.TYPE_GROUP
uid
- properties
- name-value pairsPortalException
void fireCreatePrincipalEvent(IDirPrincipal dirPrincipal) throws PortalException
PortalException
boolean canDeletePrincipal(IThingID userID, IURI principalURI) throws PortalException
principalURI
- userID
- PortalAccessException
PortalException
void checkDeletePrincipal(IThingID userID, IURI principalURI) throws PortalException, PortalAccessException
principalURI
- PortalAccessException
PortalException
boolean canDeletePrincipalInDirService(IThingID userID, IThingID dirServiceID) throws PortalException
dirServiceID
- userID
- PortalAccessException
PortalException
void checkDeletePrincipalInDirService(IThingID userID, IThingID dirServiceID) throws PortalException, PortalAccessException
dirServiceID
- PortalAccessException
PortalException
void deletePrincipal(IURI principalURI) throws PortalException
principalURI
- the principal to deletePortalException
@Deprecated void fireDeletePrincipalEvent(IURI principalURI, IThingID deletedThingID, IThingID deletedDirectoryPrincipalID, IDirPrincipalList membership, IDirPrincipalList members) throws PortalException
PortalException
default void fireDeletePrincipalEvent(IDirPrincipal principal, IDirPrincipalList membership, IDirPrincipalList members) throws PortalException
PortalException
boolean canModifyGroupMembers(IThingID userID, IURI groupURI) throws PortalException
groupURI
- userID
- PortalAccessException
PortalException
boolean canModifyRoleMembers(IThingID userID, IURI roleURI) throws PortalException
roleURI
- userID
- PortalAccessException
PortalException
boolean canModifyPrincipalMembership(IThingID userID, IURI userURI) throws PortalException
userURI
- userID
- PortalAccessException
PortalException
void checkModifyGroupMembers(IThingID userID, IURI groupURI) throws PortalException, PortalAccessException
groupURI
- PortalAccessException
PortalException
void checkModifyRoleMembers(IThingID userID, IURI roleURI) throws PortalException, PortalAccessException
roleURI
- PortalAccessException
PortalException
void checkModifyPrincipalMembership(IThingID userID, IURI userURI) throws PortalException
userURI
- userID
- PortalAccessException
PortalException
void modifyGroupMembership(IURI groupURI, IURI principalURI, boolean add) throws PortalException
groupURI
- the group to modifyprincipalURI
- the principal to add or removeadd
- whether to add or remove the principal from the groupPortalException
void modifyRoleMembership(IURI roleURI, IURI principalURI, boolean add) throws PortalException
roleURI
- the group to modifyprincipalURI
- the principal to add or removeadd
- whether to add or remove the principal from the groupPortalException
void fireModifyGroupMembershipEvent(IURI groupURI, IURI principalURI, boolean add) throws PortalException
groupURI
- the group to modifyprincipalURI
- the principal to add or removeadd
- whether to add or remove the principal from the groupPortalException
void fireModifyRoleMembershipEvent(IURI roleURI, IURI principalURI, boolean add) throws PortalException
roleURI
- the group to modifyprincipalURI
- the principal to add or removeadd
- whether to add or remove the principal from the groupPortalException
List<String> updatePrincipalUUID(int args) throws PortalException
PortalException