com.webmethods.sc.directory
Interface IDirectorySystem

public interface IDirectorySystem

Directory System interface is used to initialize and shutdown shared directory component. Add and remove notification listeners and create directory sessions IDirectorySession, the latter representing the main API interface for shared directory component.

Before attempting to use IDirectorySystem APIs it is required to initialize MWSLibrary class

Method Summary

void	addDirectoryPrincipalListener(IDirectoryPrincipalListener listener) Adds directory principal listener
void	addDirectoryRoleResolver(IDirectoryRoleResolver resolver) Adds directory role resolver
IDirectorySession	createSession() Created default directory session with no permissions restrictions.
IDirectorySession	createSession(IDirectoryUser directoryUser) Created directory session for given directory principal.
void	destroySession(IDirectorySession session) Destroys previously created IDirectorySession
void	refreshPrincipal(String principalID) Refreshes any in-memory cached information about given principal.
void	removeDirectoryPrincipalListener(IDirectoryPrincipalListener listener) Removed directory principal listener
void	removeDirectoryRoleResolver(IDirectoryRoleResolver resolver) Removed directory role resolver

Method Detail

addDirectoryPrincipalListener

void addDirectoryPrincipalListener(IDirectoryPrincipalListener listener)

Adds directory principal listener

Parameters:

listener -

removeDirectoryPrincipalListener

void removeDirectoryPrincipalListener(IDirectoryPrincipalListener listener)

Removed directory principal listener

Parameters:

listener -

addDirectoryRoleResolver

void addDirectoryRoleResolver(IDirectoryRoleResolver resolver)

Adds directory role resolver

Parameters:

resolver -

removeDirectoryRoleResolver

void removeDirectoryRoleResolver(IDirectoryRoleResolver resolver)

Removed directory role resolver

Parameters:

resolver -

createSession

IDirectorySession createSession()
                                throws DirectoryException

Created default directory session with no permissions restrictions. This call is very cheap and there is no limitations on how many sessions may be created. Created sessions never expire unless explicitly destroyed It is important that every created session should be closed using IDirectorySystem.destroySession(IDirectorySession) call

Returns:

valid default instance of the directory session

Throws:

DirectoryException - if there was a failure creating directory session

createSession

IDirectorySession createSession(IDirectoryUser directoryUser)

Created directory session for given directory principal. Created session will obey permissions set in the MWS for the given principal. This is in particular important when doing directory management activities.

This call is very cheap and there is no limitations on how many sessions may be created. It is important that every created session should be closed using IDirectorySystem.destroySession(IDirectorySession) call

Parameters:

directoryUser - user to create directory session for

Returns:

valid instance of directory session for given principal

Throws:

DirectoryException - if there was a failure creating directory session

destroySession

void destroySession(IDirectorySession session)

Destroys previously created IDirectorySession

Parameters:

session -

refreshPrincipal

void refreshPrincipal(String principalID)
                      throws DirectoryException

Refreshes any in-memory cached information about given principal.

Parameters:

principalID -

Throws:

DirectoryException