Package org.openwms.common.transport

Class TransportUnitController

java.lang.Object

org.openwms.core.http.AbstractWebController

org.openwms.common.transport.TransportUnitController

@Profile("!INMEM")
@Validated
@MeasuredRestController
public class TransportUnitController
extends org.openwms.core.http.AbstractWebController

A TransportUnitController.

Author:

Heiko Scherrer

Field Summary

Fields

Modifier and Type	Field	Description
private final BarcodeGenerator	barcodeGenerator
private static final org.slf4j.Logger	EXC_LOGGER
private final TransportUnitMapper	mapper
private final TransportUnitService	service
private final org.ameba.i18n.Translator	translator

Constructor Summary

Constructors

Constructor	Description
TransportUnitController(TransportUnitMapper mapper, org.ameba.i18n.Translator translator, BarcodeGenerator barcodeGenerator, TransportUnitService service)

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<Void>	addErrorToTransportUnit(String transportUnitBK, String errorCode)
private TransportUnitVO	addLinks(TransportUnitVO result)
org.springframework.http.ResponseEntity<Void>	blockTransportUnit(@NotBlank String transportUnitBK)
org.springframework.http.ResponseEntity<Void>	changeState(@NotBlank String transportUnitBK, @NotBlank String newState)
private List<TransportUnitVO>	convertAndLinks(List<TransportUnit> entities)
private TransportUnitVO	convertAndLinks(TransportUnit entity)
org.springframework.http.ResponseEntity<TransportUnitVO>	createTU(String transportUnitBK, String actualLocation, String tut, Boolean strict, jakarta.servlet.http.HttpServletRequest req)
org.springframework.http.ResponseEntity<Void>	createTU(String transportUnitBK, TransportUnitVO tu, Boolean strict, jakarta.servlet.http.HttpServletRequest req)
org.springframework.http.ResponseEntity<Void>	deleteTU(String pKey)
org.springframework.http.ResponseEntity<List<TransportUnitVO>>	findAll()
org.springframework.http.ResponseEntity<TransportUnitVO>	findTransportUnit(String transportUnitBK)
org.springframework.http.ResponseEntity<TransportUnitVO>	findTransportUnitByPKey(String pKey)
org.springframework.http.ResponseEntity<List<TransportUnitVO>>	findTransportUnits(@NotEmpty List<String> barcodes)
org.springframework.http.ResponseEntity<List<TransportUnitVO>>	findTransportUnitsOn(String actualLocation)
private org.springframework.http.ResponseEntity<?>	handleStateChangeException(StateChangeException e)
org.springframework.http.ResponseEntity<org.openwms.core.http.Index>	index()
org.springframework.http.ResponseEntity<TransportUnitVO>	moveTU(String transportUnitBK, String newLocation)
org.springframework.http.ResponseEntity<Void>	qcTransportUnit(@NotBlank String transportUnitBK)
void	synchronizeTU()
org.springframework.http.ResponseEntity<Void>	unblockTransportUnit(@NotBlank String transportUnitBK)
org.springframework.http.ResponseEntity<TransportUnitVO>	updateTU(String transportUnitBK, @Valid TransportUnitVO tu)

Methods inherited from class org.openwms.core.http.AbstractWebController

buildNOKResponse, buildNOKResponseWithKey, buildOKResponse, buildResponse, buildResponse, getLocationForCreatedResource, getLocationURIForCreatedResource, handleBehaviorAwareException, handleBusinessRuntimeException, handleConstraintViolationException, handleException, handleHttpBusinessException, handleRemovalNotAllowedException, handleTechnicalRuntimeException, handleValidationException, illegalArgumentException, translate

Methods inherited from class java.lang.Object

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

Field Details

EXC_LOGGER

private static final org.slf4j.Logger EXC_LOGGER

mapper

private final TransportUnitMapper mapper

translator

private final org.ameba.i18n.Translator translator

barcodeGenerator

private final BarcodeGenerator barcodeGenerator

service

private final TransportUnitService service

Constructor Details

TransportUnitController

TransportUnitController(TransportUnitMapper mapper,
 org.ameba.i18n.Translator translator,
 BarcodeGenerator barcodeGenerator,
 TransportUnitService service)

Method Details

handleStateChangeException

@ExceptionHandler(StateChangeException.class)
private org.springframework.http.ResponseEntity<?> handleStateChangeException(StateChangeException e)

findTransportUnitByPKey

@GetMapping(value="/v1/transport-units/{pKey}",
            produces="application/vnd.openwms.transport-unit-v1+json")
public org.springframework.http.ResponseEntity<TransportUnitVO> findTransportUnitByPKey(@PathVariable("pKey")
 String pKey)

findTransportUnit

@GetMapping(value="/v1/transport-units",
            params="bk",
            produces="application/vnd.openwms.transport-unit-v1+json")
public org.springframework.http.ResponseEntity<TransportUnitVO> findTransportUnit(@RequestParam("bk")
 String transportUnitBK)

findAll

@GetMapping(value="/v1/transport-units",
            produces="application/vnd.openwms.transport-unit-v1+json")
public org.springframework.http.ResponseEntity<List<TransportUnitVO>> findAll()

findTransportUnits

@GetMapping(value="/v1/transport-units",
            params="bks",
            produces="application/vnd.openwms.transport-unit-v1+json")
public org.springframework.http.ResponseEntity<List<TransportUnitVO>> findTransportUnits(@RequestParam("bks") @NotEmpty
 @NotEmpty List<String> barcodes)

findTransportUnitsOn

@GetMapping(value="/v1/transport-units",
            params="actualLocation",
            produces="application/vnd.openwms.transport-unit-v1+json")
public org.springframework.http.ResponseEntity<List<TransportUnitVO>> findTransportUnitsOn(@RequestParam("actualLocation")
 String actualLocation)

createTU

@PostMapping(value="/v1/transport-units",
             params="bk")
public org.springframework.http.ResponseEntity<Void> createTU(@RequestParam("bk")
 String transportUnitBK,
 @Validated(Create.class) @RequestBody
 TransportUnitVO tu,
 @RequestParam(value="strict",required=false)
 Boolean strict,
 jakarta.servlet.http.HttpServletRequest req)

synchronizeTU

@PostMapping("/v1/transport-units/synchronize")
public void synchronizeTU()

deleteTU

@DeleteMapping("/v1/transport-units/{pKey}")
public org.springframework.http.ResponseEntity<Void> deleteTU(@PathVariable("pKey")
 String pKey)

createTU

@PostMapping(value="/v1/transport-units",
             params={"actualLocation","tut"},
             produces="application/vnd.openwms.transport-unit-v1+json")
public org.springframework.http.ResponseEntity<TransportUnitVO> createTU(@RequestParam(value="bk",required=false)
 String transportUnitBK,
 @RequestParam("actualLocation")
 String actualLocation,
 @RequestParam("tut")
 String tut,
 @RequestParam(value="strict",required=false)
 Boolean strict,
 jakarta.servlet.http.HttpServletRequest req)

updateTU

@Validated(Update.class)
@PutMapping(value="/v1/transport-units",
            params="bk",
            produces="application/vnd.openwms.transport-unit-v1+json")
public org.springframework.http.ResponseEntity<TransportUnitVO> updateTU(@RequestParam("bk")
 String transportUnitBK,
 @Valid @RequestBody
 @Valid TransportUnitVO tu)

moveTU

@PatchMapping(value="/v1/transport-units",
              params={"bk","newLocation"},
              produces="application/vnd.openwms.transport-unit-v1+json")
public org.springframework.http.ResponseEntity<TransportUnitVO> moveTU(@RequestParam("bk")
 String transportUnitBK,
 @RequestParam("newLocation")
 String newLocation)

addErrorToTransportUnit

@PostMapping(value="/v1/transport-unit/error",
             params={"bk","errorCode"},
             produces="application/vnd.openwms.transport-unit-v1+json")
public org.springframework.http.ResponseEntity<Void> addErrorToTransportUnit(@RequestParam("bk")
 String transportUnitBK,
 @RequestParam("errorCode")
 String errorCode)

index

@GetMapping("/v1/transport-units/index")
public org.springframework.http.ResponseEntity<org.openwms.core.http.Index> index()

blockTransportUnit

@PostMapping(value="/v1/transport-units/block",
             params="bk")
public org.springframework.http.ResponseEntity<Void> blockTransportUnit(@NotBlank @RequestParam("bk")
 @NotBlank String transportUnitBK)

unblockTransportUnit

@PostMapping(value="/v1/transport-units/available",
             params="bk")
public org.springframework.http.ResponseEntity<Void> unblockTransportUnit(@NotBlank @RequestParam("bk")
 @NotBlank String transportUnitBK)

qcTransportUnit

@PostMapping(value="/v1/transport-units/quality-check",
             params="bk")
public org.springframework.http.ResponseEntity<Void> qcTransportUnit(@NotBlank @RequestParam("bk")
 @NotBlank String transportUnitBK)

changeState

@PostMapping(value="/v1/transport-units",
             params={"bk","state"})
public org.springframework.http.ResponseEntity<Void> changeState(@NotBlank @RequestParam("bk")
 @NotBlank String transportUnitBK,
 @NotBlank @RequestParam("state")
 @NotBlank String newState)

addLinks

private TransportUnitVO addLinks(TransportUnitVO result)

convertAndLinks

private TransportUnitVO convertAndLinks(TransportUnit entity)

convertAndLinks

private List<TransportUnitVO> convertAndLinks(List<TransportUnit> entities)