| /********************************************************************************
|
| * Copyright (c) 2015-2018 Contributors to the Eclipse Foundation
|
| *
|
| * See the NOTICE file(s) distributed with this work for additional
|
| * information regarding copyright ownership.
|
| *
|
| * This program and the accompanying materials are made available under the
|
| * terms of the Eclipse Public License v. 2.0 which is available at
|
| * http://www.eclipse.org/legal/epl-2.0.
|
| *
|
| * SPDX-License-Identifier: EPL-2.0
|
| *
|
| ********************************************************************************/
|
| |
| package org.eclipse.mdm.businessobjects.boundary; |
| |
| import static org.eclipse.mdm.businessobjects.boundary.ResourceConstants.ENTITYATTRIBUTE_DATATYPE; |
| import static org.eclipse.mdm.businessobjects.boundary.ResourceConstants.ENTITYATTRIBUTE_NAME; |
| import static org.eclipse.mdm.businessobjects.boundary.ResourceConstants.REQUESTPARAM_ID; |
| import static org.eclipse.mdm.businessobjects.boundary.ResourceConstants.REQUESTPARAM_ID2; |
| import static org.eclipse.mdm.businessobjects.boundary.ResourceConstants.REQUESTPARAM_ID3; |
| import static org.eclipse.mdm.businessobjects.boundary.ResourceConstants.REQUESTPARAM_SOURCENAME; |
| import static org.eclipse.mdm.businessobjects.service.EntityService.L; |
| import static org.eclipse.mdm.businessobjects.service.EntityService.SL; |
| import static org.eclipse.mdm.businessobjects.service.EntityService.V; |
| |
| import javax.ejb.EJB; |
| import javax.ws.rs.Consumes; |
| import javax.ws.rs.DELETE; |
| import javax.ws.rs.GET; |
| import javax.ws.rs.POST; |
| import javax.ws.rs.PUT; |
| import javax.ws.rs.Path; |
| import javax.ws.rs.PathParam; |
| import javax.ws.rs.Produces; |
| import javax.ws.rs.QueryParam; |
| import javax.ws.rs.core.MediaType; |
| import javax.ws.rs.core.Response; |
| import javax.ws.rs.core.Response.Status; |
| |
| import org.eclipse.mdm.api.base.model.ContextType; |
| import org.eclipse.mdm.api.base.model.Environment; |
| import org.eclipse.mdm.api.dflt.model.CatalogAttribute; |
| import org.eclipse.mdm.api.dflt.model.CatalogComponent; |
| import org.eclipse.mdm.api.dflt.model.CatalogSensor; |
| import org.eclipse.mdm.businessobjects.entity.SearchAttribute; |
| import org.eclipse.mdm.businessobjects.service.EntityService; |
| import org.eclipse.mdm.businessobjects.utils.RequestBody; |
| import org.eclipse.mdm.businessobjects.utils.ServiceUtils; |
| |
| import io.vavr.collection.List; |
| |
| /** |
| * {@link CatalogAttribute} resource handling REST requests |
| * |
| * @author Philipp Schweinbenz, science+computing AG Tuebingen (Atos SE) |
| * |
| */ |
| @Path("/environments/{" + REQUESTPARAM_SOURCENAME + "}/catcomps/testequipment/{" + REQUESTPARAM_ID + "}/catsensors/{" |
| + REQUESTPARAM_ID2 |
| + "}/catsensorattrs") |
| public class CatalogSensorAttributeResource { |
| |
| @EJB |
| private EntityService entityService; |
| |
| /** |
| * Returns the found {@link CatalogAttribute}. |
| * |
| * @param sourceName |
| * name of the source (MDM {@link Environment} name) |
| * @param catCompId |
| * id of the {@link CatalogComponent} |
| * @param sensorId |
| * id of the {@link CatalogSensor} |
| * @param id |
| * id of the {@link CatalogAttribute} |
| * @return the found {@link CatalogAttribute} as {@link Response} |
| */ |
| @GET |
| @Produces(MediaType.APPLICATION_JSON) |
| @Path("/{" + REQUESTPARAM_ID3 + "}") |
| public Response find(@PathParam(REQUESTPARAM_SOURCENAME) String sourceName, |
| @PathParam(REQUESTPARAM_ID) String catCompId, @PathParam(REQUESTPARAM_ID2) String sensorId, |
| @PathParam(REQUESTPARAM_ID3) String id) { |
| return entityService |
| .find(V(sourceName), CatalogAttribute.class, V(id), |
| V(ContextType.TESTEQUIPMENT), SL(catCompId, sensorId)) |
| .map(e -> ServiceUtils.buildEntityResponse(e, Status.OK)) |
| .recover(ServiceUtils.ERROR_RESPONSE_SUPPLIER).getOrElse(ServiceUtils.SERVER_ERROR_RESPONSE); |
| } |
| |
| /** |
| * Returns the (filtered) {@link CatalogAttribute}s. |
| * |
| * @param sourceName |
| * name of the source (MDM {@link Environment} name) |
| * @param catCompId |
| * id of the {@link CatalogComponent} |
| * @param sensorId |
| * id of the {@link CatalogSensor} |
| * @param filter |
| * filter string to filter the {@link CatalogAttribute} result |
| * @return the (filtered) {@link CatalogAttribute}s as {@link Response} |
| */ |
| @GET |
| @Produces(MediaType.APPLICATION_JSON) |
| public Response findAll(@PathParam(REQUESTPARAM_SOURCENAME) String sourceName, |
| @PathParam(REQUESTPARAM_ID) String catCompId, @PathParam(REQUESTPARAM_ID2) String sensorId, |
| @QueryParam("filter") String filter) { |
| return entityService |
| .find(V(sourceName), CatalogSensor.class, V(sensorId), V(ContextType.TESTEQUIPMENT), SL(catCompId)) |
| .map(catSensor -> List.ofAll(catSensor.getCatalogAttributes())) |
| .map(e -> ServiceUtils.buildEntityResponse(e, Status.OK)) |
| .recover(ServiceUtils.ERROR_RESPONSE_SUPPLIER).getOrElse(ServiceUtils.SERVER_ERROR_RESPONSE); |
| } |
| |
| /** |
| * Returns the created {@link CatalogAttributeValue}. |
| * |
| * @param catCompId |
| * id of the {@link CatalogComponent} |
| * @param sensorId |
| * id of the {@link CatalogSensor} |
| * @param body |
| * The {@link CatalogAttribute} to create. |
| * @return the created {@link CatalogAttribute} as {@link Response}. |
| */ |
| @POST |
| @Produces(MediaType.APPLICATION_JSON) |
| @Consumes(MediaType.APPLICATION_JSON) |
| public Response create(@PathParam(REQUESTPARAM_SOURCENAME) String sourceName, |
| @PathParam(REQUESTPARAM_ID) String catCompId, |
| @PathParam(REQUESTPARAM_ID2) String sensorId, String body) { |
| RequestBody requestBody = RequestBody.create(body); |
| |
| return entityService |
| .create(V(sourceName), CatalogAttribute.class, |
| L(requestBody.getStringValueSupplier(ENTITYATTRIBUTE_NAME), |
| entityService.getEnumerationValueSupplier( |
| requestBody.getStringValueSupplier(ENTITYATTRIBUTE_DATATYPE)), |
| entityService.find(V(sourceName), CatalogSensor.class, V(sensorId), |
| V(ContextType.TESTEQUIPMENT), SL(catCompId)))) |
| .map(e -> ServiceUtils.buildEntityResponse(e, Status.CREATED)) |
| .recover(ServiceUtils.ERROR_RESPONSE_SUPPLIER).getOrElse(ServiceUtils.SERVER_ERROR_RESPONSE); |
| } |
| |
| /** |
| * Updates the {@link CatalogAttribute} with all parameters set in the given |
| * JSON body of the request |
| * |
| * @param sourceName |
| * name of the source (MDM {@link Environment} name) |
| * @param catCompId |
| * id of the {@link CatalogComponent} |
| * @param sensorId |
| * id of the {@link CatalogSensor} |
| * @param id |
| * the identifier of the {@link CatalogAttribute} to delete. |
| * @param body |
| * the body of the request containing the attributes to update |
| * @return the updated {@link CatalogAttribute} |
| */ |
| @PUT |
| @Produces(MediaType.APPLICATION_JSON) |
| @Consumes(MediaType.APPLICATION_JSON) |
| @Path("/{" + REQUESTPARAM_ID3 + "}") |
| public Response update(@PathParam(REQUESTPARAM_SOURCENAME) String sourceName, |
| @PathParam(REQUESTPARAM_ID) String catCompId, @PathParam(REQUESTPARAM_ID2) String sensorId, |
| @PathParam(REQUESTPARAM_ID3) String id, String body) { |
| RequestBody requestBody = RequestBody.create(body); |
| |
| return entityService |
| .update(V(sourceName), |
| entityService.find(V(sourceName), CatalogAttribute.class, V(id), |
| V(ContextType.TESTEQUIPMENT), SL(catCompId, sensorId)), |
| requestBody.getValueMapSupplier()) |
| .map(e -> ServiceUtils.buildEntityResponse(e, Status.OK)) |
| .recover(ServiceUtils.ERROR_RESPONSE_SUPPLIER) |
| .getOrElse(ServiceUtils.SERVER_ERROR_RESPONSE); |
| } |
| |
| /** |
| * Deletes and returns the deleted {@link CatalogAttribute}. |
| * |
| * @param catCompId |
| * id of the {@link CatalogComponent} |
| * @param sensorId |
| * id of the {@link CatalogSensor} |
| * @param id |
| * The identifier of the {@link CatalogAttribute} to delete. |
| * @return the deleted {@link CatalogAttribute }s as {@link Response} |
| */ |
| @DELETE |
| @Produces(MediaType.APPLICATION_JSON) |
| @Path("/{" + REQUESTPARAM_ID3 + "}") |
| public Response delete(@PathParam(REQUESTPARAM_SOURCENAME) String sourceName, |
| @PathParam(REQUESTPARAM_ID) String catCompId, @PathParam(REQUESTPARAM_ID2) String sensorId, |
| @PathParam(REQUESTPARAM_ID3) String id) { |
| return entityService |
| .delete(V(sourceName), |
| entityService.find(V(sourceName), CatalogAttribute.class, V(id), |
| V(ContextType.TESTEQUIPMENT), SL(catCompId, sensorId))) |
| .map(e -> ServiceUtils.buildEntityResponse(e, Status.OK)).recover(ServiceUtils.ERROR_RESPONSE_SUPPLIER) |
| .getOrElse(ServiceUtils.SERVER_ERROR_RESPONSE); |
| } |
| |
| /** |
| * Returns the search attributes for the {@link CatalogAttribute} type. |
| * |
| * @param sourceName |
| * name of the source (MDM {@link Environment} name) |
| * @return the {@link SearchAttribute}s as {@link Response} |
| */ |
| @GET |
| @Produces(MediaType.APPLICATION_JSON) |
| @Path("/searchattributes") |
| public Response getSearchAttributes(@PathParam(REQUESTPARAM_SOURCENAME) String sourceName) { |
| return ServiceUtils.buildSearchAttributesResponse(V(sourceName), CatalogAttribute.class, entityService); |
| } |
| |
| /** |
| * Returns a map of localization for the entity type and the attributes. |
| * |
| * @param sourceName |
| * name of the source (MDM {@link Environment} name) |
| * @return the I18N as {@link Response} |
| */ |
| @GET |
| @Produces(MediaType.APPLICATION_JSON) |
| @Path("/localizations") |
| public Response localize(@PathParam(REQUESTPARAM_SOURCENAME) String sourceName) { |
| return ServiceUtils.buildLocalizationResponse(V(sourceName), CatalogAttribute.class, entityService); |
| } |
| |
| } |