Package energy.eddie.regionconnector.aiida.web

Class PermissionRequestController

java.lang.Object

energy.eddie.regionconnector.aiida.web.PermissionRequestController

@RestController
public class PermissionRequestController
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PATH_HANDSHAKE_ACCEPT
static final String	PATH_HANDSHAKE_PERMISSION_REQUEST
static final String	PATH_HANDSHAKE_REJECT
static final String	PATH_HANDSHAKE_UNFULFILLABLE

Constructor Summary

Constructors

Constructor	Description
PermissionRequestController(AiidaPermissionService permissionService)

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<MqttDto>	acceptPermissionRequest(String permissionId, @Valid AiidaPermissionAcceptDto acceptDto)	Called by AIIDA when the user accepted the permission request.
org.springframework.http.ResponseEntity<AiidaPermissionRequestsDto>	createPermissionRequests(@Valid PermissionRequestForCreation permissionRequestsForCreation)
org.springframework.http.ResponseEntity<PermissionDetailsDto>	getPermissionDetails(String permissionId)
org.springframework.http.ResponseEntity<Void>	markPermissionRequestUnfulfillable(String permissionId, @Valid AiidaPermissionDeclineDto declineDto)	Called by AIIDA when the AIIDA instance cannot fulfill the permission request, e.g.
org.springframework.http.ResponseEntity<Void>	rejectPermissionRequest(String permissionId, @Valid AiidaPermissionDeclineDto declineDto)	Called by AIIDA when the user rejected the permission request.

Methods inherited from class java.lang.Object

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

Field Details

PATH_HANDSHAKE_PERMISSION_REQUEST

public static final String PATH_HANDSHAKE_PERMISSION_REQUEST

See Also:

• Constant Field Values

PATH_HANDSHAKE_ACCEPT

public static final String PATH_HANDSHAKE_ACCEPT

See Also:

• Constant Field Values

PATH_HANDSHAKE_REJECT

public static final String PATH_HANDSHAKE_REJECT

See Also:

• Constant Field Values

PATH_HANDSHAKE_UNFULFILLABLE

public static final String PATH_HANDSHAKE_UNFULFILLABLE

See Also:

• Constant Field Values

Constructor Details

PermissionRequestController

@Autowired
public PermissionRequestController(AiidaPermissionService permissionService)

Method Details

createPermissionRequests

@PostMapping(value="/permission-request",
             consumes="application/json",
             produces="application/json")
public org.springframework.http.ResponseEntity<AiidaPermissionRequestsDto> createPermissionRequests(@Valid @RequestBody
 @Valid PermissionRequestForCreation permissionRequestsForCreation)
                                                                                             throws DataNeedNotFoundException,
UnsupportedDataNeedException,
DataNeedMalformedException,
JwtCreationFailedException

Throws:

DataNeedNotFoundException

UnsupportedDataNeedException

DataNeedMalformedException

JwtCreationFailedException

acceptPermissionRequest

@PostMapping(value="/permission-request/{permissionId}/accept",
             consumes="application/json",
             produces="application/json")
public org.springframework.http.ResponseEntity<MqttDto> acceptPermissionRequest(@PathVariable
 String permissionId,
 @Valid @RequestBody
 @Valid AiidaPermissionAcceptDto acceptDto)
                                                                         throws PermissionNotFoundException,
CredentialsAlreadyExistException,
PermissionStateTransitionException,
DataNeedNotFoundException

Called by AIIDA when the user accepted the permission request. Returns the MQTT credentials and topics AIIDA has to use for this permission.

Throws:

PermissionNotFoundException

CredentialsAlreadyExistException

PermissionStateTransitionException

DataNeedNotFoundException

rejectPermissionRequest

@PostMapping(value="/permission-request/{permissionId}/reject",
             consumes="application/json")
public org.springframework.http.ResponseEntity<Void> rejectPermissionRequest(@PathVariable
 String permissionId,
 @Valid @RequestBody
 @Valid AiidaPermissionDeclineDto declineDto)
                                                                      throws PermissionNotFoundException,
PermissionStateTransitionException

Called by AIIDA when the user rejected the permission request.

Throws:

PermissionNotFoundException

PermissionStateTransitionException

markPermissionRequestUnfulfillable

@PostMapping(value="/permission-request/{permissionId}/unfulfillable",
             consumes="application/json")
public org.springframework.http.ResponseEntity<Void> markPermissionRequestUnfulfillable(@PathVariable
 String permissionId,
 @Valid @RequestBody
 @Valid AiidaPermissionDeclineDto declineDto)
                                                                                 throws PermissionNotFoundException,
PermissionStateTransitionException

Called by AIIDA when the AIIDA instance cannot fulfill the permission request, e.g. because the requested data is not available.

Throws:

PermissionNotFoundException

PermissionStateTransitionException

getPermissionDetails

@GetMapping(value="/permission-request/{permissionId}",
            produces="application/json")
public org.springframework.http.ResponseEntity<PermissionDetailsDto> getPermissionDetails(@PathVariable
 String permissionId)
                                                                                   throws DataNeedNotFoundException,
PermissionNotFoundException

Throws:

DataNeedNotFoundException

PermissionNotFoundException