com.nomagic.magicdraw.core.modules

Class ModulesService

java.lang.Object

com.nomagic.magicdraw.core.modules.ModulesService

@OpenApiAll
public class ModulesService
extends java.lang.Object

An utility class to work with modules (attached projects). This class provides set of utility methods to change decomposition state of project - attach, detach, load, unload or changed attachment properties of modules.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ModulesService.ModuleHasOrphanProxiesException
static class	ModulesService.UsedViaReadOnlyAutomaticUsageException Thrown when module(s) can not be removed due to all paths from primary project to it contains a read only automatic usage

Constructor Summary

Constructors

Constructor and Description
ModulesService()

Method Summary

Modifier and Type	Method and Description
static IAttachedProject	attachModule(IProject owner, AbstractProjectAttachmentConfiguration configuration, org.eclipse.core.runtime.IProgressMonitor monitor) Mounts module into current project.
static IAttachedProject	attachModuleOnTask(IProject project, AbstractProjectAttachmentConfiguration configuration) Mounts module into current project.
protected static void	checkPrecondition(Project project, java.util.Collection<Element> roots, IAttachedProject importThis)
static boolean	detachModules(java.util.Collection<ModuleUsage> usages, org.eclipse.core.runtime.IProgressMonitor monitor) Removes all given modules usages.
static boolean	detachModulesAndRemoveUnreachable(java.util.Collection<ModuleUsage> usages, org.eclipse.core.runtime.IProgressMonitor monitor) Removes all given module usages.
static boolean	detachModulesAndRemoveUnreachableOnTask(java.util.Collection<ModuleUsage> usages) Removes all given module usages.
static boolean	detachModulesOnTask(java.util.Collection<ModuleUsage> usages) Removes all given modules usages.
static IAttachedProject	findOrLoadLocalModule(Project project, java.lang.String filePath, boolean allowUI) Attaches local module from given path into a given project.
static IAttachedProject	findOrLoadModule(Project project, ProjectDescriptor moduleLocation, boolean allowUI) Looks for existing module in a given project.
static IAttachedProject	findOrLoadModule(Project project, ProjectDescriptor moduleLocation, org.eclipse.core.runtime.IProgressMonitor monitor, boolean allowUI) Looks for already attached module in a given project.
static IAttachedProject	findOrLoadTeamworkModule(Project project, java.lang.String profileQualifiedName, boolean allowUI) Attaches teamwork (from Teamwork Server) module into a given project.
static com.nomagic.ci.persistence.mounting.IMountPoint	getMountPoint(java.util.Collection<com.nomagic.ci.persistence.mounting.IMountPoint> points, Package element) Find mount point in a given collection which mounts a given package.
static void	importModule(IProject owner, IAttachedProject module, org.eclipse.core.runtime.IProgressMonitor monitor)
static void	importModule(IProject owner, IAttachedProject module, org.eclipse.core.runtime.IProgressMonitor monitor, boolean regenerateElementIDs) Removes module descriptor and makes all its contents as it is local project content.
static void	importModuleOnTask(IProject owner, IAttachedProject module) Removes module descriptor and makes all its contents as it is local project content.
(package private) static void	loadInnerModulesRecursively(IAttachedProject module, org.eclipse.core.runtime.IProgressMonitor monitor) Load inner modules recursively
static boolean	processException(Project prj, java.lang.Exception e, java.lang.String failedOperationMessage)
static void	reMount(IProject owner, IAttachedProject module, java.util.Collection<MountedPackageInfo> mountedPackagesInfo, org.eclipse.core.runtime.IProgressMonitor monitor) Re-mount given module on different mount points.
static void	reMountOnTask(IProject owner, IAttachedProject module, java.util.Collection<MountedPackageInfo> mountedPackagesInfo) Change mount point location
static void	removeModules(java.util.Set<IAttachedProject> selectedModules, IAttachedProjectRemoverCallback removeConfirmation, org.eclipse.core.runtime.IProgressMonitor progress) Removes the selected modules
static void	removeModulesOnTask(java.util.Set<IAttachedProject> selectedModules, IAttachedProjectRemoverCallback removeConfirmation) Removes the selected modules on task
static void	setAutoLoadKind(IProject owner, IAttachedProject module, AutoLoadKind kind, org.eclipse.core.runtime.IProgressMonitor monitor) Set module load kind
static void	setAutoLoadKind(IProject owner, ProjectAttachmentConfiguration configuration, AutoLoadKind kind) Set module load kind
static void	setAutoLoadKind(IProject owner, ProjectAttachmentConfiguration configuration, AutoLoadKind kind, org.eclipse.core.runtime.IProgressMonitor monitor) Set module load kind
static void	setAutoLoadKind(ProjectAttachmentConfiguration configuration, AutoLoadKind autoLoadKind) Set auto load kind for a given configuration.
static void	setAutoLoadKindOnTask(IProject owner, IAttachedProject module, AutoLoadKind kind) Set module load kind
static void	setInternalVersion(IProject project, java.lang.String version) Set internal version for a given project
static void	setReadOnly(java.util.Collection<ModuleUsage> usages, boolean readOnly, org.eclipse.core.runtime.IProgressMonitor monitor) Make module usage readonly
static void	setReadOnlyOnTask(java.util.Collection<ModuleUsage> usages, boolean readOnly) Make module usage readonly
static void	setReShared(IProject project, IProject module, boolean reShared, org.eclipse.core.runtime.IProgressMonitor monitor) Re-share given module in a given project
static void	setReSharedOnTask(IProject project, IProject module, boolean reShared) Reshare given module in a given project
static void	setSharePreferredPath(IProject project, Package pkg, java.lang.String path, org.eclipse.core.runtime.IProgressMonitor monitor) Set preferred path for mounting for given shared package
static void	setSharePreferredPathOnTask(IProject project, Package pkg, java.lang.String path) Set preferred path for mounting for given shared package
static void	setStandardSystemProfile(IProject project, boolean standard) Mark given project as "standard system profile".
static void	setStickyVersion(java.util.Collection<ModuleUsage> usages, IVersionDescriptor version, org.eclipse.core.runtime.IProgressMonitor monitor) Set sticky version for given modules usages.
static void	setStickyVersionOnTask(java.util.Collection<ModuleUsage> usages, IVersionDescriptor version) Set sticky version for given modules usages.
static void	setUsedVersion(IProject owner, IAttachedProject module, java.lang.String version, org.eclipse.core.runtime.IProgressMonitor monitor) Set "used" version for a given module.
static void	setUsedVersionOnTask(IProject owner, IAttachedProject module, java.lang.String version) Set "used" version for a given module
static com.nomagic.ci.persistence.sharing.ISharePoint	share(IProject project, Package pkg, java.lang.String path, org.eclipse.core.runtime.IProgressMonitor monitor) Share given package in a given project
static com.nomagic.ci.persistence.sharing.ISharePoint	shareOnTask(IProject project, Package pkg, java.lang.String path) Share given package in a given project
static void	unShare(IProject project, Package pkg, org.eclipse.core.runtime.IProgressMonitor monitor) Un-share given package from a given project
static void	unShareOnTask(IProject project, Package pkg) Un-share given package from a given project

Methods inherited from class java.lang.Object

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

Constructor Detail

ModulesService

public ModulesService()

Method Detail

attachModule

@CheckForNull
public static IAttachedProject attachModule(@Nonnull
                                                          IProject owner,
                                                          @Nonnull
                                                          AbstractProjectAttachmentConfiguration configuration,
                                                          org.eclipse.core.runtime.IProgressMonitor monitor)
                                                   throws com.nomagic.ci.persistence.PersistenceException

Mounts module into current project. Default mount path is used.

Parameters:

owner - owner to attach module to

configuration - configuration

monitor - progress status

Returns:

module descriptor

Throws:

com.nomagic.ci.persistence.PersistenceException - in case of persistence problems

attachModuleOnTask

public static IAttachedProject attachModuleOnTask(@Nonnull
                                                  IProject project,
                                                  @Nonnull
                                                  AbstractProjectAttachmentConfiguration configuration)

Mounts module into current project. Default mount path is used.

Parameters:

project - project

configuration - configuration

Returns:

module descriptor

reMount

public static void reMount(@Nonnull
                           IProject owner,
                           @Nonnull
                           IAttachedProject module,
                           java.util.Collection<MountedPackageInfo> mountedPackagesInfo,
                           org.eclipse.core.runtime.IProgressMonitor monitor)

Re-mount given module on different mount points.

Parameters:

owner - module owner

module - module to remount

mountedPackagesInfo - new information about mount points

monitor - progress monitor

reMountOnTask

public static void reMountOnTask(@Nonnull
                                 IProject owner,
                                 @Nonnull
                                 IAttachedProject module,
                                 java.util.Collection<MountedPackageInfo> mountedPackagesInfo)

Change mount point location

Parameters:

owner - project

module - module

mountedPackagesInfo - new mounting information

detachModules

public static boolean detachModules(@Nonnull
                                    java.util.Collection<ModuleUsage> usages,
                                    org.eclipse.core.runtime.IProgressMonitor monitor)
                             throws java.lang.Exception

Removes all given modules usages. If module is used more than one time only remove usage, in other case module data will be disposed.

Parameters:

usages - modules to remove

monitor - monitor

Returns:

true if all modules were detached, false if user cancelled operation

Throws:

java.lang.Exception - if detach fails.

detachModulesAndRemoveUnreachable

public static boolean detachModulesAndRemoveUnreachable(@Nonnull
                                                        java.util.Collection<ModuleUsage> usages,
                                                        org.eclipse.core.runtime.IProgressMonitor monitor)
                                                 throws java.lang.Exception

Removes all given module usages. If new modules become manually unreachable during the operation - they will be removed too if possible

Parameters:

usages - the usages to remove

monitor - the progress monitor for the operation

Returns:

true if all modules were detached, false if user cancelled operation

Throws:

java.lang.Exception

detachModulesAndRemoveUnreachableOnTask

public static boolean detachModulesAndRemoveUnreachableOnTask(@Nonnull
                                                              java.util.Collection<ModuleUsage> usages)

Removes all given module usages. If new modules become manually unreachable during the operation - they will be removed too if possible

Parameters:

usages - the usages to remove

Returns:

true if all modules were detached, false if user cancelled operation

detachModulesOnTask

public static boolean detachModulesOnTask(@Nonnull
                                          java.util.Collection<ModuleUsage> usages)

Removes all given modules usages. If module is used more than one time only remove usage, in other case module data will be disposed.

Parameters:

usages - module usages to remove

Returns:

true if all modules were detached, false if user cancelled operation

removeModules

public static void removeModules(java.util.Set<IAttachedProject> selectedModules,
                                 @CheckForNull
                                 IAttachedProjectRemoverCallback removeConfirmation,
                                 @CheckForNull
                                 org.eclipse.core.runtime.IProgressMonitor progress)
                          throws ModulesService.UsedViaReadOnlyAutomaticUsageException,
                                 com.nomagic.ci.persistence.PersistenceException

Removes the selected modules

Parameters:

selectedModules - the modules to remove

removeConfirmation - the confirmation call back that will be used to confirm the remove

progress - the progress monitor for the operation

Throws:

ModulesService.UsedViaReadOnlyAutomaticUsageException

com.nomagic.ci.persistence.PersistenceException

removeModulesOnTask

public static void removeModulesOnTask(java.util.Set<IAttachedProject> selectedModules,
                                       @CheckForNull
                                       IAttachedProjectRemoverCallback removeConfirmation)

Removes the selected modules on task

Parameters:

selectedModules - the modules to remove

removeConfirmation - the confirmation call back that will be used to confirm the remove

importModule

public static void importModule(@Nonnull
                                IProject owner,
                                @Nonnull
                                IAttachedProject module,
                                @CheckForNull
                                org.eclipse.core.runtime.IProgressMonitor monitor)
                         throws java.lang.Exception

Throws:

java.lang.Exception

importModule

public static void importModule(@Nonnull
                                IProject owner,
                                @Nonnull
                                IAttachedProject module,
                                org.eclipse.core.runtime.IProgressMonitor monitor,
                                boolean regenerateElementIDs)
                         throws java.lang.Exception

Removes module descriptor and makes all its contents as it is local project content.

Parameters:

owner - module owner

module - to import

monitor - progress status

regenerateElementIDs - if true module element id will be generated

Throws:

java.lang.Exception - exception is something goes wrong

getMountPoint

@CheckForNull
public static com.nomagic.ci.persistence.mounting.IMountPoint getMountPoint(@Nonnull
                                                                                          java.util.Collection<com.nomagic.ci.persistence.mounting.IMountPoint> points,
                                                                                          @Nonnull
                                                                                          Package element)

Find mount point in a given collection which mounts a given package.

Parameters:

points - mount points

element - package

Returns:

found mount point

checkPrecondition

protected static void checkPrecondition(Project project,
                                        java.util.Collection<Element> roots,
                                        IAttachedProject importThis)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

importModuleOnTask

public static void importModuleOnTask(@Nonnull
                                      IProject owner,
                                      @Nonnull
                                      IAttachedProject module)

Removes module descriptor and makes all its contents as it is local project content.

Parameters:

owner - module owner

module - to import

processException

public static boolean processException(Project prj,
                                       java.lang.Exception e,
                                       java.lang.String failedOperationMessage)

setReadOnly

public static void setReadOnly(@Nonnull
                               java.util.Collection<ModuleUsage> usages,
                               boolean readOnly,
                               org.eclipse.core.runtime.IProgressMonitor monitor)
                        throws com.nomagic.ci.persistence.PersistenceException

Make module usage readonly

Parameters:

usages - module usages

readOnly - readonly flag

monitor - monitor

Throws:

com.nomagic.ci.persistence.PersistenceException - in case of some persistence problem

setReadOnlyOnTask

public static void setReadOnlyOnTask(@Nonnull
                                     java.util.Collection<ModuleUsage> usages,
                                     boolean readOnly)

Make module usage readonly

Parameters:

usages - module usages

readOnly - readonly flag

setAutoLoadKind

public static void setAutoLoadKind(@Nonnull
                                   ProjectAttachmentConfiguration configuration,
                                   AutoLoadKind autoLoadKind)

Set auto load kind for a given configuration.

Parameters:

configuration - configuration to change auto load.

autoLoadKind - auto load kind

setAutoLoadKind

public static void setAutoLoadKind(@Nonnull
                                   IProject owner,
                                   @Nonnull
                                   ProjectAttachmentConfiguration configuration,
                                   AutoLoadKind kind,
                                   org.eclipse.core.runtime.IProgressMonitor monitor)
                            throws com.nomagic.ci.persistence.PersistenceException

Set module load kind

Parameters:

owner - module owner

configuration - attachment configuration

kind - load kind

monitor - monitor

Throws:

com.nomagic.ci.persistence.PersistenceException - in case of some persistence problem

setAutoLoadKind

public static void setAutoLoadKind(@Nonnull
                                   IProject owner,
                                   @Nonnull
                                   ProjectAttachmentConfiguration configuration,
                                   AutoLoadKind kind)

Set module load kind

Parameters:

owner - module owner

configuration - attachment configuration

kind - load kind

setAutoLoadKind

public static void setAutoLoadKind(@Nonnull
                                   IProject owner,
                                   @Nonnull
                                   IAttachedProject module,
                                   AutoLoadKind kind,
                                   org.eclipse.core.runtime.IProgressMonitor monitor)
                            throws com.nomagic.ci.persistence.PersistenceException

Set module load kind

Parameters:

owner - module owner

module - module

kind - load kind

monitor - monitor

Throws:

com.nomagic.ci.persistence.PersistenceException - in case of some persistence problem

setAutoLoadKindOnTask

public static void setAutoLoadKindOnTask(@Nonnull
                                         IProject owner,
                                         @Nonnull
                                         IAttachedProject module,
                                         AutoLoadKind kind)

Set module load kind

Parameters:

owner - module owner

module - module

kind - load kind

setReSharedOnTask

public static void setReSharedOnTask(@Nonnull
                                     IProject project,
                                     @Nonnull
                                     IProject module,
                                     boolean reShared)

Reshare given module in a given project

Parameters:

project - project

module - module

reShared - add or remove re-sharing

setReShared

public static void setReShared(@Nonnull
                               IProject project,
                               @Nonnull
                               IProject module,
                               boolean reShared,
                               org.eclipse.core.runtime.IProgressMonitor monitor)

Re-share given module in a given project

Parameters:

project - project

module - module

reShared - add ore remove re-sharing

monitor - monitor

shareOnTask

public static com.nomagic.ci.persistence.sharing.ISharePoint shareOnTask(@Nonnull
                                                                         IProject project,
                                                                         @Nonnull
                                                                         Package pkg,
                                                                         @Nonnull
                                                                         java.lang.String path)

Share given package in a given project

Parameters:

project - project

pkg - package to share

path - preferred path for mounting

Returns:

share point

share

public static com.nomagic.ci.persistence.sharing.ISharePoint share(@Nonnull
                                                                   IProject project,
                                                                   @Nonnull
                                                                   Package pkg,
                                                                   @Nonnull
                                                                   java.lang.String path,
                                                                   org.eclipse.core.runtime.IProgressMonitor monitor)
                                                            throws com.nomagic.ci.persistence.local.spi.InvalidProjectObjectException,
                                                                   com.nomagic.ci.persistence.LockAcquisitionException

Share given package in a given project

Parameters:

project - project

pkg - package to share

path - preferred path for mounting

monitor - monitor

Returns:

share point

Throws:

com.nomagic.ci.persistence.local.spi.InvalidProjectObjectException

com.nomagic.ci.persistence.LockAcquisitionException - if locking required elements fails during the operation

setSharePreferredPathOnTask

public static void setSharePreferredPathOnTask(@Nonnull
                                               IProject project,
                                               @Nonnull
                                               Package pkg,
                                               @Nonnull
                                               java.lang.String path)

Set preferred path for mounting for given shared package

Parameters:

project - project

pkg - package

path - preferred mounting path

setSharePreferredPath

public static void setSharePreferredPath(@Nonnull
                                         IProject project,
                                         @Nonnull
                                         Package pkg,
                                         @Nonnull
                                         java.lang.String path,
                                         org.eclipse.core.runtime.IProgressMonitor monitor)
                                  throws com.nomagic.ci.persistence.local.spi.InvalidProjectObjectException

Set preferred path for mounting for given shared package

Parameters:

project - project

pkg - package

path - preferred mounting path

monitor - monitor

Throws:

com.nomagic.ci.persistence.local.spi.InvalidProjectObjectException

setStandardSystemProfile

public static void setStandardSystemProfile(@Nonnull
                                            IProject project,
                                            boolean standard)

Mark given project as "standard system profile".

Parameters:

project - project

standard - mark as standard profile

setInternalVersion

public static void setInternalVersion(@Nonnull
                                      IProject project,
                                      java.lang.String version)

Set internal version for a given project

Parameters:

project - project

version - version

setUsedVersionOnTask

public static void setUsedVersionOnTask(@Nonnull
                                        IProject owner,
                                        @Nonnull
                                        IAttachedProject module,
                                        java.lang.String version)

Set "used" version for a given module

Parameters:

owner - module owner

module - module

version - version

setUsedVersion

public static void setUsedVersion(@Nonnull
                                  IProject owner,
                                  @Nonnull
                                  IAttachedProject module,
                                  java.lang.String version,
                                  org.eclipse.core.runtime.IProgressMonitor monitor)
                           throws com.nomagic.ci.persistence.PersistenceException

Set "used" version for a given module.

Parameters:

owner - module owner

module - module

version - version

monitor - monitor

Throws:

com.nomagic.ci.persistence.PersistenceException - if any persistence problem

unShare

public static void unShare(@Nonnull
                           IProject project,
                           @Nonnull
                           Package pkg,
                           org.eclipse.core.runtime.IProgressMonitor monitor)
                    throws com.nomagic.ci.persistence.local.spi.InvalidProjectObjectException,
                           com.nomagic.ci.persistence.LockAcquisitionException

Un-share given package from a given project

Parameters:

project - project

pkg - package to un-share

monitor - monitor

Throws:

com.nomagic.ci.persistence.local.spi.InvalidProjectObjectException

com.nomagic.ci.persistence.LockAcquisitionException - if locking required elements fails during the operation

unShareOnTask

public static void unShareOnTask(@Nonnull
                                 IProject project,
                                 @Nonnull
                                 Package pkg)

Un-share given package from a given project

Parameters:

project - project

pkg - package to un-share

setStickyVersion

public static void setStickyVersion(@Nonnull
                                    java.util.Collection<ModuleUsage> usages,
                                    @CheckForNull
                                    IVersionDescriptor version,
                                    org.eclipse.core.runtime.IProgressMonitor monitor)
                             throws com.nomagic.ci.persistence.PersistenceException

Set sticky version for given modules usages.

Parameters:

usages - usages

version - sticky version(null if no sticky version

monitor - progress monitor

Throws:

com.nomagic.ci.persistence.PersistenceException - in case of some persistence problem

setStickyVersionOnTask

public static void setStickyVersionOnTask(@Nonnull
                                          java.util.Collection<ModuleUsage> usages,
                                          @CheckForNull
                                          IVersionDescriptor version)

Set sticky version for given modules usages.

Parameters:

usages - usages

version - sticky version(null if no sticky version

findOrLoadLocalModule

public static IAttachedProject findOrLoadLocalModule(@Nonnull
                                                     Project project,
                                                     @Nonnull
                                                     java.lang.String filePath,
                                                     boolean allowUI)

Attaches local module from given path into a given project. Does nothing if such module is already attached.

Parameters:

project - project

filePath - full path to module file

allowUI - allow to show error messages to user

Returns:

attached module

findOrLoadTeamworkModule

@CheckForNull
public static IAttachedProject findOrLoadTeamworkModule(@Nonnull
                                                                      Project project,
                                                                      @Nonnull
                                                                      java.lang.String profileQualifiedName,
                                                                      boolean allowUI)

Attaches teamwork (from Teamwork Server) module into a given project.

Parameters:

project - current project in which action is performed.

profileQualifiedName - qualified name

allowUI - allow to show error messages to user

Returns:

attached module

findOrLoadModule

public static IAttachedProject findOrLoadModule(@Nonnull
                                                Project project,
                                                @Nonnull
                                                ProjectDescriptor moduleLocation,
                                                boolean allowUI)

Looks for existing module in a given project. If found, attaches it directly in project. If module is not found, attaches and loads it.

Parameters:

project - project where module is searched of loaded.

moduleLocation - module descriptor to load.

allowUI - allow to show error messages to user

Returns:

found or loaded module. Null if failure.

findOrLoadModule

@CheckForNull
public static IAttachedProject findOrLoadModule(@Nonnull
                                                              Project project,
                                                              @Nonnull
                                                              ProjectDescriptor moduleLocation,
                                                              @CheckForNull
                                                              org.eclipse.core.runtime.IProgressMonitor monitor,
                                                              boolean allowUI)

Looks for already attached module in a given project. or attaches a new one. If such module is already attached not directly, attaches it directly in a given project. Activates given project if it is not active yet. If module is not found, attaches and loads it.

Parameters:

project - project where module is searched of loaded.

moduleLocation - module descriptor to load.

monitor - monitor where display status, if null new progress bar is shown.

allowUI - allow to show error messages to user

Returns:

found or newly attached module. Null if failure.

loadInnerModulesRecursively

static void loadInnerModulesRecursively(@Nonnull
                                        IAttachedProject module,
                                        org.eclipse.core.runtime.IProgressMonitor monitor)
                                 throws com.nomagic.ci.persistence.PersistenceException

Load inner modules recursively

Parameters:

module - module

monitor - monitor

Throws:

com.nomagic.ci.persistence.PersistenceException - in case of some persistence problem