pro.taskana.common.rest.TaskanaEngineController Maven / Gradle / Ivy
The newest version!
package pro.taskana.common.rest;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.media.Content;
import io.swagger.v3.oas.annotations.media.ExampleObject;
import io.swagger.v3.oas.annotations.media.Schema;
import io.swagger.v3.oas.annotations.responses.ApiResponse;
import java.util.List;
import java.util.Map;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.hateoas.MediaTypes;
import org.springframework.hateoas.config.EnableHypermediaSupport;
import org.springframework.http.ResponseEntity;
import org.springframework.transaction.annotation.Transactional;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PutMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import pro.taskana.TaskanaConfiguration;
import pro.taskana.common.api.ConfigurationService;
import pro.taskana.common.api.TaskanaEngine;
import pro.taskana.common.api.security.CurrentUserContext;
import pro.taskana.common.rest.models.CustomAttributesRepresentationModel;
import pro.taskana.common.rest.models.TaskanaUserInfoRepresentationModel;
import pro.taskana.common.rest.models.VersionRepresentationModel;
/** Controller for TaskanaEngine related tasks. */
@RestController
@EnableHypermediaSupport(type = EnableHypermediaSupport.HypermediaType.HAL)
public class TaskanaEngineController {
private final TaskanaConfiguration taskanaConfiguration;
private final TaskanaEngine taskanaEngine;
private final CurrentUserContext currentUserContext;
private final ConfigurationService configurationService;
@Autowired
TaskanaEngineController(
TaskanaConfiguration taskanaConfiguration,
TaskanaEngine taskanaEngine,
CurrentUserContext currentUserContext,
ConfigurationService configurationService) {
this.taskanaConfiguration = taskanaConfiguration;
this.taskanaEngine = taskanaEngine;
this.currentUserContext = currentUserContext;
this.configurationService = configurationService;
}
@Operation(
summary = "This endpoint retrieves all configured Domains.",
responses =
@ApiResponse(
responseCode = "200",
description = "An array with the domain-names as strings",
content =
@Content(
mediaType = MediaTypes.HAL_JSON_VALUE,
schema = @Schema(implementation = String[].class))))
@GetMapping(path = RestEndpoints.URL_DOMAIN)
@Transactional(readOnly = true, rollbackFor = Exception.class)
public ResponseEntity> getDomains() {
return ResponseEntity.ok(taskanaConfiguration.getDomains());
}
@Operation(
summary =
"This endpoint retrieves the configured classification categories for a specific "
+ "classification type.",
parameters =
@Parameter(
name = "type",
description =
"The classification type whose categories should be determined. If not specified "
+ "all classification categories will be returned."),
responses =
@ApiResponse(
responseCode = "200",
description = "The classification categories for the requested type.",
content =
@Content(
mediaType = MediaTypes.HAL_JSON_VALUE,
schema = @Schema(implementation = String[].class))))
@GetMapping(path = RestEndpoints.URL_CLASSIFICATION_CATEGORIES)
@Transactional(readOnly = true, rollbackFor = Exception.class)
public ResponseEntity> getClassificationCategories(
@RequestParam(value = "type", required = false) String type) {
if (type != null) {
return ResponseEntity.ok(taskanaConfiguration.getClassificationCategoriesByType(type));
}
return ResponseEntity.ok(taskanaConfiguration.getAllClassificationCategories());
}
@Operation(
summary = "This endpoint retrieves the configured classification types.",
responses =
@ApiResponse(
responseCode = "200",
description = "The configured classification types.",
content =
@Content(
mediaType = MediaTypes.HAL_JSON_VALUE,
schema = @Schema(implementation = String[].class))))
@GetMapping(path = RestEndpoints.URL_CLASSIFICATION_TYPES)
@Transactional(readOnly = true, rollbackFor = Exception.class)
public ResponseEntity> getClassificationTypes() {
return ResponseEntity.ok(taskanaConfiguration.getClassificationTypes());
}
@Operation(
summary =
"This endpoint retrieves all configured classification categories grouped by each "
+ "classification type.",
responses =
@ApiResponse(
responseCode = "200",
description = "The configured classification categories.",
content =
@Content(
mediaType = MediaTypes.HAL_JSON_VALUE,
schema = @Schema(ref = "#/components/schemas/TypeMapSchema"))))
@GetMapping(path = RestEndpoints.URL_CLASSIFICATION_CATEGORIES_BY_TYPES)
@Transactional(readOnly = true, rollbackFor = Exception.class)
public ResponseEntity>> getClassificationCategoriesByTypeMap() {
return ResponseEntity.ok(taskanaConfiguration.getClassificationCategoriesByType());
}
@Operation(
summary = "This endpoint computes all information of the current user.",
responses =
@ApiResponse(
responseCode = "200",
description = "The information of the current user.",
content =
@Content(
mediaType = MediaTypes.HAL_JSON_VALUE,
schema = @Schema(implementation = TaskanaUserInfoRepresentationModel.class))))
@GetMapping(path = RestEndpoints.URL_CURRENT_USER)
@Transactional(readOnly = true, rollbackFor = Exception.class)
public ResponseEntity getCurrentUserInfo() {
TaskanaUserInfoRepresentationModel resource = new TaskanaUserInfoRepresentationModel();
resource.setUserId(currentUserContext.getUserid());
resource.setGroupIds(currentUserContext.getGroupIds());
taskanaConfiguration.getRoleMap().keySet().stream()
.filter(taskanaEngine::isUserInRole)
.forEach(resource.getRoles()::add);
return ResponseEntity.ok(resource);
}
@Operation(
summary = "This endpoint checks if the history module is in use.",
responses =
@ApiResponse(
responseCode = "200",
description = "True, when the history is enabled, otherwise false",
content =
@Content(
mediaType = MediaTypes.HAL_JSON_VALUE,
schema = @Schema(implementation = Boolean.class))))
@GetMapping(path = RestEndpoints.URL_HISTORY_ENABLED)
@Transactional(readOnly = true, rollbackFor = Exception.class)
public ResponseEntity getIsHistoryProviderEnabled() {
return ResponseEntity.ok(taskanaEngine.isHistoryEnabled());
}
@Operation(
summary = "Get custom configuration",
description = "This endpoint retrieves the saved custom configuration.",
responses =
@ApiResponse(
responseCode = "200",
description = "The custom configuration.",
content =
@Content(
mediaType = MediaTypes.HAL_JSON_VALUE,
schema =
@Schema(implementation = CustomAttributesRepresentationModel.class))))
@GetMapping(path = RestEndpoints.URL_CUSTOM_ATTRIBUTES)
@Transactional(readOnly = true, rollbackFor = Exception.class)
public ResponseEntity getCustomAttributes() {
Map allCustomAttributes = configurationService.getAllCustomAttributes();
return ResponseEntity.ok(new CustomAttributesRepresentationModel(allCustomAttributes));
}
@Operation(
summary = "Set all custom configuration",
description = "This endpoint overrides the custom configuration.",
requestBody =
@io.swagger.v3.oas.annotations.parameters.RequestBody(
description = "The new custom configuration",
required = true,
content =
@Content(
schema = @Schema(implementation = CustomAttributesRepresentationModel.class),
examples =
@ExampleObject(
value =
"{\n"
+ " \"customAttributes\": {\n"
+ " \"schema\": {\n"
+ " \"Filter\": {\n"
+ " \"displayName\": "
+ "\"Filter for Task-Priority-Report\",\n"
+ " \"members\": {\n"
+ " \"filter\": {\n"
+ " \"displayName\": \"Filter values\",\n"
+ " \"type\": \"json\",\n"
+ " \"min\": \"1\"\n"
+ " }\n"
+ " }\n"
+ " },\n"
+ " \"filter\": \"{ \\\"Tasks with state READY\\\": "
+ "{ \\\"state\\\": [\\\"READY\\\"]}, \\\"Tasks with state "
+ "CLAIMED\\\": {\\\"state\\\": [\\\"CLAIMED\\\"] }}\"\n"
+ " }\n"
+ " }\n"
+ "}"))),
responses =
@ApiResponse(
responseCode = "200",
description = "The new custom configuration.",
content =
@Content(
mediaType = MediaTypes.HAL_JSON_VALUE,
schema =
@Schema(implementation = CustomAttributesRepresentationModel.class))))
@PutMapping(path = RestEndpoints.URL_CUSTOM_ATTRIBUTES)
@Transactional(rollbackFor = Exception.class)
public ResponseEntity setCustomAttributes(
@RequestBody CustomAttributesRepresentationModel customAttributes) {
configurationService.setAllCustomAttributes(customAttributes.getCustomAttributes());
return ResponseEntity.ok(customAttributes);
}
@Operation(
summary = "Get the current application version",
responses =
@ApiResponse(
responseCode = "200",
description = "The current version.",
content =
@Content(
mediaType = MediaTypes.HAL_JSON_VALUE,
schema = @Schema(implementation = VersionRepresentationModel.class))))
@GetMapping(path = RestEndpoints.URL_VERSION)
@Transactional(readOnly = true, rollbackFor = Exception.class)
public ResponseEntity currentVersion() {
VersionRepresentationModel resource = new VersionRepresentationModel();
resource.setVersion(TaskanaConfiguration.class.getPackage().getImplementationVersion());
return ResponseEntity.ok(resource);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy