Package com.axemble.vdoc.sdk.impl

Class DirectoryModuleImpl

java.lang.Object

com.axemble.vdoc.sdk.impl.AbstractTranslaterModule

com.axemble.vdoc.sdk.impl.CoreModule

com.axemble.vdoc.sdk.impl.DirectoryModuleImpl

All Implemented Interfaces:

IBaseDirectoryModule, IDirectoryModule, IModule, Serializable, Remote

public class DirectoryModuleImpl
extends CoreModule
implements IDirectoryModule

The IDirectoryModule implementation

See Also:

• Serialized Form

Field Summary

Fields inherited from class com.axemble.vdoc.sdk.impl.CoreModule

properties

Constructor Summary

Constructors

Constructor	Description
DirectoryModuleImpl()	Deprecated. Use com.axemble.vdoc.sdk.Modules.getDirectoryModule() instead.

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
IReport	beginTransaction()	Starts a new transaction or use the current one.
IReport	beginTransaction(Object currentObject)	Starts a new transaction if required.
void	breakLocalizationScopeInheritance(ILocalizationScopeSupport localizationScopeSupport)	break the localizationScope inheritance for the localizationScopeSupport object
void	breakOrganizationScopeInheritance(IUser user)	break the organizationScope inheritance for the user object
void	commitTransaction()	Commits the current transaction.
void	commitTransaction(Object currentObject)	Commit a transaction
IAttribute	createAttribute(String name, int type, Object value)	Deprecated.
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)	Allows to create a group.
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)	Allows to create a child localization.
ILocalization	createLocalization(IContext context, ILocalization localization, String name, String label)	Allows to create a child localization.
ILocalization	createLocalization(IContext context, String label)	Allows to create a localization at the root level.
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)	Allows to create a child organization.
IOrganization	createOrganization(IContext context, IOrganization organization, String name, String label)	Allows to create a child organization.
IOrganization	createOrganization(IContext context, String label)	Allows to create an organization at the root level.
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.
String	generateSystemName(String label)	Generate a valid system name for this module and this label.
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.
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)	Retrieves a group by its system name.
IGroup	getGroup(IStorageKey key)	Retrieves a group object by its IStorageKey object.
IGroup	getGroup(Object object)	Deprecated.
ILocalization	getLocalization(IContext context, ILocalization parent, String name)	Deprecated.
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.
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.
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.
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)	Gets a search controller object by specifying a JDBC external reference.
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(Object object)	Deprecated.
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.
void	initialize(Properties properties)	Initializes the module.
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
void	rollbackTransaction()	Roll back the current transaction.
void	rollbackTransaction(Object currentObject)	Roll back a transaction

Methods inherited from class com.axemble.vdoc.sdk.impl.CoreModule

convertId, createAttachment, createAttachment, createAttachment, createAttachment, createProfile, findNativeClass, getAnonymous, getAnonymousContext, getComponentsFactory, getConfiguration, getContext, getContext, getContext, getContextByLogin, getDefinitionsFactory, getElementByProtocolURI, getElementFromExternalElement, getExternalElement, getExternalElement, getLanguage, getLoggedOnUser, getLoggedOnUserContext, getLoggedOnUserLanguage, getProfile, getProfile, getProfiles, getProtocolPath, getProtocolPath, getProtocolURI, getProtocolURI, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getSysadmin, getSysadminContext, getUser, getUser, getUserByLogin, isTransactionActive, setTransactionTimeout, unInitialize

Methods inherited from class com.axemble.vdoc.sdk.impl.AbstractTranslaterModule

getTranslation, getTranslationForLanguage, getTranslationKey

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

createAttachment, createAttachment, createAttachment, createAttachment, getElementByProtocolURI, getUser, getUserByLogin

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

convertId, findNativeClass, 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, isTransactionActive, setTransactionTimeout, unInitialize

Constructor Details

DirectoryModuleImpl

@Deprecated
public DirectoryModuleImpl()

Deprecated.

Use com.axemble.vdoc.sdk.Modules.getDirectoryModule() instead.

Method Details

initialize

public void initialize(Properties properties)

Description copied from interface: IModule

Initializes the module.

Specified by:

initialize in interface IModule

Overrides:

initialize in class CoreModule

Parameters:

properties - The custom properties.

beginTransaction

public IReport beginTransaction()

Description copied from interface: IModule

Starts a new transaction or use the current one.

Specified by:

beginTransaction in interface IModule

Overrides:

beginTransaction in class CoreModule

Returns:

The report object.

commitTransaction

public void commitTransaction()

Description copied from interface: IModule

Commits the current transaction.

Specified by:

commitTransaction in interface IModule

Overrides:

commitTransaction in class CoreModule

rollbackTransaction

public void rollbackTransaction()

Description copied from interface: IModule

Roll back the current transaction.

Specified by:

rollbackTransaction in interface IModule

Overrides:

rollbackTransaction in class CoreModule

beginTransaction

public IReport beginTransaction(Object currentObject)

Description copied from interface: IModule

Starts a new transaction if required.

Specified by:

beginTransaction in interface IModule

Overrides:

beginTransaction in class CoreModule

Parameters:

currentObject - The synchronized object. Not used anymore.

Returns:

The report object.

commitTransaction

public void commitTransaction(Object currentObject)

Description copied from class: CoreModule

Commit a transaction

Specified by:

commitTransaction in interface IModule

Overrides:

commitTransaction in class CoreModule

Parameters:

currentObject - The synchronized object. Not used anymore.

rollbackTransaction

public void rollbackTransaction(Object currentObject)

Description copied from class: CoreModule

Roll back a transaction

Specified by:

rollbackTransaction in interface IModule

Overrides:

rollbackTransaction in class CoreModule

Parameters:

currentObject - The synchronized object. Not used anymore.

createGroup

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

Description copied from interface: IDirectoryModule

Allows to create a child group.

Specified by:

createGroup in interface IBaseDirectoryModule

Specified by:

createGroup in interface IDirectoryModule

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

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

Description copied from interface: IDirectoryModule

Allows to create a child group.

Specified by:

createGroup in interface IBaseDirectoryModule

Specified by:

createGroup in interface IDirectoryModule

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.

createGroup

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

Description copied from interface: IDirectoryModule

Allows to create a group.

Specified by:

createGroup in interface IBaseDirectoryModule

Specified by:

createGroup in interface IDirectoryModule

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

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

Description copied from interface: IDirectoryModule

Allows to create a group.

Specified by:

createGroup in interface IBaseDirectoryModule

Specified by:

createGroup in interface IDirectoryModule

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

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

Description copied from interface: IDirectoryModule

Allows to create a group.

Specified by:

createGroup in interface IDirectoryModule

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.

getTransformer

public ITransformer getTransformer()
                            throws DirectoryModuleException

Description copied from interface: IDirectoryModule

Gets a transformer.

Specified by:

getTransformer in interface IBaseDirectoryModule

Specified by:

getTransformer in interface IDirectoryModule

Returns:

A ITransformer object.

Throws:

DirectoryModuleException - Default module exception.

addChild

public void addChild(IGroup child,
 IGroup group)
              throws DirectoryModuleException

Description copied from interface: IDirectoryModule

Adds a child group.

Specified by:

addChild in interface IBaseDirectoryModule

Specified by:

addChild in interface IDirectoryModule

Parameters:

child - The child group.

group - The parent group.

Throws:

DirectoryModuleException - default module exception.

addMember

public void addMember(IUser user,
 IGroup group)
               throws DirectoryModuleException

Description copied from interface: IDirectoryModule

Adds a user to a group.

Specified by:

addMember in interface IBaseDirectoryModule

Specified by:

addMember in interface IDirectoryModule

Parameters:

user - The user object to add.

group - The parent group.

Throws:

DirectoryModuleException - default module exception.

createAttribute

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

Deprecated.

Description copied from interface: IDirectoryModule

Allows to create an attribute.

Specified by:

createAttribute in interface IBaseDirectoryModule

Specified by:

createAttribute in interface IDirectoryModule

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.

createLocalization

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

Description copied from interface: IDirectoryModule

Allows to create a child localization.

Specified by:

createLocalization in interface IBaseDirectoryModule

Specified by:

createLocalization in interface IDirectoryModule

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

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

Description copied from interface: IDirectoryModule

Allows to create a localization at the root level.

Specified by:

createLocalization in interface IBaseDirectoryModule

Specified by:

createLocalization in interface IDirectoryModule

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

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

Description copied from interface: IDirectoryModule

Allows to create a localization at the root level.

Specified by:

createLocalization in interface IBaseDirectoryModule

Specified by:

createLocalization in interface IDirectoryModule

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

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

Description copied from interface: IDirectoryModule

Allows to create a child localization.

Specified by:

createLocalization in interface IBaseDirectoryModule

Specified by:

createLocalization in interface IDirectoryModule

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.

createOrganization

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

Description copied from interface: IDirectoryModule

Allows to create a child organization.

Specified by:

createOrganization in interface IBaseDirectoryModule

Specified by:

createOrganization in interface IDirectoryModule

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

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

Description copied from interface: IDirectoryModule

Allows to create an organization at the root level.

Specified by:

createOrganization in interface IBaseDirectoryModule

Specified by:

createOrganization in interface IDirectoryModule

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

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

Description copied from interface: IDirectoryModule

Allows to create a child organization.

Specified by:

createOrganization in interface IBaseDirectoryModule

Specified by:

createOrganization in interface IDirectoryModule

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.

createOrganization

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

Description copied from interface: IDirectoryModule

Allows to create an organization at the root level.

Specified by:

createOrganization in interface IBaseDirectoryModule

Specified by:

createOrganization in interface IDirectoryModule

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.

createUser

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

Description copied from interface: IDirectoryModule

Allows to create a user into an organization.

Specified by:

createUser in interface IBaseDirectoryModule

Specified by:

createUser in interface IDirectoryModule

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.

getAllChildren

public Collection<? extends IGroup> getAllChildren(IGroup group)

Description copied from interface: IDirectoryModule

Retrieves all the children of a specified group object.

Specified by:

getAllChildren in interface IBaseDirectoryModule

Specified by:

getAllChildren in interface IDirectoryModule

Parameters:

group - The group to search for.

Returns:

A java.util.Collection of IGroup objects.

getAllMembers

public Collection<? extends IUser> getAllMembers(IGroup group)

Description copied from interface: IDirectoryModule

Retrieves all the members of the group.

Specified by:

getAllMembers in interface IBaseDirectoryModule

Specified by:

getAllMembers in interface IDirectoryModule

Parameters:

group - The group.

Returns:

A java.util.Collection of IUser objects.

getAllParents

public Collection<? extends IGroup> getAllParents(IGroup group)

Description copied from interface: IDirectoryModule

Retrieves all the parents of a specified group object.

Specified by:

getAllParents in interface IBaseDirectoryModule

Specified by:

getAllParents in interface IDirectoryModule

Parameters:

group - The group to search for.

Returns:

A java.util.Collection of IGroup objects.

getAllParents

public Collection<? extends IGroup> getAllParents(IUser user)

Description copied from interface: IDirectoryModule

Retrieves all the parents of a specified user.

Specified by:

getAllParents in interface IBaseDirectoryModule

Specified by:

getAllParents in interface IDirectoryModule

Parameters:

user - The user to search for.

Returns:

A java.util.Collection of IGroup objects.

getChildren

public Collection<? extends IGroup> getChildren(IGroup group)

Description copied from interface: IDirectoryModule

Retrieves the children of a specified group object.

Specified by:

getChildren in interface IBaseDirectoryModule

Specified by:

getChildren in interface IDirectoryModule

Parameters:

group - The group to search for.

Returns:

A java.util.Collection of IGroup objects.

getDirectoryTransformer

public IDirectoryTransformer getDirectoryTransformer()
                                              throws DirectoryModuleException

Description copied from interface: IDirectoryModule

Gets a directory transformer.

Specified by:

getDirectoryTransformer in interface IBaseDirectoryModule

Specified by:

getDirectoryTransformer in interface IDirectoryModule

Returns:

A IDirectoryTransformer object.

Throws:

DirectoryModuleException - Default module exception.

getElement

public IElement getElement(Object object)
                    throws DirectoryModuleException

Description copied from interface: IDirectoryModule

Retrieves an IElement object from an object.

Specified by:

getElement in interface IBaseDirectoryModule

Specified by:

getElement in interface IDirectoryModule

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.

getGroup

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

Description copied from interface: IDirectoryModule

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

Specified by:

getGroup in interface IBaseDirectoryModule

Specified by:

getGroup in interface IDirectoryModule

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

public IGroup getGroup(IContext context,
 String name)
                throws DirectoryModuleException

Description copied from interface: IDirectoryModule

Retrieves a group by its system name.

Specified by:

getGroup in interface IBaseDirectoryModule

Specified by:

getGroup in interface IDirectoryModule

Parameters:

context - The execution context.

name - The system name of the group.

Returns:

A IGroup object.

Throws:

DirectoryModuleException - default module exception.

getGroup

@Deprecated
public IGroup getGroup(Object object)
                throws DirectoryModuleException

Deprecated.

Description copied from interface: IDirectoryModule

Retrieves a group from an object.

Specified by:

getGroup in interface IBaseDirectoryModule

Specified by:

getGroup in interface IDirectoryModule

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.

getLocalization

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

Deprecated.

Description copied from interface: IDirectoryModule

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

Specified by:

getLocalization in interface IBaseDirectoryModule

Specified by:

getLocalization in interface IDirectoryModule

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

public ILocalization getLocalization(IContext context,
 String name)
                              throws DirectoryModuleException

Description copied from interface: IDirectoryModule

Retrieves a localization by its system name.

Specified by:

getLocalization in interface IBaseDirectoryModule

Specified by:

getLocalization in interface IDirectoryModule

Parameters:

context - The execution context.

name - The system name of the localization.

Returns:

A ILocalization object.

Throws:

DirectoryModuleException - default module exception.

getLocalization

@Deprecated
public ILocalization getLocalization(Object object)
                              throws DirectoryModuleException

Deprecated.

Description copied from interface: IDirectoryModule

Retrieves an localization from an object.

Specified by:

getLocalization in interface IBaseDirectoryModule

Specified by:

getLocalization in interface IDirectoryModule

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.

getLocalizationByPathLabel

public ILocalization getLocalizationByPathLabel(IContext context,
 String path)
                                         throws DirectoryModuleException

Description copied from interface: IDirectoryModule

Retrieves a localization by its path.

Specified by:

getLocalizationByPathLabel in interface IBaseDirectoryModule

Specified by:

getLocalizationByPathLabel in interface IDirectoryModule

Parameters:

context - The execution context.

path - The path of the localization built from labels.

Returns:

A ILocalization object.

Throws:

DirectoryModuleException - default module exception.

getLocalizationPathLabel

public String getLocalizationPathLabel(ILocalization localization)

Description copied from interface: IDirectoryModule

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

Specified by:

getLocalizationPathLabel in interface IBaseDirectoryModule

Specified by:

getLocalizationPathLabel in interface IDirectoryModule

Parameters:

localization - the localization

Returns:

localization path label

getLocalizations

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

Description copied from interface: IDirectoryModule

Retrieves the localizations of a ILocalization object.

Specified by:

getLocalizations in interface IBaseDirectoryModule

Specified by:

getLocalizations in interface IDirectoryModule

Parameters:

context - The execution context.

parent - The parent ILocalization object.

Returns:

A java.util.Collection of ILocalization objects.

Throws:

DirectoryModuleException - default module exception.

getLocalizations

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

Description copied from interface: IDirectoryModule

Retrieves all the localizations.

Specified by:

getLocalizations in interface IBaseDirectoryModule

Specified by:

getLocalizations in interface IDirectoryModule

Parameters:

context - The execution context.

Returns:

A java.util.Collection of ILocalization objects.

Throws:

DirectoryModuleException - default module exception.

getMembers

public Collection<? extends IUser> getMembers(IGroup group)

Description copied from interface: IDirectoryModule

Retrieves the members of the group.

Specified by:

getMembers in interface IBaseDirectoryModule

Specified by:

getMembers in interface IDirectoryModule

Parameters:

group - The group.

Returns:

A java.util.Collection of IUser objects.

getOrganization

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

Deprecated.

Description copied from interface: IDirectoryModule

Retrieves an organization by its name and a parent organization.

Specified by:

getOrganization in interface IBaseDirectoryModule

Specified by:

getOrganization in interface IDirectoryModule

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.

getOrganization

public IOrganization getOrganization(IContext context,
 String name)
                              throws DirectoryModuleException

Description copied from interface: IDirectoryModule

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

Specified by:

getOrganization in interface IBaseDirectoryModule

Specified by:

getOrganization in interface IDirectoryModule

Parameters:

context - The execution context.

name - The system name of the organization.

Returns:

A IOrganization object

Throws:

DirectoryModuleException - default module exception.

getOrganization

@Deprecated
public IOrganization getOrganization(Object object)
                              throws DirectoryModuleException

Deprecated.

Description copied from interface: IDirectoryModule

Retrieves an organization from an object.

Specified by:

getOrganization in interface IBaseDirectoryModule

Specified by:

getOrganization in interface IDirectoryModule

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.

getOrganizationByPathLabel

public IOrganization getOrganizationByPathLabel(IContext context,
 String path)
                                         throws DirectoryModuleException

Description copied from interface: IDirectoryModule

Retrieves an organization by its path.

Specified by:

getOrganizationByPathLabel in interface IBaseDirectoryModule

Specified by:

getOrganizationByPathLabel in interface IDirectoryModule

Parameters:

context - The execution context.

path - The path built from the labels.

Returns:

A IOrganization object.

Throws:

DirectoryModuleException - default module exception.

getOrganizationPathLabel

public String getOrganizationPathLabel(IOrganization organization)

Description copied from interface: IDirectoryModule

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

Specified by:

getOrganizationPathLabel in interface IBaseDirectoryModule

Specified by:

getOrganizationPathLabel in interface IDirectoryModule

Parameters:

organization - the organization

Returns:

organization path label

getOrganizations

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

Description copied from interface: IDirectoryModule

Retrieves the organizations of a specified IOrganization object.

Specified by:

getOrganizations in interface IBaseDirectoryModule

Specified by:

getOrganizations in interface IDirectoryModule

Parameters:

context - The execution context.

parent - The parent IOrganization object.

Returns:

A java.util.Collection of IOrganization objects.

Throws:

DirectoryModuleException - default module exception.

getOrganizations

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

Description copied from interface: IDirectoryModule

Retrieves all the organizations.

Specified by:

getOrganizations in interface IBaseDirectoryModule

Specified by:

getOrganizations in interface IDirectoryModule

Parameters:

context - The execution context.

Returns:

A java.util.Collection of IOrganization objects.

Throws:

DirectoryModuleException - default module exception.

getParents

public Collection<? extends IGroup> getParents(IGroup group)

Description copied from interface: IDirectoryModule

Retrieves the direct parents of a specified group object.

Specified by:

getParents in interface IBaseDirectoryModule

Specified by:

getParents in interface IDirectoryModule

Parameters:

group - The group to search for.

Returns:

A java.util.Collection of IGroup objects.

getParents

public Collection<? extends IGroup> getParents(IUser user)

Description copied from interface: IDirectoryModule

Retrieves the parents of a specified user.

Specified by:

getParents in interface IBaseDirectoryModule

Specified by:

getParents in interface IDirectoryModule

Parameters:

user - The user to search for.

Returns:

A java.util.Collection of IGroup objects.

getSearchController

public ISearchController getSearchController()
                                      throws DirectoryModuleException

Specified by:

getSearchController in interface IBaseDirectoryModule

Specified by:

getSearchController in interface IDirectoryModule

Throws:

DirectoryModuleException

getSearchController

public ISearchController getSearchController(IDataSourceReference reference)
                                      throws DirectoryModuleException

Description copied from interface: IDirectoryModule

Gets a search controller object by specifying a IDataSourceReference object.

Specified by:

getSearchController in interface IBaseDirectoryModule

Specified by:

getSearchController in interface IDirectoryModule

Parameters:

reference - The IDataSourceReference object.

Returns:

A ISearchController object.

Throws:

DirectoryModuleException - Default module exception.

getSearchController

public ISearchController getSearchController(IJdbcReference reference)
                                      throws DirectoryModuleException

Description copied from interface: IDirectoryModule

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

Specified by:

getSearchController in interface IBaseDirectoryModule

Specified by:

getSearchController in interface IDirectoryModule

Parameters:

reference - The IJdbcReference object.

Returns:

The ISearchController object.

Throws:

DirectoryModuleException - default module exception.

getSearchController

public ISearchController getSearchController(IConnectionDefinition connectionDefinition)
                                      throws DirectoryModuleException

Description copied from interface: IDirectoryModule

Gets a search controller object by specifying a IConnectionDefinition object.

Specified by:

getSearchController in interface IBaseDirectoryModule

Specified by:

getSearchController in interface IDirectoryModule

Parameters:

connectionDefinition - The IConnectionDefinition object.

Returns:

A ISearchController object.

Throws:

DirectoryModuleException - Default module exception.

getUser

@Deprecated
public IUser getUser(Object object)
              throws DirectoryModuleException

Deprecated.

Description copied from interface: IDirectoryModule

Retrieves a user from an object.

Specified by:

getUser in interface IBaseDirectoryModule

Specified by:

getUser in interface IDirectoryModule

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.

getUsers

public Collection<? extends IUser> getUsers(IContext context)

Description copied from interface: IDirectoryModule

Retrieves all the users.

Specified by:

getUsers in interface IBaseDirectoryModule

Specified by:

getUsers in interface IDirectoryModule

Parameters:

context - The execution context.

Returns:

A java.util.Collection of IUser objects.

getUsers

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

Description copied from interface: IDirectoryModule

Retrieves all the users of a specified organization.

Specified by:

getUsers in interface IBaseDirectoryModule

Specified by:

getUsers in interface IDirectoryModule

Parameters:

context - The execution context.

organization - The IOrganization object.

Returns:

A java.util.Collection of IUser objects.

getUsers

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

Description copied from interface: IDirectoryModule

Retrieves all the users of a specified localization.

Specified by:

getUsers in interface IBaseDirectoryModule

Specified by:

getUsers in interface IDirectoryModule

Parameters:

context - The execution context.

localization - The ILocalization object.

Returns:

A java.util.Collection of IUser objects.

isChildOf

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

Description copied from interface: IDirectoryModule

Checks if the group is child of another group.

Specified by:

isChildOf in interface IBaseDirectoryModule

Specified by:

isChildOf in interface IDirectoryModule

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.

isMemberOf

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

Description copied from interface: IDirectoryModule

Checks if a user is member of a group.

Specified by:

isMemberOf in interface IBaseDirectoryModule

Specified by:

isMemberOf in interface IDirectoryModule

Parameters:

user - The user

group - The group

recursive - if true checks recursively.

Returns:

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

removeChild

public void removeChild(IGroup child,
 IGroup group)
                 throws DirectoryModuleException

Description copied from interface: IDirectoryModule

Removes a child group object.

Specified by:

removeChild in interface IBaseDirectoryModule

Specified by:

removeChild in interface IDirectoryModule

Parameters:

child - The child group.

group - The parent group.

Throws:

DirectoryModuleException - default module exception.

removeMember

public void removeMember(IUser user,
 IGroup group)
                  throws DirectoryModuleException

Description copied from interface: IDirectoryModule

Removes a user from a group.

Specified by:

removeMember in interface IBaseDirectoryModule

Specified by:

removeMember in interface IDirectoryModule

Parameters:

user - The user object to add.

group - The parent group.

Throws:

DirectoryModuleException - default module exception.

getGroup

public IGroup getGroup(IStorageKey key)
                throws DirectoryModuleException

Description copied from interface: IDirectoryModule

Retrieves a group object by its IStorageKey object.

Specified by:

getGroup in interface IBaseDirectoryModule

Specified by:

getGroup in interface IDirectoryModule

Parameters:

key - The IStorageKey object.

Returns:

A IGroup object.

Throws:

DirectoryModuleException - default module exception.

getLocalization

public ILocalization getLocalization(IStorageKey key)
                              throws DirectoryModuleException

Description copied from interface: IDirectoryModule

Retrieves a localization object by its IStorageKey object.

Specified by:

getLocalization in interface IBaseDirectoryModule

Specified by:

getLocalization in interface IDirectoryModule

Parameters:

key - The IStorageKey object.

Returns:

A ILocalization object.

Throws:

DirectoryModuleException - default module exception.

getOrganization

public IOrganization getOrganization(IStorageKey key)
                              throws DirectoryModuleException

Description copied from interface: IDirectoryModule

Retrieves an organization by its IStorageKey object.

Specified by:

getOrganization in interface IBaseDirectoryModule

Specified by:

getOrganization in interface IDirectoryModule

Parameters:

key - The storage key object.

Returns:

A IOrganization object.

Throws:

DirectoryModuleException - default module exception.

getSecurityController

public ISecurityController getSecurityController(ISecuritySupport securitySupport)
                                          throws DirectoryModuleException

Description copied from interface: IDirectoryModule

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

Specified by:

getSecurityController in interface IBaseDirectoryModule

Specified by:

getSecurityController in interface IDirectoryModule

Parameters:

securitySupport - Any ISecuritySupport object.

Returns:

A ISecurityController object.

Throws:

DirectoryModuleException - Default module exception.

getResourceDefinition

public IResourceDefinition getResourceDefinition(IContext context,
 String name)
                                          throws DirectoryModuleException

Description copied from interface: IDirectoryModule

Gets an extended attributes table

Specified by:

getResourceDefinition in interface IBaseDirectoryModule

Specified by:

getResourceDefinition in interface IDirectoryModule

Parameters:

context - the execution context

name - of the table

Returns:

A IResourceDefinition table

Throws:

DirectoryModuleException - default module exception.

addLocalizationScope

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

Description copied from interface: IDirectoryModule

Add localizationScope to the localizationScopeSupport object

Specified by:

addLocalizationScope in interface IBaseDirectoryModule

Specified by:

addLocalizationScope in interface IDirectoryModule

Parameters:

localizationScopeSupport - the localizationScopeSupport object

localization - the localization to add

heritable - if true the localizationScope is heritable, otherwise false

getLocalizationScopes

public Collection<? extends IDirectoryLocalizationScope> getLocalizationScopes(ILocalizationScopeSupport localizationScopeSupport)

Description copied from interface: IDirectoryModule

get the localizationScopes for the localizationScopeSupport object

Specified by:

getLocalizationScopes in interface IBaseDirectoryModule

Specified by:

getLocalizationScopes in interface IDirectoryModule

Parameters:

localizationScopeSupport - the localizationScopeSupport

Returns:

a Collection object of IDirectoryLocalizationScope

removeLocalizationScope

public void removeLocalizationScope(ILocalizationScopeSupport localizationScopeSupport,
 IDirectoryLocalizationScope directoryLocalizationScope)

Description copied from interface: IDirectoryModule

remove the localizationScope to the localizationScopeSupport object

Specified by:

removeLocalizationScope in interface IBaseDirectoryModule

Specified by:

removeLocalizationScope in interface IDirectoryModule

Parameters:

localizationScopeSupport - the localizationScopeSupport

directoryLocalizationScope - the directoryLocalizationScope to remove

restoreLocalizationScopeInheritance

public void restoreLocalizationScopeInheritance(ILocalizationScopeSupport localizationScopeSupport)

Description copied from interface: IDirectoryModule

restore the localizationScope inheritance for the localizationScopeSupport object

Specified by:

restoreLocalizationScopeInheritance in interface IBaseDirectoryModule

Specified by:

restoreLocalizationScopeInheritance in interface IDirectoryModule

Parameters:

localizationScopeSupport - the localizationScopeSupport

breakLocalizationScopeInheritance

public void breakLocalizationScopeInheritance(ILocalizationScopeSupport localizationScopeSupport)

Description copied from interface: IDirectoryModule

break the localizationScope inheritance for the localizationScopeSupport object

Specified by:

breakLocalizationScopeInheritance in interface IBaseDirectoryModule

Specified by:

breakLocalizationScopeInheritance in interface IDirectoryModule

Parameters:

localizationScopeSupport - the localizationScopeSupport

isLocalizationScopeInherited

public boolean isLocalizationScopeInherited(ILocalizationScopeSupport localizationScopeSupport)

Description copied from interface: IDirectoryModule

Checks if the localization scope is inherited

Specified by:

isLocalizationScopeInherited in interface IBaseDirectoryModule

Specified by:

isLocalizationScopeInherited in interface IDirectoryModule

Parameters:

localizationScopeSupport - the localizationScopeSupport

Returns:

true if the localization scope is inherited

addOrganizationScope

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

Description copied from interface: IDirectoryModule

Add OrganizationScope to the User object

Specified by:

addOrganizationScope in interface IBaseDirectoryModule

Specified by:

addOrganizationScope in interface IDirectoryModule

Parameters:

user - the user to add the organizationScope

organization - the organization to add

heritable - if true the organizationScope is heritable, otherwise false

getOrganizationScopes

public Collection<? extends IDirectoryOrganizationScope> getOrganizationScopes(IUser user)

Description copied from interface: IDirectoryModule

Gets the OrganizationScope for the User object

Specified by:

getOrganizationScopes in interface IBaseDirectoryModule

Specified by:

getOrganizationScopes in interface IDirectoryModule

Parameters:

user - the user

Returns:

a Collection object of IDirectoryOrganizationScope

removeOrganizationScope

public void removeOrganizationScope(IUser user,
 IDirectoryOrganizationScope directoryOrganizationScope)

Description copied from interface: IDirectoryModule

Removes the directoryOrganizationScope to the user's OrganizationScope

Specified by:

removeOrganizationScope in interface IBaseDirectoryModule

Specified by:

removeOrganizationScope in interface IDirectoryModule

Parameters:

user - the user

directoryOrganizationScope - the directoryOrganizationScope to remove

restoreOrganizationScopeInheritance

public void restoreOrganizationScopeInheritance(IUser user)

Description copied from interface: IDirectoryModule

restore the organizationScope inheritance for the user object

Specified by:

restoreOrganizationScopeInheritance in interface IBaseDirectoryModule

Specified by:

restoreOrganizationScopeInheritance in interface IDirectoryModule

Parameters:

user - the user

breakOrganizationScopeInheritance

public void breakOrganizationScopeInheritance(IUser user)

Description copied from interface: IDirectoryModule

break the organizationScope inheritance for the user object

Specified by:

breakOrganizationScopeInheritance in interface IBaseDirectoryModule

Specified by:

breakOrganizationScopeInheritance in interface IDirectoryModule

Parameters:

user - the user

isOrganizationScopeInherited

public boolean isOrganizationScopeInherited(IUser user)

Description copied from interface: IDirectoryModule

is organizationScope inheritance

Specified by:

isOrganizationScopeInherited in interface IBaseDirectoryModule

Specified by:

isOrganizationScopeInherited in interface IDirectoryModule

Parameters:

user - the user

Returns:

isOrganizationScopeInherited

createSystemProfile

public IProfile createSystemProfile(IContext context,
 String name)
                             throws ModuleException

Description copied from interface: IDirectoryModule

Creates a IProfile.

Specified by:

createSystemProfile in interface IBaseDirectoryModule

Specified by:

createSystemProfile in interface IDirectoryModule

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

public IProfile getSystemProfile(IContext context,
 String name)
                          throws ModuleException

Description copied from interface: IDirectoryModule

Retrieves a system IProfile object by its system name.

Specified by:

getSystemProfile in interface IBaseDirectoryModule

Specified by:

getSystemProfile in interface IDirectoryModule

Parameters:

context - The execution context.

name - The system name of the role.

Returns:

a IProfile object.

Throws:

ModuleException - default module exception.

getSystemProfiles

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

Description copied from interface: IDirectoryModule

Retrieves a collection of system IProfile objects.

Specified by:

getSystemProfiles in interface IBaseDirectoryModule

Specified by:

getSystemProfiles in interface IDirectoryModule

Parameters:

context - The execution context.

Returns:

a collection of system IProfile objects.

Throws:

ModuleException - default module exception.

getCatalog

public ICatalog getCatalog()

Description copied from interface: IDirectoryModule

Gets the extended attributes catalog

Specified by:

getCatalog in interface IBaseDirectoryModule

Specified by:

getCatalog in interface IDirectoryModule

Returns:

ICatalog the extended attributes catalog

generateSystemName

public String generateSystemName(String label)

Description copied from interface: IModule

Generate a valid system name for this module and this label.

Specified by:

generateSystemName in interface IModule

Parameters:

label - label to normalize

Returns:

normalized value