Package com.axemble.vdoc.sdk.modules

Interface IDirectoryModule

All Superinterfaces:

IBaseDirectoryModule, IModule, Remote

All Known Implementing Classes:

DirectoryModuleImpl

public interface IDirectoryModule
extends IBaseDirectoryModule

The directory module interface.

Code sample :

 // creation of a directory module object
 IDirectoryModule directoryModule = SDKFactory.MODULES.getDirectoryModule();
 try
 {
 }
 finally
 {
  // uninitialize the module
        SDKFactory.MODULES.releaseModule(directoryModule);
 }
 

See Also:

• IUser
• IGroup
• ILocalization
• IOrganization

Method Summary

Modifier and Type	Method	Description
void	addChild(IGroup child, IGroup group)	Adds a child group.
void	addLocalizationScope(ILocalizationScopeSupport localizationScopeSupport, ILocalization localization, boolean heritable)	Add localizationScope to the localizationScopeSupport object
void	addMember(IUser user, IGroup group)	Adds a user to a group.
void	addOrganizationScope(IUser user, IOrganization organization, boolean heritable)	Add OrganizationScope to the User object
void	breakLocalizationScopeInheritance(ILocalizationScopeSupport localizationScopeSupport)	break the localizationScope inheritance for the localizationScopeSupport object
void	breakOrganizationScopeInheritance(IUser user)	break the organizationScope inheritance for the user object
IAttachment	createAttachment(IContext context, File file)	Allows to create an IAttachment object from a java.io.File object.
IAttachment	createAttachment(IContext context, File file, boolean canBeRemoved)	Allows to create an IAttachment object from a java.io.File object.
IAttachment	createAttachment(IContext context, String fileName, byte[] bytes)
IAttachment	createAttachment(IContext context, String fileName, InputStream input)	Allows to create an IAttachment object from a file name and an input stream.
IAttribute	createAttribute(String name, int type, Object value)	Deprecated. use getExtendedAttributes method instead.
IGroup	createGroup(IContext context, IGroup group, String label)	Allows to create a child group.
IGroup	createGroup(IContext context, IGroup group, String name, String label)	Allows to create a child group.
IGroup	createGroup(IContext context, IOrganization organization, String label)	Deprecated. use createGroup( IContext context, IOrganization organization, String name, String label ) method instead.
IGroup	createGroup(IContext context, IOrganization organization, String name, String label)	Allows to create a group.
IGroup	createGroup(IContext context, IOrganization organization, String name, String label, String categoryName)	Allows to create a group.
ILocalization	createLocalization(IContext context, ILocalization localization, String label)	Deprecated. : use createLocalization( IContext context, ILocalization localization, String name, String label ) method instead.
ILocalization	createLocalization(IContext context, ILocalization localization, String name, String label)	Allows to create a child localization.
ILocalization	createLocalization(IContext context, String label)	Deprecated. : use createLocalization( IContext context, ILocalization localization, String label ) method instead.
ILocalization	createLocalization(IContext context, String name, String label)	Allows to create a localization at the root level.
IOrganization	createOrganization(IContext context, IOrganization organization, String label)	Deprecated. : use createOrganization( IContext context, IOrganization organization, String name, String label ) method instead.
IOrganization	createOrganization(IContext context, IOrganization organization, String name, String label)	Allows to create a child organization.
IOrganization	createOrganization(IContext context, String label)	Deprecated. : use createOrganization( IContext context, String name, String label ) method instead.
IOrganization	createOrganization(IContext context, String name, String label)	Allows to create an organization at the root level.
IProfile	createSystemProfile(IContext context, String name)	Creates a IProfile.
IUser	createUser(IContext context, String login, String password, IOrganization organization)	Allows to create a user into an organization.
Collection<? extends IGroup>	getAllChildren(IGroup group)	Retrieves all the children of a specified group object.
Collection<? extends IUser>	getAllMembers(IGroup group)	Retrieves all the members of the group.
Collection<? extends IGroup>	getAllParents(IGroup group)	Retrieves all the parents of a specified group object.
Collection<? extends IGroup>	getAllParents(IUser user)	Retrieves all the parents of a specified user.
ICatalog	getCatalog()	Gets the extended attributes catalog
Collection<? extends IGroup>	getChildren(IGroup group)	Retrieves the children of a specified group object.
IDirectoryTransformer	getDirectoryTransformer()	Gets a directory transformer.
IElement	getElement(Object object)	Retrieves an IElement object from an object.
IProtocolSupport	getElementByProtocolURI(String protocolURI)	Gets an IElement object which implements IProtocolSupport interface.
IGroup	getGroup(IContext context, IOrganization organization, String name)	Retrieves a group by its system name on an organization scope.
IGroup	getGroup(IContext context, String name)	Deprecated. The system name is not unique on the server scope anymore.
IGroup	getGroup(IStorageKey key)	Retrieves a group object by its IStorageKey object.
IGroup	getGroup(Object object)	Deprecated. use getGroup( IStorageKey ) instead
ILocalization	getLocalization(IContext context, ILocalization parent, String name)	Deprecated. use getLocalization( IContext context, String name ) method instead.
ILocalization	getLocalization(IContext context, String name)	Retrieves a localization by its system name.
ILocalization	getLocalization(IStorageKey key)	Retrieves a localization object by its IStorageKey object.
ILocalization	getLocalization(Object object)	Deprecated. use getLocalization( IStorageKey ) instead
ILocalization	getLocalizationByPathLabel(IContext context, String path)	Retrieves a localization by its path.
String	getLocalizationPathLabel(ILocalization localization)	Generate path label of the localization "/" in label will be replaced by "\\/"
Collection<? extends ILocalization>	getLocalizations(IContext context)	Retrieves all the localizations.
Collection<? extends ILocalization>	getLocalizations(IContext context, ILocalization parent)	Retrieves the localizations of a ILocalization object.
Collection<? extends IDirectoryLocalizationScope>	getLocalizationScopes(ILocalizationScopeSupport localizationScopeSupport)	get the localizationScopes for the localizationScopeSupport object
Collection<? extends IUser>	getMembers(IGroup group)	Retrieves the members of the group.
IOrganization	getOrganization(IContext context, IOrganization parent, String name)	Deprecated. : use getOrganization(IContext, String) method instead.
IOrganization	getOrganization(IContext context, String name)	Retrieves an organization by its system name (the system name is unique on the server).
IOrganization	getOrganization(IStorageKey key)	Retrieves an organization by its IStorageKey object.
IOrganization	getOrganization(Object object)	Deprecated. use getOrganization( IStorageKey ) instead
IOrganization	getOrganizationByPathLabel(IContext context, String path)	Retrieves an organization by its path.
String	getOrganizationPathLabel(IOrganization organization)	Generate path label of the organization "/" in label will be replaced by "\\/"
Collection<? extends IOrganization>	getOrganizations(IContext context)	Retrieves all the organizations.
Collection<? extends IOrganization>	getOrganizations(IContext context, IOrganization parent)	Retrieves the organizations of a specified IOrganization object.
Collection<? extends IDirectoryOrganizationScope>	getOrganizationScopes(IUser user)	Gets the OrganizationScope for the User object
Collection<? extends IGroup>	getParents(IGroup group)	Retrieves the direct parents of a specified group object.
Collection<? extends IGroup>	getParents(IUser user)	Retrieves the parents of a specified user.
IResourceDefinition	getResourceDefinition(IContext context, String name)	Gets an extended attributes table
ISearchController	getSearchController()
ISearchController	getSearchController(IConnectionDefinition connectionDefinition)	Gets a search controller object by specifying a IConnectionDefinition object.
ISearchController	getSearchController(IDataSourceReference reference)	Gets a search controller object by specifying a IDataSourceReference object.
ISearchController	getSearchController(IJdbcReference reference)	Deprecated. use getSearchController( IConnectionDefinition connectionDefinition ) method instead.
ISecurityController	getSecurityController(ISecuritySupport securitySupport)	Gets a security controller to manipulate the rights on a specified object.
IProfile	getSystemProfile(IContext context, String name)	Retrieves a system IProfile object by its system name.
Collection<? extends IProfile>	getSystemProfiles(IContext context)	Retrieves a collection of system IProfile objects.
ITransformer	getTransformer()	Gets a transformer.
IUser	getUser(IStorageKey key)	Retrieves a user object by its IStorageKey object.
IUser	getUser(Object object)	Deprecated. use getUser( IStorageKey ) instead
IUser	getUserByLogin(String login)	Retrieves a user from its login.
Collection<? extends IUser>	getUsers(IContext context)	Retrieves all the users.
Collection<? extends IUser>	getUsers(IContext context, ILocalization localization)	Retrieves all the users of a specified localization.
Collection<? extends IUser>	getUsers(IContext context, IOrganization organization)	Retrieves all the users of a specified organization.
boolean	isChildOf(IGroup child, IGroup parent, boolean recursive)	Checks if the group is child of another group.
boolean	isLocalizationScopeInherited(ILocalizationScopeSupport localizationScopeSupport)	Checks if the localization scope is inherited
boolean	isMemberOf(IUser user, IGroup group, boolean recursive)	Checks if a user is member of a group.
boolean	isOrganizationScopeInherited(IUser user)	is organizationScope inheritance
void	removeChild(IGroup child, IGroup group)	Removes a child group object.
void	removeLocalizationScope(ILocalizationScopeSupport localizationScopeSupport, IDirectoryLocalizationScope directoryLocalizationScope)	remove the localizationScope to the localizationScopeSupport object
void	removeMember(IUser user, IGroup group)	Removes a user from a group.
void	removeOrganizationScope(IUser user, IDirectoryOrganizationScope directoryOrganizationScope)	Removes the directoryOrganizationScope to the user's OrganizationScope
void	restoreLocalizationScopeInheritance(ILocalizationScopeSupport localizationScopeSupport)	restore the localizationScope inheritance for the localizationScopeSupport object
void	restoreOrganizationScopeInheritance(IUser user)	restore the organizationScope inheritance for the user object

Methods inherited from interface com.axemble.vdoc.sdk.modules.IModule

beginTransaction, beginTransaction, commitTransaction, commitTransaction, convertId, findNativeClass, generateSystemName, getAnonymous, getAnonymousContext, getContext, getContext, getContextByLogin, getElementFromExternalElement, getExternalElement, getExternalElement, getLoggedOnUser, getLoggedOnUserContext, getLoggedOnUserLanguage, getProtocolPath, getProtocolPath, getProtocolURI, getProtocolURI, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getSysadmin, getSysadminContext, getTranslation, getTranslationForLanguage, getTranslationKey, initialize, isTransactionActive, rollbackTransaction, rollbackTransaction, setTransactionTimeout, unInitialize

Method Details

getOrganizations

Collection<? extends IOrganization> getOrganizations(IContext context)
                                              throws DirectoryModuleException

Retrieves all the organizations.

Specified by:

getOrganizations in interface IBaseDirectoryModule

Parameters:

context - The execution context.

Returns:

A java.util.Collection of IOrganization objects.

Throws:

DirectoryModuleException - default module exception.

getOrganizations

Collection<? extends IOrganization> getOrganizations(IContext context,
 IOrganization parent)
                                              throws DirectoryModuleException

Retrieves the organizations of a specified IOrganization object.

Specified by:

getOrganizations in interface IBaseDirectoryModule

Parameters:

context - The execution context.

parent - The parent IOrganization object.

Returns:

A java.util.Collection of IOrganization objects.

Throws:

DirectoryModuleException - default module exception.

createOrganization

@Deprecated
IOrganization createOrganization(IContext context,
 String label)
                          throws DirectoryModuleException

Deprecated.

: use createOrganization( IContext context, String name, String label ) method instead.

Allows to create an organization at the root level.

Specified by:

createOrganization in interface IBaseDirectoryModule

Parameters:

context - The execution context.

label - The label of the organization. Be aware the system name of the organization will be generated.

Returns:

A IOrganization object.

Throws:

DirectoryModuleException - default module exception.

createOrganization

IOrganization createOrganization(IContext context,
 String name,
 String label)
                          throws DirectoryModuleException

Allows to create an organization at the root level.

Specified by:

createOrganization in interface IBaseDirectoryModule

Parameters:

context - The execution context.

name - The system name of the organization.

label - The label of the organization. Be aware the system name of the organization will be generated.

Returns:

A IOrganization object.

Throws:

DirectoryModuleException - default module exception.

createOrganization

@Deprecated
IOrganization createOrganization(IContext context,
 IOrganization organization,
 String label)
                          throws DirectoryModuleException

Deprecated.

: use createOrganization( IContext context, IOrganization organization, String name, String label ) method instead.

Allows to create a child organization.

Specified by:

createOrganization in interface IBaseDirectoryModule

Parameters:

context - The execution context.

organization - The parent IOrganization object.

label - The label of the organization. Be aware the system name of the organization will be generated.

Returns:

A IOrganization object

Throws:

DirectoryModuleException - default module exception.

createOrganization

IOrganization createOrganization(IContext context,
 IOrganization organization,
 String name,
 String label)
                          throws DirectoryModuleException

Allows to create a child organization.

Specified by:

createOrganization in interface IBaseDirectoryModule

Parameters:

context - The execution context.

organization - The parent IOrganization object.

name - The system name of the organization.

label - The label of the organization. Be aware the system name of the organization will be generated.

Returns:

A IOrganization object.

Throws:

DirectoryModuleException - default module exception.

getOrganization

IOrganization getOrganization(IContext context,
 String name)
                       throws DirectoryModuleException

Retrieves an organization by its system name (the system name is unique on the server).

Specified by:

getOrganization in interface IBaseDirectoryModule

Parameters:

context - The execution context.

name - The system name of the organization.

Returns:

A IOrganization object

Throws:

DirectoryModuleException - default module exception.

getOrganization

@Deprecated
IOrganization getOrganization(IContext context,
 IOrganization parent,
 String name)
                       throws DirectoryModuleException

Deprecated.

: use getOrganization(IContext, String) method instead.

Retrieves an organization by its name and a parent organization.

Specified by:

getOrganization in interface IBaseDirectoryModule

Parameters:

context - The execution context.

parent - The parent IOrganization object.

name - The system name of the organization.

Returns:

A IOrganization object.

Throws:

DirectoryModuleException - default module exception.

getOrganizationByPathLabel

IOrganization getOrganizationByPathLabel(IContext context,
 String path)
                                  throws DirectoryModuleException

Retrieves an organization by its path.

Specified by:

getOrganizationByPathLabel in interface IBaseDirectoryModule

Parameters:

context - The execution context.

path - The path built from the labels.

Returns:

A IOrganization object.

Throws:

DirectoryModuleException - default module exception.

getOrganization

IOrganization getOrganization(IStorageKey key)
                       throws DirectoryModuleException

Retrieves an organization by its IStorageKey object.

Specified by:

getOrganization in interface IBaseDirectoryModule

Parameters:

key - The storage key object.

Returns:

A IOrganization object.

Throws:

DirectoryModuleException - default module exception.

getLocalizations

Collection<? extends ILocalization> getLocalizations(IContext context)
                                              throws DirectoryModuleException

Retrieves all the localizations.

Specified by:

getLocalizations in interface IBaseDirectoryModule

Parameters:

context - The execution context.

Returns:

A java.util.Collection of ILocalization objects.

Throws:

DirectoryModuleException - default module exception.

getLocalizations

Collection<? extends ILocalization> getLocalizations(IContext context,
 ILocalization parent)
                                              throws DirectoryModuleException

Retrieves the localizations of a ILocalization object.

Specified by:

getLocalizations in interface IBaseDirectoryModule

Parameters:

context - The execution context.

parent - The parent ILocalization object.

Returns:

A java.util.Collection of ILocalization objects.

Throws:

DirectoryModuleException - default module exception.

createLocalization

@Deprecated
ILocalization createLocalization(IContext context,
 String label)
                          throws DirectoryModuleException

Deprecated.

: use createLocalization( IContext context, ILocalization localization, String label ) method instead.

Allows to create a localization at the root level.

Specified by:

createLocalization in interface IBaseDirectoryModule

Parameters:

context - The execution context.

label - The label of the localization. Be aware the system name will be generated automatically.

Returns:

A ILocalization object.

Throws:

DirectoryModuleException - default module exception.

createLocalization

ILocalization createLocalization(IContext context,
 String name,
 String label)
                          throws DirectoryModuleException

Allows to create a localization at the root level.

Specified by:

createLocalization in interface IBaseDirectoryModule

Parameters:

context - The execution context.

name - The system name of the localization.

label - The label of the localization.

Returns:

A ILocalization object.

Throws:

DirectoryModuleException - default module exception.

createLocalization

@Deprecated
ILocalization createLocalization(IContext context,
 ILocalization localization,
 String label)
                          throws DirectoryModuleException

Deprecated.

: use createLocalization( IContext context, ILocalization localization, String name, String label ) method instead.

Allows to create a child localization.

Specified by:

createLocalization in interface IBaseDirectoryModule

Parameters:

context - The execution context.

localization - The parent ILocalization object.

label - The label of the localization. Be aware the system name will be generated automatically.

Returns:

A ILocalization object.

Throws:

DirectoryModuleException - default module exception.

createLocalization

ILocalization createLocalization(IContext context,
 ILocalization localization,
 String name,
 String label)
                          throws DirectoryModuleException

Allows to create a child localization.

Specified by:

createLocalization in interface IBaseDirectoryModule

Parameters:

context - The execution context.

localization - The parent ILocalization object.

name - The system name of the localization.

label - The label of the localization.

Returns:

A ILocalization object.

Throws:

DirectoryModuleException - default module exception.

getLocalization

@Deprecated
ILocalization getLocalization(IContext context,
 ILocalization parent,
 String name)
                       throws DirectoryModuleException

Deprecated.

use getLocalization( IContext context, String name ) method instead.

Retrieves a localization by its system name and a parent localization object.

Specified by:

getLocalization in interface IBaseDirectoryModule

Parameters:

context - The execution context.

parent - The parent ILocalization object.

name - The system name of the localization.

Returns:

A ILocalization object.

Throws:

DirectoryModuleException - default module exception.

getLocalization

ILocalization getLocalization(IContext context,
 String name)
                       throws DirectoryModuleException

Retrieves a localization by its system name.

Specified by:

getLocalization in interface IBaseDirectoryModule

Parameters:

context - The execution context.

name - The system name of the localization.

Returns:

A ILocalization object.

Throws:

DirectoryModuleException - default module exception.

getLocalizationByPathLabel

ILocalization getLocalizationByPathLabel(IContext context,
 String path)
                                  throws DirectoryModuleException

Retrieves a localization by its path.

Specified by:

getLocalizationByPathLabel in interface IBaseDirectoryModule

Parameters:

context - The execution context.

path - The path of the localization built from labels.

Returns:

A ILocalization object.

Throws:

DirectoryModuleException - default module exception.

getLocalization

ILocalization getLocalization(IStorageKey key)
                       throws DirectoryModuleException

Retrieves a localization object by its IStorageKey object.

Specified by:

getLocalization in interface IBaseDirectoryModule

Parameters:

key - The IStorageKey object.

Returns:

A ILocalization object.

Throws:

DirectoryModuleException - default module exception.

createGroup

@Deprecated
IGroup createGroup(IContext context,
 IOrganization organization,
 String label)
            throws DirectoryModuleException

Deprecated.

use createGroup( IContext context, IOrganization organization, String name, String label ) method instead.

Allows to create a group.

Specified by:

createGroup in interface IBaseDirectoryModule

Parameters:

context - The execution context.

organization - The organization object.

label - The label of the group. Be aware the system name will be automatically generated.

Returns:

A IGroup object.

Throws:

DirectoryModuleException - default module exception.

createGroup

IGroup createGroup(IContext context,
 IOrganization organization,
 String name,
 String label)
            throws DirectoryModuleException

Allows to create a group.

Specified by:

createGroup in interface IBaseDirectoryModule

Parameters:

context - The execution context.

organization - The organization object.

name - The system name of the group.

label - The label of the group.

Returns:

A IGroup object.

Throws:

DirectoryModuleException - default module exception.

createGroup

IGroup createGroup(IContext context,
 IOrganization organization,
 String name,
 String label,
 String categoryName)
            throws DirectoryModuleException

Allows to create a group.

Parameters:

context - The execution context.

organization - The organization object.

name - The system name of the group.

label - The label of the group.

categoryName - The category's name of the group.

Returns:

A IGroup object.

Throws:

DirectoryModuleException - default module exception.

createGroup

IGroup createGroup(IContext context,
 IGroup group,
 String label)
            throws DirectoryModuleException

Allows to create a child group.

Specified by:

createGroup in interface IBaseDirectoryModule

Parameters:

context - The execution context.

group - The parent group.

label - The label of the group. Be aware the system name will be generated automatically.

Returns:

A IGroup object.

Throws:

DirectoryModuleException - default module exception.

createGroup

IGroup createGroup(IContext context,
 IGroup group,
 String name,
 String label)
            throws DirectoryModuleException

Allows to create a child group.

Specified by:

createGroup in interface IBaseDirectoryModule

Parameters:

context - The execution context.

group - The parent group.

name - The system name of the group.

label - The label of the group.

Returns:

A IGroup object.

Throws:

DirectoryModuleException - default module exception.

getGroup

@Deprecated
IGroup getGroup(IContext context,
 String name)
         throws DirectoryModuleException

Deprecated.

The system name is not unique on the server scope anymore. You should pass the parent IOrganization object. Use the getGroup( IContext context, IOrganization organization, String name ) method instead.

Retrieves a group by its system name.

Specified by:

getGroup in interface IBaseDirectoryModule

Parameters:

context - The execution context.

name - The system name of the group.

Returns:

A IGroup object.

Throws:

DirectoryModuleException - default module exception.

getGroup

IGroup getGroup(IContext context,
 IOrganization organization,
 String name)
         throws DirectoryModuleException

Retrieves a group by its system name on an organization scope.

Specified by:

getGroup in interface IBaseDirectoryModule

Parameters:

context - The execution context.

organization - The parent IOrganization object.

name - The system name of the group.

Returns:

A IGroup object.

Throws:

DirectoryModuleException - default module exception.

getGroup

IGroup getGroup(IStorageKey key)
         throws DirectoryModuleException

Retrieves a group object by its IStorageKey object.

Specified by:

getGroup in interface IBaseDirectoryModule

Parameters:

key - The IStorageKey object.

Returns:

A IGroup object.

Throws:

DirectoryModuleException - default module exception.

createUser

IUser createUser(IContext context,
 String login,
 String password,
 IOrganization organization)
          throws DirectoryModuleException

Allows to create a user into an organization.

Specified by:

createUser in interface IBaseDirectoryModule

Parameters:

context - The execution context.

login - The login of the user

password - The password of the user

organization - The parent IOrganization object.

Returns:

A IUser object.

Throws:

DirectoryModuleException - default module exception.

getUsers

Collection<? extends IUser> getUsers(IContext context)

Retrieves all the users.

Specified by:

getUsers in interface IBaseDirectoryModule

Parameters:

context - The execution context.

Returns:

A java.util.Collection of IUser objects.

getUsers

Collection<? extends IUser> getUsers(IContext context,
 IOrganization organization)

Retrieves all the users of a specified organization.

Specified by:

getUsers in interface IBaseDirectoryModule

Parameters:

context - The execution context.

organization - The IOrganization object.

Returns:

A java.util.Collection of IUser objects.

getUsers

Collection<? extends IUser> getUsers(IContext context,
 ILocalization localization)

Retrieves all the users of a specified localization.

Specified by:

getUsers in interface IBaseDirectoryModule

Parameters:

context - The execution context.

localization - The ILocalization object.

Returns:

A java.util.Collection of IUser objects.

getUserByLogin

IUser getUserByLogin(String login)

Retrieves a user from its login.

Specified by:

getUserByLogin in interface IBaseDirectoryModule

Parameters:

login - The login of the user.

Returns:

A IUser object.

getUser

IUser getUser(IStorageKey key)

Retrieves a user object by its IStorageKey object.

Specified by:

getUser in interface IBaseDirectoryModule

Parameters:

key - The IStorageKey object.

Returns:

A IUser object.

createSystemProfile

IProfile createSystemProfile(IContext context,
 String name)
                      throws ModuleException

Creates a IProfile.

Specified by:

createSystemProfile in interface IBaseDirectoryModule

Parameters:

context - The execution context.

name - The system name of the IProfile to be created.

Returns:

a IProfile object.

Throws:

ModuleException - default module exception.

getSystemProfile

IProfile getSystemProfile(IContext context,
 String name)
                   throws ModuleException

Retrieves a system IProfile object by its system name.

Specified by:

getSystemProfile in interface IBaseDirectoryModule

Parameters:

context - The execution context.

name - The system name of the role.

Returns:

a IProfile object.

Throws:

ModuleException - default module exception.

getSystemProfiles

Collection<? extends IProfile> getSystemProfiles(IContext context)
                                          throws ModuleException

Retrieves a collection of system IProfile objects.

Specified by:

getSystemProfiles in interface IBaseDirectoryModule

Parameters:

context - The execution context.

Returns:

a collection of system IProfile objects.

Throws:

ModuleException - default module exception.

createAttribute

@Deprecated
IAttribute createAttribute(String name,
 int type,
 Object value)

Deprecated.

use getExtendedAttributes method instead.

Allows to create an attribute.

Specified by:

createAttribute in interface IBaseDirectoryModule

Parameters:

name - The name of the attribute.

type - The type of the attribute. Check the IAttribute.IType interface.

value - The associated value to the attribute.

Returns:

A IAttribute object.

getOrganization

@Deprecated
IOrganization getOrganization(Object object)
                       throws DirectoryModuleException

Deprecated.

use getOrganization( IStorageKey ) instead

Retrieves an organization from an object.

Specified by:

getOrganization in interface IBaseDirectoryModule

Parameters:

object - Any object of the following type:

• A java.lang.Long
• java.lang.String
• or com.triactive.jdo.store.OID

Returns:

A IOrganization object.

Throws:

DirectoryModuleException - default module exception.

getLocalization

@Deprecated
ILocalization getLocalization(Object object)
                       throws DirectoryModuleException

Deprecated.

use getLocalization( IStorageKey ) instead

Retrieves an localization from an object.

Specified by:

getLocalization in interface IBaseDirectoryModule

Parameters:

object - Any object of the following type:

• A java.lang.Long
• java.lang.String
• or com.triactive.jdo.store.OID

Returns:

A ILocalization object.

Throws:

DirectoryModuleException - default module exception.

getGroup

@Deprecated
IGroup getGroup(Object object)
         throws DirectoryModuleException

Deprecated.

use getGroup( IStorageKey ) instead

Retrieves a group from an object.

Specified by:

getGroup in interface IBaseDirectoryModule

Parameters:

object - Any object of the following type:

• A java.lang.Long
• java.lang.String
• or com.triactive.jdo.store.OID

Returns:

A IGroup object.

Throws:

DirectoryModuleException - default module exception.

getUser

@Deprecated
IUser getUser(Object object)
       throws DirectoryModuleException

Deprecated.

use getUser( IStorageKey ) instead

Retrieves a user from an object.

Specified by:

getUser in interface IBaseDirectoryModule

Parameters:

object - Any object of the following type:

• A java.lang.Long
• java.lang.String
• or com.triactive.jdo.store.OID

Returns:

A IUser object.

Throws:

DirectoryModuleException - default module exception.

getElement

IElement getElement(Object object)
             throws DirectoryModuleException

Retrieves an IElement object from an object.

Specified by:

getElement in interface IBaseDirectoryModule

Parameters:

object - Any object of the following type:

• A java.lang.Long
• java.lang.String
• or com.triactive.jdo.store.OID

Returns:

A IElement object.

Throws:

DirectoryModuleException - default module exception.

addChild

void addChild(IGroup child,
 IGroup group)
       throws DirectoryModuleException

Adds a child group.

Specified by:

addChild in interface IBaseDirectoryModule

Parameters:

child - The child group.

group - The parent group.

Throws:

DirectoryModuleException - default module exception.

removeChild

void removeChild(IGroup child,
 IGroup group)
          throws DirectoryModuleException

Removes a child group object.

Specified by:

removeChild in interface IBaseDirectoryModule

Parameters:

child - The child group.

group - The parent group.

Throws:

DirectoryModuleException - default module exception.

isChildOf

boolean isChildOf(IGroup child,
 IGroup parent,
 boolean recursive)

Checks if the group is child of another group.

Specified by:

isChildOf in interface IBaseDirectoryModule

Parameters:

child - The child group.

parent - The parent group.

recursive - if true checks recursively.

Returns:

true if the group is child of the parent group, false otherwise.

getParents

Collection<? extends IGroup> getParents(IGroup group)

Retrieves the direct parents of a specified group object.

Specified by:

getParents in interface IBaseDirectoryModule

Parameters:

group - The group to search for.

Returns:

A java.util.Collection of IGroup objects.

getAllParents

Collection<? extends IGroup> getAllParents(IGroup group)

Retrieves all the parents of a specified group object.

Specified by:

getAllParents in interface IBaseDirectoryModule

Parameters:

group - The group to search for.

Returns:

A java.util.Collection of IGroup objects.

getChildren

Collection<? extends IGroup> getChildren(IGroup group)

Retrieves the children of a specified group object.

Specified by:

getChildren in interface IBaseDirectoryModule

Parameters:

group - The group to search for.

Returns:

A java.util.Collection of IGroup objects.

getAllChildren

Collection<? extends IGroup> getAllChildren(IGroup group)

Retrieves all the children of a specified group object.

Specified by:

getAllChildren in interface IBaseDirectoryModule

Parameters:

group - The group to search for.

Returns:

A java.util.Collection of IGroup objects.

addMember

void addMember(IUser user,
 IGroup group)
        throws DirectoryModuleException

Adds a user to a group.

Specified by:

addMember in interface IBaseDirectoryModule

Parameters:

user - The user object to add.

group - The parent group.

Throws:

DirectoryModuleException - default module exception.

removeMember

void removeMember(IUser user,
 IGroup group)
           throws DirectoryModuleException

Removes a user from a group.

Specified by:

removeMember in interface IBaseDirectoryModule

Parameters:

user - The user object to add.

group - The parent group.

Throws:

DirectoryModuleException - default module exception.

isMemberOf

boolean isMemberOf(IUser user,
 IGroup group,
 boolean recursive)

Checks if a user is member of a group.

Specified by:

isMemberOf in interface IBaseDirectoryModule

Parameters:

user - The user

group - The group

recursive - if true checks recursively.

Returns:

true if the user is member of the group, false otherwise.

getParents

Collection<? extends IGroup> getParents(IUser user)

Retrieves the parents of a specified user.

Specified by:

getParents in interface IBaseDirectoryModule

Parameters:

user - The user to search for.

Returns:

A java.util.Collection of IGroup objects.

getAllParents

Collection<? extends IGroup> getAllParents(IUser user)

Retrieves all the parents of a specified user.

Specified by:

getAllParents in interface IBaseDirectoryModule

Parameters:

user - The user to search for.

Returns:

A java.util.Collection of IGroup objects.

getMembers

Collection<? extends IUser> getMembers(IGroup group)

Retrieves the members of the group.

Specified by:

getMembers in interface IBaseDirectoryModule

Parameters:

group - The group.

Returns:

A java.util.Collection of IUser objects.

getAllMembers

Collection<? extends IUser> getAllMembers(IGroup group)

Retrieves all the members of the group.

Specified by:

getAllMembers in interface IBaseDirectoryModule

Parameters:

group - The group.

Returns:

A java.util.Collection of IUser objects.

getElementByProtocolURI

IProtocolSupport getElementByProtocolURI(String protocolURI)
                                  throws ModuleException

Gets an IElement object which implements IProtocolSupport interface.

Specified by:

getElementByProtocolURI in interface IBaseDirectoryModule

Parameters:

protocolURI - The protocol URI as a java.lang.String.

Returns:

A IProtocolSupport object.

Throws:

ModuleException - default module exception.

getSearchController

ISearchController getSearchController()
                               throws DirectoryModuleException

Specified by:

getSearchController in interface IBaseDirectoryModule

Throws:

DirectoryModuleException

getSearchController

@Deprecated
ISearchController getSearchController(IJdbcReference reference)
                               throws DirectoryModuleException

Deprecated.

use getSearchController( IConnectionDefinition connectionDefinition ) method instead.

Gets a search controller object by specifying a JDBC external reference.

Specified by:

getSearchController in interface IBaseDirectoryModule

Parameters:

reference - The IJdbcReference object.

Returns:

The ISearchController object.

Throws:

DirectoryModuleException - default module exception.

getSearchController

ISearchController getSearchController(IConnectionDefinition connectionDefinition)
                               throws DirectoryModuleException

Gets a search controller object by specifying a IConnectionDefinition object.

Specified by:

getSearchController in interface IBaseDirectoryModule

Parameters:

connectionDefinition - The IConnectionDefinition object.

Returns:

A ISearchController object.

Throws:

DirectoryModuleException - Default module exception.

getSearchController

ISearchController getSearchController(IDataSourceReference reference)
                               throws DirectoryModuleException

Gets a search controller object by specifying a IDataSourceReference object.

Specified by:

getSearchController in interface IBaseDirectoryModule

Parameters:

reference - The IDataSourceReference object.

Returns:

A ISearchController object.

Throws:

DirectoryModuleException - Default module exception.

getSecurityController

ISecurityController getSecurityController(ISecuritySupport securitySupport)
                                   throws DirectoryModuleException

Gets a security controller to manipulate the rights on a specified object.

Specified by:

getSecurityController in interface IBaseDirectoryModule

Parameters:

securitySupport - Any ISecuritySupport object.

Returns:

A ISecurityController object.

Throws:

DirectoryModuleException - Default module exception.

getTransformer

ITransformer getTransformer()
                     throws DirectoryModuleException

Gets a transformer.

Specified by:

getTransformer in interface IBaseDirectoryModule

Returns:

A ITransformer object.

Throws:

DirectoryModuleException - Default module exception.

getDirectoryTransformer

IDirectoryTransformer getDirectoryTransformer()
                                       throws DirectoryModuleException

Gets a directory transformer.

Specified by:

getDirectoryTransformer in interface IBaseDirectoryModule

Returns:

A IDirectoryTransformer object.

Throws:

DirectoryModuleException - Default module exception.

createAttachment

IAttachment createAttachment(IContext context,
 String fileName,
 InputStream input)

Allows to create an IAttachment object from a file name and an input stream.

Specified by:

createAttachment in interface IBaseDirectoryModule

Parameters:

context - The execution context.

fileName - A java.lang.String value.

input - An InputStream object.

Returns:

A IAttachment object.

createAttachment

IAttachment createAttachment(IContext context,
 File file)

Allows to create an IAttachment object from a java.io.File object.

Specified by:

createAttachment in interface IBaseDirectoryModule

Parameters:

context - The execution context.

file - A java.io.File object.

Returns:

A IAttachment object.

createAttachment

IAttachment createAttachment(IContext context,
 File file,
 boolean canBeRemoved)

Allows to create an IAttachment object from a java.io.File object.

Specified by:

createAttachment in interface IBaseDirectoryModule

Parameters:

context - The execution context.

file - A java.io.File object.

canBeRemoved - Specifies if the local file should be removed.

Returns:

A IAttachment object.

createAttachment

IAttachment createAttachment(IContext context,
 String fileName,
 byte[] bytes)

Specified by:

createAttachment in interface IBaseDirectoryModule

Parameters:

context - The execution context.

fileName - A java.lang.String value.

bytes - The content of the attachment as a byte array.

Returns:

A IAttachment object.

getResourceDefinition

IResourceDefinition getResourceDefinition(IContext context,
 String name)
                                   throws DirectoryModuleException

Gets an extended attributes table

Specified by:

getResourceDefinition in interface IBaseDirectoryModule

Parameters:

context - the execution context

name - of the table

Returns:

A IResourceDefinition table

Throws:

DirectoryModuleException - default module exception.

addLocalizationScope

void addLocalizationScope(ILocalizationScopeSupport localizationScopeSupport,
 ILocalization localization,
 boolean heritable)

Add localizationScope to the localizationScopeSupport object

Specified by:

addLocalizationScope in interface IBaseDirectoryModule

Parameters:

localizationScopeSupport - the localizationScopeSupport object

localization - the localization to add

heritable - if true the localizationScope is heritable, otherwise false

getLocalizationScopes

Collection<? extends IDirectoryLocalizationScope> getLocalizationScopes(ILocalizationScopeSupport localizationScopeSupport)

get the localizationScopes for the localizationScopeSupport object

Specified by:

getLocalizationScopes in interface IBaseDirectoryModule

Parameters:

localizationScopeSupport - the localizationScopeSupport

Returns:

a Collection object of IDirectoryLocalizationScope

removeLocalizationScope

void removeLocalizationScope(ILocalizationScopeSupport localizationScopeSupport,
 IDirectoryLocalizationScope directoryLocalizationScope)

remove the localizationScope to the localizationScopeSupport object

Specified by:

removeLocalizationScope in interface IBaseDirectoryModule

Parameters:

localizationScopeSupport - the localizationScopeSupport

directoryLocalizationScope - the directoryLocalizationScope to remove

restoreLocalizationScopeInheritance

void restoreLocalizationScopeInheritance(ILocalizationScopeSupport localizationScopeSupport)

restore the localizationScope inheritance for the localizationScopeSupport object

Specified by:

restoreLocalizationScopeInheritance in interface IBaseDirectoryModule

Parameters:

localizationScopeSupport - the localizationScopeSupport

breakLocalizationScopeInheritance

void breakLocalizationScopeInheritance(ILocalizationScopeSupport localizationScopeSupport)

break the localizationScope inheritance for the localizationScopeSupport object

Specified by:

breakLocalizationScopeInheritance in interface IBaseDirectoryModule

Parameters:

localizationScopeSupport - the localizationScopeSupport

isLocalizationScopeInherited

boolean isLocalizationScopeInherited(ILocalizationScopeSupport localizationScopeSupport)

Checks if the localization scope is inherited

Specified by:

isLocalizationScopeInherited in interface IBaseDirectoryModule

Parameters:

localizationScopeSupport - the localizationScopeSupport

Returns:

true if the localization scope is inherited

addOrganizationScope

void addOrganizationScope(IUser user,
 IOrganization organization,
 boolean heritable)

Add OrganizationScope to the User object

Specified by:

addOrganizationScope in interface IBaseDirectoryModule

Parameters:

user - the user to add the organizationScope

organization - the organization to add

heritable - if true the organizationScope is heritable, otherwise false

getOrganizationScopes

Collection<? extends IDirectoryOrganizationScope> getOrganizationScopes(IUser user)

Gets the OrganizationScope for the User object

Specified by:

getOrganizationScopes in interface IBaseDirectoryModule

Parameters:

user - the user

Returns:

a Collection object of IDirectoryOrganizationScope

removeOrganizationScope

void removeOrganizationScope(IUser user,
 IDirectoryOrganizationScope directoryOrganizationScope)

Removes the directoryOrganizationScope to the user's OrganizationScope

Specified by:

removeOrganizationScope in interface IBaseDirectoryModule

Parameters:

user - the user

directoryOrganizationScope - the directoryOrganizationScope to remove

restoreOrganizationScopeInheritance

void restoreOrganizationScopeInheritance(IUser user)

restore the organizationScope inheritance for the user object

Specified by:

restoreOrganizationScopeInheritance in interface IBaseDirectoryModule

Parameters:

user - the user

breakOrganizationScopeInheritance

void breakOrganizationScopeInheritance(IUser user)

break the organizationScope inheritance for the user object

Specified by:

breakOrganizationScopeInheritance in interface IBaseDirectoryModule

Parameters:

user - the user

isOrganizationScopeInherited

boolean isOrganizationScopeInherited(IUser user)

is organizationScope inheritance

Specified by:

isOrganizationScopeInherited in interface IBaseDirectoryModule

Parameters:

user - the user

Returns:

isOrganizationScopeInherited

getLocalizationPathLabel

String getLocalizationPathLabel(ILocalization localization)

Generate path label of the localization "/" in label will be replaced by "\\/"

Specified by:

getLocalizationPathLabel in interface IBaseDirectoryModule

Parameters:

localization - the localization

Returns:

localization path label

getOrganizationPathLabel

String getOrganizationPathLabel(IOrganization organization)

Generate path label of the organization "/" in label will be replaced by "\\/"

Specified by:

getOrganizationPathLabel in interface IBaseDirectoryModule

Parameters:

organization - the organization

Returns:

organization path label

getCatalog

ICatalog getCatalog()

Gets the extended attributes catalog

Specified by:

getCatalog in interface IBaseDirectoryModule

Returns:

ICatalog the extended attributes catalog