Package com.webmethods.portal.service.dir

Interface IDirPrincipalProvider

All Superinterfaces:

IDirAuthenticator, IDirAuthenticatorEx

public interface IDirPrincipalProvider
extends IDirAuthenticatorEx

The IDirPrincipalProvider is where an IDirService manages it's users and groups. It can add/update/delete these principals.

Nested Class Summary

Nested classes/interfaces inherited from interface com.webmethods.portal.service.dir.IDirAuthenticatorEx

IDirAuthenticatorEx.IDirAuthenticationCallback

Method Summary

Modifier and Type	Method	Description
void	addPrincipalToGroup(IURI principalURI, IURI groupURI)	Adds a principal to a group.
IDirPrincipal	createPrincipal(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
IDirPrincipalList	getGroupMembership(IURI principalURI)	Retrieve the group membership for this principal
IDirPrincipalList	getMembers(IURI principalURI)	Get the members of this collection.
IDirPrincipalList	getRoleMembership(IURI principalURI)	Retrieve the role membership for this principal
IInitializablePrincipal	initializePrincipal(IURI principalURI)	Initializes a principal (user or group).
void	removePrincipalFromGroup(IURI principalURI, IURI groupURI)	Removes a principal from a group.
default void	updateUserMemberships(IDirPrincipal principal)

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

authenticateUser

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

authenticateUserEx

Method Details

initializePrincipal

IInitializablePrincipal initializePrincipal(IURI principalURI)
                                     throws PortalException

Initializes a principal (user or group). This implies registration with the portal's internal data store

Parameters:

principalURI -

Throws:

PortalException

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

createPrincipal

IDirPrincipal createPrincipal(int type,
 String uid,
 Map<String,? extends Object> properties)
                       throws PortalException

Creates a new principal associated with this Directory Service

Parameters:

type - either IDirConstants.TYPE_USER or IDirConstants.TYPE_GROUP

uid -

properties - name-value pairs

Returns:

a new IDirPrincipal

Throws:

PortalException

deletePrincipal

void deletePrincipal(IURI principalURI)
              throws PortalException

Deletes a principal

Parameters:

principalURI -

Throws:

PortalException

addPrincipalToGroup

void addPrincipalToGroup(IURI principalURI,
 IURI groupURI)
                  throws PortalException

Adds a principal to a group. Note, both the principal and the group must belong to the same IDirService

Parameters:

principalURI -

groupURI -

Throws:

PortalException

removePrincipalFromGroup

void removePrincipalFromGroup(IURI principalURI,
 IURI groupURI)
                       throws PortalException

Removes a principal from a group. Note, both the principal and the group must belong to the same IDirService

Parameters:

principalURI -

groupURI -

Throws:

PortalException

updateUserMemberships

default void updateUserMemberships(IDirPrincipal principal)
                            throws PortalException

Throws:

PortalException