Package org.neotropic.kuwaiba.northbound.rest.services

Interface ContractRestOpenApi

All Known Implementing Classes:

ContractRestController

@RequestMapping("/v2.1.1/contract-manager/")
public interface ContractRestOpenApi

Swagger documentation for contract manager.

Author:

Mauricio Ruiz Beltrán <mauricio.ruiz@kuwaiba.org>

Field Summary

Fields

Modifier and Type	Field	Description
static String	PATH	Path that includes the Kuwaiba version and module

Method Summary

Modifier and Type	Method	Description
String	copyContractToPool(@NotNull @Valid String poolId, @NotNull @Valid String contractClassName, @NotNull @Valid String contractId, @Valid String userName, @NotNull @Valid String sessionId)
String	createContract(@NotNull @Valid String poolId, @NotNull @Valid String contractClassName, @Valid HashMap<String,String> attributes, @Valid String userName, @NotNull @Valid String sessionId)
String	createContractPool(@NotNull @Valid String poolName, @NotNull @Valid String poolDescription, @NotNull @Valid String poolClassName, @Valid String userName, @NotNull @Valid String sessionId)
void	deleteContract(@NotNull @Valid String contractClassName, @NotNull @Valid String contractId, @Valid String userName, @NotNull @Valid String sessionId)
void	deleteContractPool(@NotNull @Valid String poolId, @NotNull @Valid String poolClassName, @Valid String userName, @NotNull @Valid String sessionId)
List<BusinessObjectLight>	getAllContracts(@javax.validation.constraints.NotNull,@javax.validation.Valid long page, @javax.validation.constraints.NotNull,@javax.validation.Valid long limit, @NotNull @Valid String sessionId)
BusinessObject	getContract(@NotNull @Valid String contractClassName, @NotNull @Valid String contractId, @NotNull @Valid String sessionId)
InventoryObjectPool	getContractPool(@NotNull @Valid String poolId, @NotNull @Valid String poolClassName, @NotNull @Valid String sessionId)
List<InventoryObjectPool>	getContractPools(@NotNull @Valid String sessionId)
List<BusinessObjectLight>	getContractResources(@NotNull @Valid String contractClassName, @NotNull @Valid String contractId, @NotNull @Valid String sessionId)
List<BusinessObjectLight>	getContractsInPool(@NotNull @Valid String poolId, @javax.validation.constraints.NotNull,@javax.validation.Valid int limit, @NotNull @Valid String sessionId)
void	moveContractToPool(@NotNull @Valid String poolId, @NotNull @Valid String contractClassName, @NotNull @Valid String contractId, @Valid String userName, @NotNull @Valid String sessionId)
void	relateObjectsToContract(@NotNull @Valid String contractClassName, @NotNull @Valid String contractId, @NotNull @Valid String[] objectsClassNames, @NotNull @Valid String[] objectsIds, @Valid String userName, @NotNull @Valid String sessionId)
void	relateObjectToContract(@NotNull @Valid String contractClassName, @NotNull @Valid String contractId, @NotNull @Valid String objectClassName, @NotNull @Valid String objectId, @Valid String userName, @NotNull @Valid String sessionId)
void	releaseObjectFromContract(@NotNull @Valid String objectClassName, @NotNull @Valid String objectId, @NotNull @Valid String contractClassName, @NotNull @Valid String contractId, @Valid String userName, @NotNull @Valid String sessionId)
void	updateContract(@NotNull @Valid String contractClassName, @NotNull @Valid String contractId, @Valid HashMap<String,String> attributes, @Valid String userName, @NotNull @Valid String sessionId)
void	updateContractPool(@NotNull @Valid String poolId, @NotNull @Valid String poolClassName, @NotNull @Valid String poolName, @NotNull @Valid String poolDescription, @Valid String userName, @NotNull @Valid String sessionId)

Field Detail

PATH

static final String PATH

Path that includes the Kuwaiba version and module

See Also:

Constant Field Values

Method Detail

createContractPool

@RequestMapping(method=POST,
                value="createContractPool/{poolName}/{poolDescription}/{poolClassName}/{userName}/{sessionId}",
                produces="application/json")
String createContractPool(@NotNull @Valid @PathVariable(value="poolName",required=true)
                          @NotNull @Valid String poolName,
                          @NotNull @Valid @PathVariable(value="poolDescription",required=true)
                          @NotNull @Valid String poolDescription,
                          @NotNull @Valid @PathVariable(value="poolClassName",required=true)
                          @NotNull @Valid String poolClassName,
                          @Valid @PathVariable(value="userName",required=true)
                          @Valid String userName,
                          @NotNull @Valid @PathVariable(value="sessionId",required=true)
                          @NotNull @Valid String sessionId)

updateContractPool

@RequestMapping(method=PUT,
                value="updateContractPool/{poolId}/{poolClassName}/{poolName}/{poolDescription}/{userName}/{sessionId}",
                produces="application/json")
void updateContractPool(@NotNull @Valid @PathVariable(value="poolId",required=true)
                        @NotNull @Valid String poolId,
                        @NotNull @Valid @PathVariable(value="poolClassName",required=true)
                        @NotNull @Valid String poolClassName,
                        @NotNull @Valid @PathVariable(value="poolName",required=true)
                        @NotNull @Valid String poolName,
                        @NotNull @Valid @PathVariable(value="poolDescription",required=true)
                        @NotNull @Valid String poolDescription,
                        @Valid @PathVariable(value="userName",required=true)
                        @Valid String userName,
                        @NotNull @Valid @PathVariable(value="sessionId",required=true)
                        @NotNull @Valid String sessionId)

deleteContractPool

@RequestMapping(method=DELETE,
                value="deleteContractPool/{poolId}/{poolClassName}/{userName}/{sessionId}",
                produces="application/json")
void deleteContractPool(@NotNull @Valid @PathVariable(value="poolId",required=true)
                        @NotNull @Valid String poolId,
                        @NotNull @Valid @PathVariable(value="poolClassName",required=true)
                        @NotNull @Valid String poolClassName,
                        @Valid @PathVariable(value="userName",required=true)
                        @Valid String userName,
                        @NotNull @Valid @PathVariable(value="sessionId",required=true)
                        @NotNull @Valid String sessionId)

getContractPools

@RequestMapping(method=GET,
                value="getContractPools/{sessionId}",
                produces="application/json")
List<InventoryObjectPool> getContractPools(@NotNull @Valid @PathVariable(value="sessionId",required=true)
                                           @NotNull @Valid String sessionId)

getContractPool

@RequestMapping(method=GET,
                value="getContractPool/{poolId}/{poolClassName}/{sessionId}",
                produces="application/json")
InventoryObjectPool getContractPool(@NotNull @Valid @PathVariable(value="poolId",required=true)
                                    @NotNull @Valid String poolId,
                                    @NotNull @Valid @PathVariable(value="poolClassName",required=true)
                                    @NotNull @Valid String poolClassName,
                                    @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                    @NotNull @Valid String sessionId)

createContract

@RequestMapping(method=POST,
                value="createContract/{poolId}/{contractClassName}/{userName}/{sessionId}",
                produces="application/json")
String createContract(@NotNull @Valid @PathVariable(value="poolId",required=true)
                      @NotNull @Valid String poolId,
                      @NotNull @Valid @PathVariable(value="contractClassName",required=true)
                      @NotNull @Valid String contractClassName,
                      @Valid @RequestBody
                      @Valid HashMap<String,String> attributes,
                      @Valid @PathVariable(value="userName",required=true)
                      @Valid String userName,
                      @NotNull @Valid @PathVariable(value="sessionId",required=true)
                      @NotNull @Valid String sessionId)

updateContract

@RequestMapping(method=PUT,
                value="updateContract/{contractClassName}/{contractId}/{userName}/{sessionId}",
                produces="application/json")
void updateContract(@NotNull @Valid @PathVariable(value="contractClassName",required=true)
                    @NotNull @Valid String contractClassName,
                    @NotNull @Valid @PathVariable(value="contractId",required=true)
                    @NotNull @Valid String contractId,
                    @Valid @RequestBody
                    @Valid HashMap<String,String> attributes,
                    @Valid @PathVariable(value="userName",required=true)
                    @Valid String userName,
                    @NotNull @Valid @PathVariable(value="sessionId",required=true)
                    @NotNull @Valid String sessionId)

deleteContract

@RequestMapping(method=DELETE,
                value="deleteContract/{contractClassName}/{contractId}/{userName}/{sessionId}",
                produces="application/json")
void deleteContract(@NotNull @Valid @PathVariable(value="contractClassName",required=true)
                    @NotNull @Valid String contractClassName,
                    @NotNull @Valid @PathVariable(value="contractId",required=true)
                    @NotNull @Valid String contractId,
                    @Valid @PathVariable(value="userName",required=true)
                    @Valid String userName,
                    @NotNull @Valid @PathVariable(value="sessionId",required=true)
                    @NotNull @Valid String sessionId)

getAllContracts

@RequestMapping(method=GET,
                value="getAllContracts/{page}/{limit}/{sessionId}",
                produces="application/json")
List<BusinessObjectLight> getAllContracts(@NotNull @Valid @PathVariable(value="page",required=true)
                                          @javax.validation.constraints.NotNull,@javax.validation.Valid long page,
                                          @NotNull @Valid @PathVariable(value="limit",required=true)
                                          @javax.validation.constraints.NotNull,@javax.validation.Valid long limit,
                                          @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                          @NotNull @Valid String sessionId)

getContractsInPool

@RequestMapping(method=GET,
                value="getContractsInPool/{poolId}/{limit}/{sessionId}",
                produces="application/json")
List<BusinessObjectLight> getContractsInPool(@NotNull @Valid @PathVariable(value="poolId",required=true)
                                             @NotNull @Valid String poolId,
                                             @NotNull @Valid @PathVariable(value="limit",required=true)
                                             @javax.validation.constraints.NotNull,@javax.validation.Valid int limit,
                                             @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                             @NotNull @Valid String sessionId)

getContract

@RequestMapping(method=GET,
                value="getContract/{contractClassName}/{contractId}/{sessionId}",
                produces="application/json")
BusinessObject getContract(@NotNull @Valid @PathVariable(value="contractClassName",required=true)
                           @NotNull @Valid String contractClassName,
                           @NotNull @Valid @PathVariable(value="contractId",required=true)
                           @NotNull @Valid String contractId,
                           @NotNull @Valid @PathVariable(value="sessionId",required=true)
                           @NotNull @Valid String sessionId)

relateObjectsToContract

@RequestMapping(method=PUT,
                value="relateObjectsToContract/{contractClassName}/{contractId}/{objectsClassNames}/{objectsIds}/{userName}/{sessionId}",
                produces="application/json")
void relateObjectsToContract(@NotNull @Valid @PathVariable(value="contractClassName",required=true)
                             @NotNull @Valid String contractClassName,
                             @NotNull @Valid @PathVariable(value="contractId",required=true)
                             @NotNull @Valid String contractId,
                             @NotNull @Valid @PathVariable(value="objectsClassNames",required=true)
                             @NotNull @Valid String[] objectsClassNames,
                             @NotNull @Valid @PathVariable(value="objectsIds",required=true)
                             @NotNull @Valid String[] objectsIds,
                             @Valid @PathVariable(value="userName",required=true)
                             @Valid String userName,
                             @NotNull @Valid @PathVariable(value="sessionId",required=true)
                             @NotNull @Valid String sessionId)

relateObjectToContract

@RequestMapping(method=PUT,
                value="relateObjectToContract/{contractClassName}/{contractId}/{objectClassName}/{objectId}/{userName}/{sessionId}",
                produces="application/json")
void relateObjectToContract(@NotNull @Valid @PathVariable(value="contractClassName",required=true)
                            @NotNull @Valid String contractClassName,
                            @NotNull @Valid @PathVariable(value="contractId",required=true)
                            @NotNull @Valid String contractId,
                            @NotNull @Valid @PathVariable(value="objectClassName",required=true)
                            @NotNull @Valid String objectClassName,
                            @NotNull @Valid @PathVariable(value="objectId",required=true)
                            @NotNull @Valid String objectId,
                            @Valid @PathVariable(value="userName",required=true)
                            @Valid String userName,
                            @NotNull @Valid @PathVariable(value="sessionId",required=true)
                            @NotNull @Valid String sessionId)

releaseObjectFromContract

@RequestMapping(method=PUT,
                value="releaseObjectFromContract/{objectClassName}/{objectId}/{contractClassName}/{contractId}/{userName}/{sessionId}",
                produces="application/json")
void releaseObjectFromContract(@NotNull @Valid @PathVariable(value="objectClassName",required=true)
                               @NotNull @Valid String objectClassName,
                               @NotNull @Valid @PathVariable(value="objectId",required=true)
                               @NotNull @Valid String objectId,
                               @NotNull @Valid @PathVariable(value="contractClassName",required=true)
                               @NotNull @Valid String contractClassName,
                               @NotNull @Valid @PathVariable(value="contractId",required=true)
                               @NotNull @Valid String contractId,
                               @Valid @PathVariable(value="userName",required=true)
                               @Valid String userName,
                               @NotNull @Valid @PathVariable(value="sessionId",required=true)
                               @NotNull @Valid String sessionId)

getContractResources

@RequestMapping(method=GET,
                value="getContractResources/{contractClassName}/{contractId}/{sessionId}",
                produces="application/json")
List<BusinessObjectLight> getContractResources(@NotNull @Valid @PathVariable(value="contractClassName",required=true)
                                               @NotNull @Valid String contractClassName,
                                               @NotNull @Valid @PathVariable(value="contractId",required=true)
                                               @NotNull @Valid String contractId,
                                               @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                               @NotNull @Valid String sessionId)

copyContractToPool

@RequestMapping(method=PUT,
                value="copyContractToPool/{poolId}/{contractClassName}/{contractId}/{userName}/{sessionId}",
                produces="application/json")
String copyContractToPool(@NotNull @Valid @PathVariable(value="poolId",required=true)
                          @NotNull @Valid String poolId,
                          @NotNull @Valid @PathVariable(value="contractClassName",required=true)
                          @NotNull @Valid String contractClassName,
                          @NotNull @Valid @PathVariable(value="contractId",required=true)
                          @NotNull @Valid String contractId,
                          @Valid @PathVariable(value="userName",required=true)
                          @Valid String userName,
                          @NotNull @Valid @PathVariable(value="sessionId",required=true)
                          @NotNull @Valid String sessionId)

moveContractToPool

@RequestMapping(method=PUT,
                value="moveContractToPool/{poolId}/{contractClassName}/{contractId}/{userName}/{sessionId}",
                produces="application/json")
void moveContractToPool(@NotNull @Valid @PathVariable(value="poolId",required=true)
                        @NotNull @Valid String poolId,
                        @NotNull @Valid @PathVariable(value="contractClassName",required=true)
                        @NotNull @Valid String contractClassName,
                        @NotNull @Valid @PathVariable(value="contractId",required=true)
                        @NotNull @Valid String contractId,
                        @Valid @PathVariable(value="userName",required=true)
                        @Valid String userName,
                        @NotNull @Valid @PathVariable(value="sessionId",required=true)
                        @NotNull @Valid String sessionId)