com.atlassian.crowd.directory.loader
Interface InternalDirectoryInstanceLoader

All Superinterfaces:

DirectoryInstanceLoader

All Known Implementing Classes:

InternalDirectoryInstanceLoaderImpl

public interface InternalDirectoryInstanceLoader
extends DirectoryInstanceLoader

An extension of DirectoryInstanceLoader specialised for Internal Directories.

Note that the getDirectory(com.atlassian.crowd.embedded.api.Directory) and getRawDirectory(Long, String, java.util.Map) methods have been specialised to return instances of InternalRemoteDirectory.

Method Summary

InternalRemoteDirectory	getDirectory(Directory directory) Loads the RemoteDirectory implementation class for a specific (already saved) Directory configuration.
InternalRemoteDirectory	getRawDirectory(java.lang.Long id, java.lang.String className, java.util.Map<java.lang.String,java.lang.String> attributes) Loads a guaranteed un-cached directory implementation for a specific configuration.

Methods inherited from interface com.atlassian.crowd.directory.loader.DirectoryInstanceLoader

canLoad

Method Detail

getDirectory

InternalRemoteDirectory getDirectory(Directory directory)
                                     throws DirectoryInstantiationException

Description copied from interface: DirectoryInstanceLoader

Loads the RemoteDirectory implementation class for a specific (already saved) Directory configuration.

Implementations of this method may choose to cache the RemoteDirectory, so this must only be called for Directories that have been successfully saved.

Specified by:

getDirectory in interface DirectoryInstanceLoader

Parameters:

directory - The directory to load the RemoteDirectory implementation from.

Returns:

instance of InternalRemoteDirectory.

Throws:

DirectoryInstantiationException - If the RemoteDirectory implementation could not be loaded.

See Also:

DirectoryInstanceLoader

getRawDirectory

InternalRemoteDirectory getRawDirectory(java.lang.Long id,
                                        java.lang.String className,
                                        java.util.Map<java.lang.String,java.lang.String> attributes)
                                        throws DirectoryInstantiationException

Description copied from interface: DirectoryInstanceLoader

Loads a guaranteed un-cached directory implementation for a specific configuration.

Specified by:

getRawDirectory in interface DirectoryInstanceLoader

Parameters:

id - Directory ID

className - class name of directory.

attributes - the configuration attributes to pass to the RemoteDirectory

Returns:

instance of InternalRemoteDirectory.

Throws:

DirectoryInstantiationException - if a RemoteDirectory implementation can not be loaded.

See Also:

DirectoryInstanceLoader