kieker.webgui.service
Interface IProjectService

All Known Implementing Classes:
ProjectServiceImpl

public interface IProjectService

This is the interface for a component which is responsible for managing all projects. This means that this interface can be used to create, copy, delete projects as well as to start and stop the corresponding analyses and similar things. The facade should abstract from details like the (memory) locations and from synchronization. Latter should be guaranteed by the facade, which means that multiple requests for the same project do not go wrong.

Author:
Nils Christian Ehmke

Method Summary
 void addProject(String projectName, String username)
          This method adds a new project to the application.
 void cleanAnalysis(String projectName)
          This method cleans the analysis of the given project.
 void copyProject(String originalProjectName, String newProjectName)
          This method makes a copy of a project and saves it under another name.
 boolean deleteLibrary(String projectName, String libName)
          Deletes the given library of the given project.
 void deleteProject(String projectName)
          This method removes the given project from the application.
 void emergencyShutdownOfAnalysis(String projectName)
          Initializes an emergency shutdown.
 String getAnalysisLayout(String projectName)
          Delivers the stored analysis layout for the given project.
 ComponentListContainer getAvailableComponents(String project)
          Delivers the available components (readers, filters and repositories) for the given project.
 ClassLoader getClassLoader(String projectName, Object requester)
          This method delivers a class loader containing the currently available libraries of the given project.
 String getCockpitLayout(String projectName)
          Delivers the stored cockpit layout for the given project.
 kieker.analysis.AnalysisController.STATE getCurrentState(String projectName)
          This method delivers the current state of the given project.
 long getCurrTimeStamp(String projectName)
          Delivers the current time stamp of the given project.
 Object getDisplay(String projectName, String viewName, String displayName)
          This method delivers the display object of the (currently running) analysis for the given project and the given parameters.
 DisplayType getDisplayType(String projectName, String viewName, String displayConnectorName)
          Delivers the type of the given display connector.
 String getLastUser(String projectName)
          Delivers the last user of the given project or a substituion if the meta data is corrupt or missing.
 Object[] getLogEntries(String projectName)
          This method delivers the available log entries of the analysis controller of the given project.
 String getOwner(String projectName)
          Delivers the owner of the given project or a substituion if the meta data is corrupt or missing.
 List<String> getProjects()
          Delivers a list of the currently available projects.
 void importProject(String projectName, String username, org.primefaces.model.UploadedFile file)
          This method imports an existing kax-file into the application.
 void initializeAnalysis(String projectName)
          This method initializes the analysis of the given project.
 List<String> listAllLibraries(String projectName)
          This method lists all available libraries of the given project.
 kieker.analysis.model.analysisMetaModel.MIProject loadProject(String projectName)
          This method loads the kax-file for the given project name and delivers an initializes instance of MIProject.
 void reloadDisplays(String projectName)
          Reloads the displays of the given project.
 void renameProject(String originalProjectName, String newProjectName)
          This method renames the given project.
 void saveProject(String projectName, kieker.analysis.model.analysisMetaModel.MIProject project, long timeStamp, boolean overwriteNewerProject, String username, String analysisLayout, String cockpitLayout)
          This method tries to save the given model instance for the given project.
 void startAnalysis(String projectName)
          This method starts the analysis of the given project.
 void stopAnalysis(String projectName)
          This method stops the analysis of the given project.
 void uploadLibrary(org.primefaces.model.UploadedFile file, String projectName)
          This method tries to upload a dependency to the given project.
 

Method Detail

addProject

@PreAuthorize(value="hasAnyRole(\'User\', \'Administrator\')")
void addProject(String projectName,
                             String username)
                throws ProjectAlreadyExistingException,
                       IOException
This method adds a new project to the application. It creates an empty, but nevertheless valid kax-file to the file system. If the method fails due to an IOException, it will make sure that the project-directories will be removed as if the method would never have been called.

Parameters:
projectName - The name of the new project.
username - The name of the user who created the project.
Throws:
ProjectAlreadyExistingException - If a project with the same name exists already.
IOException - If something went wrong during the creation of the project.

deleteProject

@PreAuthorize(value="hasAnyRole(\'User\', \'Administrator\')")
void deleteProject(String projectName)
                   throws ProjectNotExistingException,
                          IOException,
                          ProjectStillRunningException
This method removes the given project from the application. This is done by simply removing the whole project directory. It is possible that this action fails for various reasons - in this cases it is not guaranteed that the project is still in a valid state.

Parameters:
projectName - The name of the project.
Throws:
ProjectNotExistingException - If a project with the given name doesn't exist.
IOException - If something went wrong during the removing.
ProjectStillRunningException - If the project is still running.

reloadDisplays

@PreAuthorize(value="hasAnyRole(\'User\', \'Administrator\')")
void reloadDisplays(String projectName)
                    throws AnalysisDisplayReloadException,
                           InvalidAnalysisStateException
Reloads the displays of the given project.

Parameters:
projectName - The name of the project.
Throws:
AnalysisDisplayReloadException - If something went wrong while reloading the displays.
InvalidAnalysisStateException - If the analysis is in an invalid state for the operation.

importProject

@PreAuthorize(value="hasAnyRole(\'User\', \'Administrator\')")
void importProject(String projectName,
                                String username,
                                org.primefaces.model.UploadedFile file)
                   throws ProjectAlreadyExistingException,
                          IOException
This method imports an existing kax-file into the application. If the given project name does already exist, the application will not try to upload it in the first place.

Parameters:
projectName - The name of the new project.
username - The name of the user who imported the project.
file - The kax file to be uploaded.
Throws:
ProjectAlreadyExistingException - If a project with the same name exists already.
IOException - If something went wrong during the creation of the project or the uploading of the file.

copyProject

@PreAuthorize(value="hasAnyRole(\'User\', \'Administrator\')")
void copyProject(String originalProjectName,
                              String newProjectName)
                 throws ProjectNotExistingException,
                        ProjectAlreadyExistingException,
                        IOException
This method makes a copy of a project and saves it under another name. If the method fails due to an IOException, it will make sure that the project-directories of the destination-project will be removed as if the method would never have been called.

Parameters:
originalProjectName - The name of the source project.
newProjectName - The name of the target project.
Throws:
ProjectNotExistingException - If a project with the given (source) name doesn't exist.
ProjectAlreadyExistingException - If a project with the same (target) name exists already.
IOException - If something went wrong during the creation of the target-project or during the loading of the source-project.

renameProject

@PreAuthorize(value="hasAnyRole(\'User\', \'Administrator\')")
void renameProject(String originalProjectName,
                                String newProjectName)
                   throws ProjectNotExistingException,
                          ProjectAlreadyExistingException,
                          IOException
This method renames the given project.

Parameters:
originalProjectName - The old project name.
newProjectName - The new project name.
Throws:
ProjectNotExistingException - If a project with the given (source) name doesn't exist.
ProjectAlreadyExistingException - If a project with the same (target) name exists already.
IOException - If something went wrong during the creation of the target-project or during the loading of the source-project.

loadProject

@PreAuthorize(value="isAuthenticated()")
kieker.analysis.model.analysisMetaModel.MIProject loadProject(String projectName)
                                                              throws ProjectNotExistingException,
                                                                     IOException
This method loads the kax-file for the given project name and delivers an initializes instance of MIProject.

Parameters:
projectName - The name of the project to be loaded.
Returns:
The model instance as defined by the corresponding kax-file.
Throws:
ProjectNotExistingException - If a project with the given (source) name doesn't exist.
IOException - If something went wrong during the opening of the project.

saveProject

@PreAuthorize(value="hasAnyRole(\'User\', \'Administrator\')")
void saveProject(String projectName,
                              kieker.analysis.model.analysisMetaModel.MIProject project,
                              long timeStamp,
                              boolean overwriteNewerProject,
                              String username,
                              String analysisLayout,
                              String cockpitLayout)
                 throws ProjectNotExistingException,
                        IOException,
                        NewerProjectException
This method tries to save the given model instance for the given project. The given time stamp will be compared (if the corresponding flag says so) with the current time stamp of the project. If the project on the file system has been modified in the meantime, a NewerProjectException will be thrown. If something goes wrong during the storage, it is not guaranteed that the resulting file will be valid.

Parameters:
projectName - The name of the project which has to be saved.
project - The model instance to be stored in the corresponding kax-file.
timeStamp - The time stamp which has to be compared with the "real" time stamp of the project.
overwriteNewerProject - Determines whether a newer project file will be overwritten without further warning or not.
username - The name of the user who saves the project.
analysisLayout - The current layout of the analysis graph. It is valid if this parameter is null. In this case the stored layout will not be changed.
cockpitLayout - The current layout of the cockpit. It is valid if this parameter is null. In this case the stored layout will not be changed.
Throws:
ProjectNotExistingException - If a project with the given name does not exist.
IOException - If something went wrong during the storage of the model instance.
NewerProjectException - If the project on the file system is newer and the overwriteNewerProject-flag has not been set.

getCurrTimeStamp

@PreAuthorize(value="isAuthenticated()")
long getCurrTimeStamp(String projectName)
                      throws ProjectNotExistingException
Delivers the current time stamp of the given project.

Parameters:
projectName - The name of the project whose time stamp will be delivered.
Returns:
The current time stamp.
Throws:
ProjectNotExistingException - If a project with the given name does not exist.

getOwner

@PreAuthorize(value="isAuthenticated()")
String getOwner(String projectName)
                throws ProjectNotExistingException
Delivers the owner of the given project or a substituion if the meta data is corrupt or missing.

Parameters:
projectName - The name of the project whose owner should be delivered.
Returns:
The owner (creator) of the project.
Throws:
ProjectNotExistingException - If a project with the given name does not exist.

getLastUser

@PreAuthorize(value="isAuthenticated()")
String getLastUser(String projectName)
                   throws ProjectNotExistingException
Delivers the last user of the given project or a substituion if the meta data is corrupt or missing.

Parameters:
projectName - The name of the project whose last user should be delivered.
Returns:
The last user of the project.
Throws:
ProjectNotExistingException - If a project with the given name does not exist.

uploadLibrary

@PreAuthorize(value="hasAnyRole(\'User\', \'Administrator\')")
void uploadLibrary(org.primefaces.model.UploadedFile file,
                                String projectName)
                   throws ProjectNotExistingException,
                          IOException
This method tries to upload a dependency to the given project. An existing version of the library will be overwritten.

Parameters:
file - The file to be uploaded to the project.
projectName - The name of the project.
Throws:
ProjectNotExistingException - If a project with the given name does not exist.
IOException - If something went wrong during the uploading.

getClassLoader

@PreAuthorize(value="isAuthenticated()")
ClassLoader getClassLoader(String projectName,
                                        Object requester)
                           throws ProjectNotExistingException,
                                  IOException
This method delivers a class loader containing the currently available libraries of the given project.

Parameters:
projectName - The name of the project.
requester - The requester of the class loader.
Returns:
A class loader for the given project.
Throws:
ProjectNotExistingException - If a project with the given name does not exist.
IOException - If something went wrong during the initialization of the class loader.

listAllLibraries

@PreAuthorize(value="isAuthenticated()")
List<String> listAllLibraries(String projectName)
                              throws ProjectNotExistingException
This method lists all available libraries of the given project.

Parameters:
projectName - The name of the project whose libraries have to be delivered.
Returns:
A list containing all available library-names of the project.
Throws:
ProjectNotExistingException - If a project with the given name does not exist.

getAvailableComponents

@PreAuthorize(value="isAuthenticated()")
ComponentListContainer getAvailableComponents(String project)
Delivers the available components (readers, filters and repositories) for the given project.

Parameters:
project - The project whose components should be loaded.
Returns:
An object containing the available components as model instances.

initializeAnalysis

@PreAuthorize(value="hasAnyRole(\'User\', \'Administrator\')")
void initializeAnalysis(String projectName)
                        throws ProjectNotExistingException,
                               InvalidAnalysisStateException,
                               AnalysisInitializationException,
                               IOException
This method initializes the analysis of the given project.

Parameters:
projectName - The name of the project whose analysis should be initialized.
Throws:
ProjectNotExistingException - If a project with the given name does not exist.
InvalidAnalysisStateException - If the analysis of the given project is in the wrong state to be initialized. This means that it has not been cleaned yet.
AnalysisInitializationException - If an error occurred during the initialization of the analysis.
IOException - If something went wrong while loading the file.

cleanAnalysis

@PreAuthorize(value="hasAnyRole(\'User\', \'Administrator\')")
void cleanAnalysis(String projectName)
                   throws ProjectNotExistingException,
                          InvalidAnalysisStateException
This method cleans the analysis of the given project.

Parameters:
projectName - The name of the project whose analysis should be cleaned.
Throws:
ProjectNotExistingException - If a project with the given name does not exist.
InvalidAnalysisStateException - If the analysis of the given project is in the wrong state to be cleaned. This means that it has not been terminated yet.

startAnalysis

@PreAuthorize(value="hasAnyRole(\'User\', \'Administrator\')")
void startAnalysis(String projectName)
                   throws ProjectNotExistingException,
                          InvalidAnalysisStateException
This method starts the analysis of the given project.

Parameters:
projectName - The name of the project whose analysis should be started.
Throws:
ProjectNotExistingException - If a project with the given name does not exist.
InvalidAnalysisStateException - If the analysis of the given project is in the wrong state to be started. This means that it has not been initialized yet.

stopAnalysis

@PreAuthorize(value="hasAnyRole(\'User\', \'Administrator\')")
void stopAnalysis(String projectName)
                  throws ProjectNotExistingException,
                         InvalidAnalysisStateException
This method stops the analysis of the given project.

Parameters:
projectName - The name of the project whose analysis should be stopped.
Throws:
ProjectNotExistingException - If a project with the given name does not exist.
InvalidAnalysisStateException - If the analysis of the given project is in the wrong state to be stopped. This means that it has not been started yet or is no longer running.

emergencyShutdownOfAnalysis

@PreAuthorize(value="hasAnyRole(\'User\', \'Administrator\')")
void emergencyShutdownOfAnalysis(String projectName)
                                 throws ProjectNotExistingException,
                                        InvalidAnalysisStateException
Initializes an emergency shutdown.

Parameters:
projectName - The name of the project whose analysis should be stopped.
Throws:
ProjectNotExistingException - If a project with the given name does not exist.
InvalidAnalysisStateException - If the analysis of the given project is in the wrong state to be stopped.

getDisplay

@PreAuthorize(value="isAuthenticated()")
Object getDisplay(String projectName,
                               String viewName,
                               String displayName)
                  throws InvalidAnalysisStateException
This method delivers the display object of the (currently running) analysis for the given project and the given parameters. Technically it is an instance of AbstractDisplay, but in fact the project specific class loader has been used.

Parameters:
projectName - The name of the project.
viewName - The name of the view.
displayName - The name of the display.
Returns:
A display object for the given parameters.
Throws:
InvalidAnalysisStateException - If the analysis of the given project is in the wrong state to deliver the display.

getCurrentState

@PreAuthorize(value="isAuthenticated()")
kieker.analysis.AnalysisController.STATE getCurrentState(String projectName)
This method delivers the current state of the given project.

Parameters:
projectName - The name of the project whose state have to be returned.
Returns:
The state of the given project, if available. null otherwise.

getLogEntries

@PreAuthorize(value="hasAnyRole(\'User\', \'Administrator\')")
Object[] getLogEntries(String projectName)
                       throws InvalidAnalysisStateException
This method delivers the available log entries of the analysis controller of the given project.

Parameters:
projectName - The name of the project.
Returns:
An array containing the entries of the log.
Throws:
InvalidAnalysisStateException - If the analysis is in an invalid state to deliver the entries.

deleteLibrary

@PreAuthorize(value="hasAnyRole(\'User\', \'Administrator\')")
boolean deleteLibrary(String projectName,
                                   String libName)
                      throws IOException,
                             ProjectNotExistingException
Deletes the given library of the given project.

Parameters:
projectName - The name of the project.
libName - The name of the library.
Returns:
true if and only if the given library has been removed.
Throws:
IOException - If something went wrong during the reloading of the components.
ProjectNotExistingException - If a project with the given name does not exist.

getAnalysisLayout

@PreAuthorize(value="isAuthenticated()")
String getAnalysisLayout(String projectName)
Delivers the stored analysis layout for the given project.

Parameters:
projectName - The name of the project.
Returns:
The layout string as it is stored within the meta data. If this isn't available, null will be returned.

getCockpitLayout

@PreAuthorize(value="isAuthenticated()")
String getCockpitLayout(String projectName)
Delivers the stored cockpit layout for the given project.

Parameters:
projectName - The name of the project.
Returns:
The layout string as it is stored within the meta data. If this isn't available, null will be returned.

getDisplayType

@PreAuthorize(value="isAuthenticated()")
DisplayType getDisplayType(String projectName,
                                        String viewName,
                                        String displayConnectorName)
Delivers the type of the given display connector.

Parameters:
projectName - The name of the project.
viewName - The name of the view.
displayConnectorName - The name of the display connector.
Returns:
The type of the display connector.

getProjects

@PreAuthorize(value="isAuthenticated()")
List<String> getProjects()
Delivers a list of the currently available projects. The returned list is a copy.

Returns:
A list containing the available projects.


Copyright © 2015. All rights reserved.