Projects (Semantic Turkey CORE Services 0.12 API)

java.lang.Object
- it.uniroma2.art.semanticturkey.services.STServiceAdapter
- - it.uniroma2.art.semanticturkey.services.core.Projects

All Implemented Interfaces:

STService
```
@Validated
@Component
@Controller
public class Projects
extends STServiceAdapter
```
Author:

Manuel Fiorelli <fiorelli@info.uniroma2.it>, Armando Stellato <stellato@info.uniroma2.it>, Andrea Turbati <turbati@info.uniroma2.it>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Projects.XMLNames

Nested Classes
Modifier and Type	Class and Description
`static class`	`Projects.XMLNames`

Field Summary

Fields
Modifier and Type Field and Description

protected static org.slf4j.Logger logger
- Fields inherited from class it.uniroma2.art.semanticturkey.services.STServiceAdapter
  servletUtilities

Fields
Modifier and Type	Field and Description
`protected static org.slf4j.Logger`	`logger`

Constructor Summary

Constructors
Constructor and Description

Projects()

Constructors
Constructor and Description
`Projects()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`accessProject(ProjectConsumer consumer, String projectName, ProjectACL.AccessLevel requestedAccessLevel, ProjectACL.LockLevel requestedLockLevel)` see `ProjectManager.accessProject(ProjectConsumer, String, it.uniroma2.art.semanticturkey.project.ProjectACL.AccessLevel, it.uniroma2.art.semanticturkey.project.ProjectACL.LockLevel)`
`void`	`cloneProject(String projectName, String newProjectName)` saves project `projectName` to `newProject`
`Response`	`createProject(ProjectConsumer consumer, String projectName, Class<? extends RDFModel> modelType, String baseURI, String ontManagerFactoryID, String modelConfigurationClass, Properties modelConfiguration, String uriGeneratorFactoryID, String uriGenConfigurationClass, Properties uriGenConfiguration, String renderingEngineFactoryID, String renderingEngineConfigurationClass, Properties renderingEngineConfiguration)`
`void`	`deleteProject(ProjectConsumer consumer, String projectName)`
`void`	`disconnectFromProject(ProjectConsumer consumer, String projectName)` see `ProjectManager.disconnectFromProject(ProjectConsumer, String)`
`void`	`exportProject(javax.servlet.http.HttpServletResponse oRes, String projectName)`
`Response`	`getAccessStatusMap()`
`Response`	`getProjectProperty(String projectName, String[] propertyNames)` this service returns values associated to properties of a given project returns a response with elements called `#propertyTag` with attributes `#propNameAttr` for property name and
`Response`	`getProjectPropertyFileContent(String projectName)` this service returns a list name-value for all the property of a given project.
`Response`	`getProjectPropertyMap(String projectName)` this service returns a list name-value for all the property of a given project.
`void`	`importProject(org.springframework.web.multipart.MultipartFile importPackage, String newProjectName)`
`Response`	`listProjects(ProjectConsumer consumer, ProjectACL.AccessLevel requestedAccessLevel, ProjectACL.LockLevel requestedLockLevel)`
`void`	`repairProject(String projectName)`
`void`	`saveProject(String project)` saves state of currently loaded project `projectName`
`void`	`saveProjectPropertyFileContent(String projectName, String content)`
`void`	`setProjectProperty(String projectName, String propName, String propValue)` This service sets the value of a property of the current project.
`void`	`updateAccessLevel(String projectName, String consumerName, ProjectACL.AccessLevel accessLevel)` Updates the access level granted by the project with the given `projectName` to the given consumer
`void`	`updateLockLevel(String projectName, ProjectACL.LockLevel lockLevel)` Updates the lock level of the project with the given `projectName`

Methods inherited from class it.uniroma2.art.semanticturkey.services.STServiceAdapter
createBooleanResponse, createReplyFAIL, createReplyResponse, getMetadataGraph, getOWLModel, getProject, getUserNamedGraphs, getWorkingGraph, logAndSendException, logAndSendException, logAndSendException, logAndSendException, logAndSendException, logAndSendException, logAndSendException, retrieveExistingURIResource

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

logger

protected static org.slf4j.Logger logger

Constructor Detail
- Projects
```
public Projects()
```

Method Detail

createProject

public Response createProject(ProjectConsumer consumer,
                     String projectName,
                     Class<? extends RDFModel> modelType,
                     String baseURI,
                     String ontManagerFactoryID,
                     String modelConfigurationClass,
                     Properties modelConfiguration,
                     String uriGeneratorFactoryID,
                     String uriGenConfigurationClass,
                     Properties uriGenConfiguration,
                     String renderingEngineFactoryID,
                     String renderingEngineConfigurationClass,
                     Properties renderingEngineConfiguration)
                       throws DuplicatedResourceException,
                              InvalidProjectNameException,
                              ProjectCreationException,
                              ProjectInconsistentException,
                              ProjectUpdateException

Throws:: DuplicatedResourceException; InvalidProjectNameException; ProjectCreationException; ProjectInconsistentException; ProjectUpdateException

deleteProject

public void deleteProject(ProjectConsumer consumer,
                 String projectName)
                   throws ProjectDeletionException

Throws:: ProjectDeletionException

accessProject

public void accessProject(ProjectConsumer consumer,
                 String projectName,
                 ProjectACL.AccessLevel requestedAccessLevel,
                 ProjectACL.LockLevel requestedLockLevel)
                   throws InvalidProjectNameException,
                          ProjectInexistentException,
                          ProjectAccessException,
                          ForbiddenProjectAccessException

see

ProjectManager.accessProject(ProjectConsumer, String, it.uniroma2.art.semanticturkey.project.ProjectACL.AccessLevel, it.uniroma2.art.semanticturkey.project.ProjectACL.LockLevel)

Parameters:: consumer -; projectName -; requestedAccessLevel -; requestedLockLevel -
Throws:: ForbiddenProjectAccessException; ProjectAccessException; ProjectInexistentException; InvalidProjectNameException

disconnectFromProject

public void disconnectFromProject(ProjectConsumer consumer,
                         String projectName)
                           throws ModelUpdateException

see ProjectManager.disconnectFromProject(ProjectConsumer, String)

Parameters:: consumer -; projectName -
Throws:: ModelUpdateException

listProjects

public Response listProjects(ProjectConsumer consumer,
                    ProjectACL.AccessLevel requestedAccessLevel,
                    ProjectACL.LockLevel requestedLockLevel)
                      throws ProjectAccessException

Throws:: ProjectAccessException

repairProject

public void repairProject(String projectName)
                   throws IOException,
                          InvalidProjectNameException,
                          ProjectInexistentException,
                          ProjectInconsistentException

Throws:: IOException; InvalidProjectNameException; ProjectInexistentException; ProjectInconsistentException

saveProject

public void saveProject(String project)
                 throws IllegalAccessException,
                        ProjectUpdateException

saves state of currently loaded project projectName

Parameters:: project -
Throws:: IllegalAccessException; ProjectUpdateException

cloneProject

public void cloneProject(String projectName,
                String newProjectName)
                  throws InvalidProjectNameException,
                         DuplicatedResourceException,
                         IOException,
                         UnavailableResourceException,
                         ProjectInexistentException

saves project projectName to newProject

Parameters:: projectName -
Throws:: ProjectInexistentException; UnavailableResourceException; IOException; DuplicatedResourceException; InvalidProjectNameException

exportProject

@RequestMapping(value="it.uniroma2.art.semanticturkey/st-core-services/Projects/exportProject",
                method=GET)
public void exportProject(javax.servlet.http.HttpServletResponse oRes,
                                @RequestParam(value="projectName")
                                String projectName)
                   throws IOException,
                          ModelAccessException,
                          UnsupportedRDFFormatException,
                          UnavailableResourceException

Throws:: IOException; ModelAccessException; UnsupportedRDFFormatException; UnavailableResourceException

importProject

public void importProject(org.springframework.web.multipart.MultipartFile importPackage,
                 String newProjectName)
                   throws IOException,
                          ModelAccessException,
                          UnsupportedRDFFormatException,
                          ProjectCreationException,
                          DuplicatedResourceException,
                          ProjectInconsistentException,
                          ProjectUpdateException,
                          ModelUpdateException,
                          InvalidProjectNameException

Parameters:: projectName -
Throws:: InvalidProjectNameException; ModelUpdateException; ProjectUpdateException; ProjectInconsistentException; DuplicatedResourceException; ProjectCreationException; UnsupportedRDFFormatException; ModelAccessException; IOException

getProjectProperty

public Response getProjectProperty(String projectName,
                          String[] propertyNames)
                            throws InvalidProjectNameException,
                                   ProjectInexistentException,
                                   ProjectAccessException,
                                   IOException

this service returns values associated to properties of a given project returns a response with elements called #propertyTag with attributes #propNameAttr for property name and

Parameters:: projectName - (optional)the project queried for properties; propNameList - a ";" separated list of property names
Returns:
Throws:: InvalidProjectNameException; ProjectInexistentException; ProjectAccessException; IOException

getProjectPropertyMap

public Response getProjectPropertyMap(String projectName)
                               throws InvalidProjectNameException,
                                      ProjectInexistentException,
                                      ProjectAccessException,
                                      IOException

this service returns a list name-value for all the property of a given project. Returns a response with elements called #propertyTag with attributes #propNameAttr for property name and

Parameters:: projectName - (optional)the project queried for properties; propNameList - a ";" separated list of property names
Returns:
Throws:: InvalidProjectNameException; ProjectInexistentException; ProjectAccessException; IOException

getProjectPropertyFileContent

public Response getProjectPropertyFileContent(String projectName)
                                       throws InvalidProjectNameException,
                                              ProjectInexistentException,
                                              ProjectAccessException,
                                              IOException

this service returns a list name-value for all the property of a given project. Returns a response with elements called #propertyTag with attributes #propNameAttr for property name and

Parameters:: projectName - (optional)the project queried for properties; propNameList - a ";" separated list of property names
Returns:
Throws:: InvalidProjectNameException; ProjectInexistentException; ProjectAccessException; IOException

saveProjectPropertyFileContent

public void saveProjectPropertyFileContent(String projectName,
                                  String content)
                                    throws InvalidProjectNameException,
                                           ProjectInexistentException,
                                           ProjectAccessException,
                                           IOException

Throws:: InvalidProjectNameException; ProjectInexistentException; ProjectAccessException; IOException

setProjectProperty

public void setProjectProperty(String projectName,
                      String propName,
                      String propValue)
                        throws InvalidProjectNameException,
                               ProjectInexistentException,
                               ProjectAccessException,
                               ProjectUpdateException,
                               ReservedPropertyUpdateException

This service sets the value of a property of the current project.

Parameters:: propName -; propValue -
Throws:: ProjectAccessException; ProjectInexistentException; InvalidProjectNameException; ReservedPropertyUpdateException; ProjectUpdateException

getAccessStatusMap

public Response getAccessStatusMap()
                            throws InvalidProjectNameException,
                                   ProjectInexistentException,
                                   ProjectAccessException,
                                   ForbiddenProjectAccessException

Throws:: InvalidProjectNameException; ProjectInexistentException; ProjectAccessException; ForbiddenProjectAccessException

updateAccessLevel

public void updateAccessLevel(String projectName,
                     String consumerName,
                     ProjectACL.AccessLevel accessLevel)
                       throws InvalidProjectNameException,
                              ProjectInexistentException,
                              ProjectAccessException,
                              ProjectUpdateException,
                              ReservedPropertyUpdateException

Updates the access level granted by the project with the given projectName to the given consumer

Parameters:: projectName -; consumer -; accessLevel -
Throws:: InvalidProjectNameException; ProjectInexistentException; ProjectAccessException; ProjectUpdateException; ReservedPropertyUpdateException

updateLockLevel

public void updateLockLevel(String projectName,
                   ProjectACL.LockLevel lockLevel)
                     throws InvalidProjectNameException,
                            ProjectInexistentException,
                            ProjectAccessException,
                            ProjectUpdateException,
                            ReservedPropertyUpdateException

Updates the lock level of the project with the given projectName

Parameters:: projectName -; lockLevel -
Throws:: InvalidProjectNameException; ProjectInexistentException; ProjectAccessException; ProjectUpdateException; ReservedPropertyUpdateException

Class Projects

Nested Class Summary

Field Summary

Fields inherited from class it.uniroma2.art.semanticturkey.services.STServiceAdapter

Constructor Summary