me.nunum.whereami.controller

Class AlgorithmController

java.lang.Object

me.nunum.whereami.controller.AlgorithmController

All Implemented Interfaces:

java.lang.AutoCloseable

public class AlgorithmController
extends java.lang.Object
implements java.lang.AutoCloseable

Constructor Summary

Constructors

Constructor and Description
AlgorithmController() constructor

Method Summary

Modifier and Type	Method and Description
DTO	addNewAlgorithm(java.security.Principal principal, NewAlgorithmRequest algorithmRequest) Register new algorithm
DTO	algorithm(java.lang.Long aId) Display information for a specific algorithm
java.util.List<DTO>	algorithms(java.util.Optional<java.lang.Integer> page) Display a list of approved algorithm entities
void	close() Is never trowed, otherwise the client would get a 500 instead of the actual processed response
DTO	deleteAlgorithm(java.lang.Long aId) Deletes algorithm instance
DTO	deleteProvider(java.lang.Long aId, java.lang.Long pId, java.security.Principal userPrincipal) Deletes a algorithm provider.
DTO	registerNewAlgorithmProvider(java.lang.Long aId, NewAlgorithmProvider algorithmProviderRequest, java.security.Principal principal) Register new algorithm provider
DTO	runAlgorithmImplementation(java.lang.Long aId, java.lang.Long ag, NewAlgorithmRunRequest request)
DTO	updateAlgorithm(java.security.Principal userPrincipal, java.lang.Long aId, UpdateAlgorithmRequest request) Update algorithm instance
DTO	updateEntityApproval(java.lang.Long aId, ApprovalRequest request) Updates algorithm approval
DTO	updateProvider(java.security.Principal userPrincipal, java.lang.Long aId, java.lang.Long pId, UpdateAlgorithmProvider request)

Methods inherited from class java.lang.Object

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

Constructor Detail

AlgorithmController

public AlgorithmController()

constructor

Method Detail

algorithms

public java.util.List<DTO> algorithms(java.util.Optional<java.lang.Integer> page)

Display a list of approved algorithm entities

Parameters:

page - Page used for paginate algorithm

Returns:

See AlgorithmDTO

updateAlgorithm

public DTO updateAlgorithm(java.security.Principal userPrincipal,
                           java.lang.Long aId,
                           UpdateAlgorithmRequest request)

Update algorithm instance

Parameters:

userPrincipal - See Principal

aId - Algorithm Id

request - See UpdateAlgorithmRequest

Returns:

See AlgorithmDTO

Throws:

EntityNotFoundException

updateEntityApproval

public DTO updateEntityApproval(java.lang.Long aId,
                                ApprovalRequest request)

Updates algorithm approval

Parameters:

aId - Algorithm Id

request - See ApprovalRequest

Returns:

See AlgorithmDTO

Throws:

EntityNotFoundException

deleteAlgorithm

public DTO deleteAlgorithm(java.lang.Long aId)

Deletes algorithm instance

Parameters:

aId - Algorithm Id

Returns:

See AlgorithmDTO

Throws:

EntityNotFoundException

addNewAlgorithm

public DTO addNewAlgorithm(java.security.Principal principal,
                           NewAlgorithmRequest algorithmRequest)

Register new algorithm

Parameters:

algorithmRequest - New Algorithm Request

Returns:

See AlgorithmProviderDTO

algorithm

public DTO algorithm(java.lang.Long aId)

Display information for a specific algorithm

Parameters:

aId - Algorithm ID

Returns:

See AlgorithmProviderDTO

Throws:

EntityNotFoundException - Algorithm ID does not exists in database

registerNewAlgorithmProvider

public DTO registerNewAlgorithmProvider(java.lang.Long aId,
                                        NewAlgorithmProvider algorithmProviderRequest,
                                        java.security.Principal principal)

Register new algorithm provider

Parameters:

aId - Algorithm ID

algorithmProviderRequest - Algorithm Provider Request

principal - Device

Returns:

See AlgorithmProviderDTO

Throws:

EntityNotFoundException - Algorithm ID does not exists in database

deleteProvider

public DTO deleteProvider(java.lang.Long aId,
                          java.lang.Long pId,
                          java.security.Principal userPrincipal)

Deletes a algorithm provider.

Parameters:

aId - Algorithm ID

pId - Algorithm Provider ID

userPrincipal - Device

Returns:

See AlgorithmProviderDTO

Throws:

EntityNotFoundException - Algorithm Provider ID does not exists in database

ForbiddenEntityAccessException - Device is not owner of the entity

updateProvider

public DTO updateProvider(java.security.Principal userPrincipal,
                          java.lang.Long aId,
                          java.lang.Long pId,
                          UpdateAlgorithmProvider request)

Parameters:

userPrincipal -

aId -

pId -

request -

Returns:

See AlgorithmProviderDTO

Throws:

EntityNotFoundException - If entity is not present in persist layer

ForbiddenEntityAccessException - If requester is not the owner of the instance

java.lang.IllegalArgumentException - If the request not contain valid provider properties

close

public void close()
           throws java.lang.Exception

Is never trowed, otherwise the client would get a 500 instead of the actual processed response

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.lang.Exception - It must never occur

runAlgorithmImplementation

public DTO runAlgorithmImplementation(java.lang.Long aId,
                                      java.lang.Long ag,
                                      NewAlgorithmRunRequest request)