Package energy.eddie.aiida.web

Class InboundController

java.lang.Object

energy.eddie.aiida.web.InboundController

@Controller
@RequestMapping("/inbound")
public class InboundController
extends Object

Constructor Summary

Constructors

Constructor	Description
InboundController(InboundRecordService inboundRecordService)	Creates the controller used to retrieve inbound records through REST provisioning.

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<InboundRecordDto>	latestRecord(UUID permissionId, String bearerKey, String queryKey)	Returns the latest inbound record using the configured REST provisioning mechanism.

Methods inherited from class java.lang.Object

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

Constructor Details

InboundController

public InboundController(InboundRecordService inboundRecordService)

Creates the controller used to retrieve inbound records through REST provisioning.

Parameters:

inboundRecordService - Service that retrieves and authorizes inbound records.

Method Details

latestRecord

@GetMapping(value="/latest/{permissionId}",
            produces="application/json")
public org.springframework.http.ResponseEntity<InboundRecordDto> latestRecord(@PathVariable
 UUID permissionId,
 @RequestHeader(value="X-API-Key",required=false)
 String bearerKey,
 @RequestParam(value="apiKey",required=false)
 String queryKey)
                                                                       throws PermissionNotFoundException,
UnauthorizedException,
InvalidDataSourceTypeException,
InboundRecordNotFoundException,
UnsupportedInboundRecordTransformationException,
InvalidInboundPermissionException,
ProvisioningTypeNotConfiguredException

Returns the latest inbound record using the configured REST provisioning mechanism. A non-blank X-API-Key header selects bearer provisioning; otherwise a non-blank apiKey query parameter selects API-token provisioning.

Parameters:

permissionId - ID of the inbound permission whose latest record should be returned.

bearerKey - Access code supplied through the X-API-Key header.

queryKey - Access code supplied through the apiKey query parameter.

Returns:

A response containing the latest inbound record.

Throws:

PermissionNotFoundException - If the permission does not exist.

UnauthorizedException - If no access code is supplied or the code is invalid.

InvalidDataSourceTypeException - If the permission does not use an inbound data source.

InboundRecordNotFoundException - If no inbound record exists for the data source.

UnsupportedInboundRecordTransformationException - If the record cannot be transformed to the configured format.

InvalidInboundPermissionException - If the permission has no inbound message format.

ProvisioningTypeNotConfiguredException - If the selected REST provisioning type is not active.