com.whitestein.lsps.modulemanager

Class ModelManagementServiceBean

java.lang.Object

com.whitestein.lsps.common.SecureAndLoggingService

com.whitestein.lsps.modulemanager.ModelManagementServiceBean

All Implemented Interfaces:

ModelManagementServiceLocal, ModelManagementServiceRemote, ModelManagementService

@PermitAll
public class ModelManagementServiceBean
extends com.whitestein.lsps.common.SecureAndLoggingService
implements ModelManagementServiceLocal, ModelManagementServiceRemote

Service for manipulating with models/modules repository. Service method uploadModules(ByteData, StringProperties) allows uploading of modules to the server. All modules from the stream are uploaded. For each main module a model element is created and registered.

Field Summary

Fields inherited from class com.whitestein.lsps.common.SecureAndLoggingService

PRINCIPAL_KEY

Fields inherited from interface com.whitestein.lsps.engine.ejb.ModelManagementServiceLocal

DELETE_MODEL, MANAGE_MODEL, READ_MODEL

Constructor Summary

Constructors

Constructor and Description
ModelManagementServiceBean() Creates new instance.
ModelManagementServiceBean(ModelManagementDao modelManagementDao, SettingDao settingDao, ProcessServiceLocal processService, ModelProviderService modelProviderService, BinaryDataServiceLocal binaryDataService, SharedRecordConfigurationService sharedRecordConfigurationService, javax.ejb.SessionContext sessionContext, boolean compileModules) Constructor

Method Summary

Modifier and Type	Method and Description
ByteData	exportModules(long moduleId) Create archive(ZIP) file of modules identified by the given module id.
ModuleEntryList	findModuleEntriesByType(long moduleId, String type) Returns a list of module entries for the given module and type.
ModuleEntry	findModuleEntryByPath(long moduleId, String path) Returns content of the specified process resource for given module.
ModuleList	findModules(ModuleCriteria criteria) Returns collection of all modules in the repository according to given criteria
ModuleDetailsList	findModulesDetails(ModuleCriteria criteria) Returns collection of details of all modules in the repository according to given criteria
List<Module>	getDependentModules(List<Long> moduleIds) Returns list of modules that imports one of given modules.
long	getExecutableModulesCount()
Module	getLatestModule(String name) Returns the latest module with a given name.
Module	getModule(long moduleId) Finds module according to module id
ModuleEntry	getModuleEntry(long entryId) Returns resource data for given id from repository.
boolean	isConfirmModelUpload() Gets the server hint indicating whether the model upload should be explicitly confirmed by the user.
ModulesProcessingResult	processArchive(ByteData archive, Map<String,String> properties) Process archive represented by byte array.
void	unloadModule(long moduleId) Removes the module from the system.
void	unloadModules(List<Module> modules) Unloads modules.
void	unloadModuleWithDependentModules(long moduleId) Removes the module from the system.
ModulesUploadResult	uploadModules(ByteData archive, StringProperties uploadProperties) Process archive represented by byte array.

Methods inherited from class com.whitestein.lsps.common.SecureAndLoggingService

getCurrentTransactionData, getOriginalPrincipal, getSecurityManagerService

Methods inherited from class java.lang.Object

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

Constructor Detail

ModelManagementServiceBean

public ModelManagementServiceBean()

Creates new instance.

ModelManagementServiceBean

public ModelManagementServiceBean(ModelManagementDao modelManagementDao,
                                  SettingDao settingDao,
                                  ProcessServiceLocal processService,
                                  ModelProviderService modelProviderService,
                                  BinaryDataServiceLocal binaryDataService,
                                  SharedRecordConfigurationService sharedRecordConfigurationService,
                                  javax.ejb.SessionContext sessionContext,
                                  boolean compileModules)

Constructor

Parameters:

modelManagementDao -

settingDao -

processService -

modelProviderService -

binaryDataService -

sessionContext -

sharedRecordConfigurationService -

compileModules -

Method Detail

uploadModules

@RightsAllowed(value="Model:Manage")
public ModulesUploadResult uploadModules(ByteData archive,
                                                                              StringProperties uploadProperties)
                                                                       throws ModelUploadException

Description copied from interface: ModelManagementService

Process archive represented by byte array. Archive is represented as ZIP archive containing modules.

Specified by:

uploadModules in interface ModelManagementService

Parameters:

archive - byte array representation of archive

uploadProperties - the upload properties

Returns:

list of uploaded modules

Throws:

ModelUploadException

processArchive

public ModulesProcessingResult processArchive(ByteData archive,
                                              Map<String,String> properties)
                                       throws ModelUploadException

Description copied from interface: ModelManagementServiceLocal

Process archive represented by byte array. Archive is represented as ZIP archive containing modules.

Specified by:

processArchive in interface ModelManagementServiceLocal

Parameters:

archive - byte array representation of archive

properties - the upload properties

Returns:

processing result. It contains list of all uploaded modules and list of new modules.

Throws:

ModelUploadException

unloadModules

public void unloadModules(List<Module> modules)

Description copied from interface: ModelManagementService

Unloads modules.

Specified by:

unloadModules in interface ModelManagementService

exportModules

@RightsAllowed(value="Model:Manage")
public ByteData exportModules(long moduleId)
                                                            throws ModuleNotFoundException

Description copied from interface: ModelManagementService

Create archive(ZIP) file of modules identified by the given module id.

Specified by:

exportModules in interface ModelManagementService

Returns:

byte array of created archive

Throws:

ModuleNotFoundException

findModuleEntriesByType

@RightsAllowed(value="Model:Read")
public ModuleEntryList findModuleEntriesByType(long moduleId,
                                                                                  String type)
                                                                           throws ModuleNotFoundException

Description copied from interface: ModelManagementService

Returns a list of module entries for the given module and type.

Specified by:

findModuleEntriesByType in interface ModelManagementService

Parameters:

moduleId - id of module

type - type of the file

Returns:

a list of module entries for the given module and type

Throws:

ModuleNotFoundException

findModuleEntryByPath

@RightsAllowed(value="Model:Read")
public ModuleEntry findModuleEntryByPath(long moduleId,
                                                                            String path)
                                                                     throws ModuleNotFoundException

Description copied from interface: ModelManagementService

Returns content of the specified process resource for given module.

Specified by:

findModuleEntryByPath in interface ModelManagementService

Parameters:

moduleId - the module id

path - path to binary content

Returns:

BinaryHandle

Throws:

ModuleNotFoundException

findModules

@RightsAllowed(value="Model:Read")
public ModuleList findModules(ModuleCriteria criteria)

Description copied from interface: ModelManagementService

Returns collection of all modules in the repository according to given criteria

Specified by:

findModules in interface ModelManagementService

Returns:

collection of Modules

getExecutableModulesCount

public long getExecutableModulesCount()

Specified by:

getExecutableModulesCount in interface ModelManagementService

Returns:

a number of executable modules

findModulesDetails

@RightsAllowed(value="Model:Read")
public ModuleDetailsList findModulesDetails(ModuleCriteria criteria)

Description copied from interface: ModelManagementService

Returns collection of details of all modules in the repository according to given criteria

Specified by:

findModulesDetails in interface ModelManagementService

Returns:

collection of ModuleDetails

getModule

@RightsAllowed(value="Model:Read")
public Module getModule(long moduleId)

Description copied from interface: ModelManagementService

Finds module according to module id

Specified by:

getModule in interface ModelManagementService

Parameters:

moduleId - id of model

Returns:

found Module or null if not found

getModuleEntry

@RightsAllowed(value="Model:Read")
public ModuleEntry getModuleEntry(long entryId)

Description copied from interface: ModelManagementService

Returns resource data for given id from repository.

Specified by:

getModuleEntry in interface ModelManagementService

Returns:

module entry

getLatestModule

public Module getLatestModule(String name)

Description copied from interface: ModelManagementService

Returns the latest module with a given name. Unloaded modules are ignored. Imports and entries are not included in the result.

Specified by:

getLatestModule in interface ModelManagementService

Returns:

the latest module or null

unloadModule

@RightsAllowed(value="Model:Delete")
public void unloadModule(long moduleId)
                                                       throws ModuleNotFoundException,
                                                              ModelUnloadException

Description copied from interface: ModelManagementService

Removes the module from the system. The module must not be referenced by any other modules. If there are any running model instances, they are terminated.

Specified by:

unloadModule in interface ModelManagementService

Throws:

ModuleNotFoundException - if the module does not exist

ModelUnloadException

unloadModuleWithDependentModules

@RightsAllowed(value="Model:Delete")
public void unloadModuleWithDependentModules(long moduleId)
                                                                           throws ModuleNotFoundException,
                                                                                  ModelUnloadException

Description copied from interface: ModelManagementService

Removes the module from the system. If there are any other modules which reference it, they will be unloaded too. If there are any running model instances, they are terminated.

Specified by:

unloadModuleWithDependentModules in interface ModelManagementService

Throws:

ModuleNotFoundException - if the module does not exist

ModelUnloadException

getDependentModules

public List<Module> getDependentModules(List<Long> moduleIds)

Description copied from interface: ModelManagementService

Returns list of modules that imports one of given modules.

Specified by:

getDependentModules in interface ModelManagementService

Parameters:

moduleIds - id of modules

Returns:

list of modules that imports one of given modules

isConfirmModelUpload

public boolean isConfirmModelUpload()

Description copied from interface: ModelManagementService

Gets the server hint indicating whether the model upload should be explicitly confirmed by the user.

Specified by:

isConfirmModelUpload in interface ModelManagementService

Returns:

server hint to confirm model upload explicitly by the user