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

Interface ServiceRestOpenApi

All Known Implementing Classes:

ServiceRestController

@RequestMapping("/v2.1.1/service-manager/")
public interface ServiceRestOpenApi

Swagger documentation for service 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	createCustomer(@NotNull @Valid String poolId, @NotNull @Valid String customerClassName, @Valid HashMap<String,String> attributes, @Valid String userName, @NotNull @Valid String sessionId)
String	createCustomerPool(@NotNull @Valid String poolName, @NotNull @Valid String poolDescription, @Valid String userName, @NotNull @Valid String sessionId)
String	createService(@NotNull @Valid String poolId, @NotNull @Valid String serviceClassName, @Valid HashMap<String,String> attributes, @Valid String userName, @NotNull @Valid String sessionId)
String	createServicePool(@NotNull @Valid String customerClassName, @NotNull @Valid String customerId, @NotNull @Valid String poolName, @NotNull @Valid String poolDescription, @Valid String userName, @NotNull @Valid String sessionId)
void	deleteCostumer(@NotNull @Valid String customerClassName, @NotNull @Valid String customerId, @Valid String userName, @NotNull @Valid String sessionId)
void	deleteCustomerPool(@NotNull @Valid String poolId, @NotNull @Valid String poolClassName, @Valid String userName, @NotNull @Valid String sessionId)
void	deleteService(@NotNull @Valid String serviceClassName, @NotNull @Valid String serviceId, @Valid String userName, @NotNull @Valid String sessionId)
void	deleteServicePool(@NotNull @Valid String poolId, @NotNull @Valid String poolClassName, @Valid String userName, @NotNull @Valid String sessionId)
List<BusinessObjectLight>	getAllCustomers(@Valid HashMap<String,String> filters, @javax.validation.constraints.NotNull,@javax.validation.Valid long page, @javax.validation.constraints.NotNull,@javax.validation.Valid long limit, @NotNull @Valid String sessionId)
List<BusinessObjectLight>	getAllServices(@Valid HashMap<String,String> filters, @javax.validation.constraints.NotNull,@javax.validation.Valid long page, @javax.validation.constraints.NotNull,@javax.validation.Valid long limit, @NotNull @Valid String sessionId)
BusinessObject	getCustomer(@NotNull @Valid String customerClassName, @NotNull @Valid String customerId, @NotNull @Valid String sessionId)
InventoryObjectPool	getCustomerPool(@NotNull @Valid String poolId, @NotNull @Valid String poolClassName, @NotNull @Valid String sessionId)
List<InventoryObjectPool>	getCustomerPools(@NotNull @Valid String sessionId)
List<BusinessObjectLight>	getCustomersInPool(@NotNull @Valid String poolId, @NotNull @Valid String customerClassName, @javax.validation.constraints.NotNull,@javax.validation.Valid int page, @javax.validation.constraints.NotNull,@javax.validation.Valid int limit, @NotNull @Valid String sessionId)
List<BusinessObjectLight>	getObjectsRelatedToService(@NotNull @Valid String serviceClassName, @NotNull @Valid String serviceId, @NotNull @Valid String sessionId)
BusinessObject	getService(@NotNull @Valid String serviceClassName, @NotNull @Valid String serviceId, @NotNull @Valid String sessionId)
InventoryObjectPool	getServicePool(@NotNull @Valid String poolId, @NotNull @Valid String poolClassName, @NotNull @Valid String sessionId)
List<InventoryObjectPool>	getServicePoolsInCostumer(@NotNull @Valid String customerClassName, @NotNull @Valid String customerId, @NotNull @Valid String servicePoolClassName, @NotNull @Valid String sessionId)
List<BusinessObjectLight>	getServicesInPool(@NotNull @Valid String poolId, @NotNull @Valid String serviceClassName, @javax.validation.constraints.NotNull,@javax.validation.Valid int page, @javax.validation.constraints.NotNull,@javax.validation.Valid int limit, @NotNull @Valid String sessionId)
void	relateObjectsToService(@NotNull @Valid String[] objectsClassNames, @NotNull @Valid String[] objectsIds, @NotNull @Valid String serviceClassName, @NotNull @Valid String serviceId, @NotNull @Valid String userName, @NotNull @Valid String sessionId)
void	relateObjectToService(@NotNull @Valid String objectClassName, @NotNull @Valid String objectId, @NotNull @Valid String serviceClassName, @NotNull @Valid String serviceId, @NotNull @Valid String userName, @NotNull @Valid String sessionId)
void	releaseObjectFromService(@NotNull @Valid String serviceClassName, @NotNull @Valid String serviceId, @NotNull @Valid String objectId, @NotNull @Valid String userName, @NotNull @Valid String sessionId)
void	updateCustomer(@NotNull @Valid String customerClassName, @NotNull @Valid String customerId, @Valid HashMap<String,String> attributes, @Valid String userName, @NotNull @Valid String sessionId)
void	updateCustomerPool(@NotNull @Valid String poolId, @NotNull @Valid String poolClassName, @NotNull @Valid String poolName, @NotNull @Valid String poolDescription, @Valid String userName, @NotNull @Valid String sessionId)
void	updateService(@NotNull @Valid String serviceClassName, @NotNull @Valid String serviceId, @Valid HashMap<String,String> attributes, @Valid String userName, @NotNull @Valid String sessionId)
void	updateServicePool(@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

createCustomerPool

@RequestMapping(method=POST,
                value="createCustomerPool/{poolName}/{poolDescription}/{userName}/{sessionId}",
                produces="application/json")
String createCustomerPool(@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)

createCustomer

@RequestMapping(method=POST,
                value="createCustomer/{poolId}/{customerClassName}/{userName}/{sessionId}",
                produces="application/json")
String createCustomer(@NotNull @Valid @PathVariable(value="poolId",required=true)
                      @NotNull @Valid String poolId,
                      @NotNull @Valid @PathVariable(value="customerClassName",required=true)
                      @NotNull @Valid String customerClassName,
                      @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)

createServicePool

@RequestMapping(method=POST,
                value="createServicePool/{customerClassName}/{customerId}/{poolName}/{poolDescription}/{userName}/{sessionId}",
                produces="application/json")
String createServicePool(@NotNull @Valid @PathVariable(value="customerClassName",required=true)
                         @NotNull @Valid String customerClassName,
                         @NotNull @Valid @PathVariable(value="customerId",required=true)
                         @NotNull @Valid String customerId,
                         @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)

createService

@RequestMapping(method=POST,
                value="createService/{poolId}/{serviceClassName}/{userName}/{sessionId}",
                produces="application/json")
String createService(@NotNull @Valid @PathVariable(value="poolId",required=true)
                     @NotNull @Valid String poolId,
                     @NotNull @Valid @PathVariable(value="serviceClassName",required=true)
                     @NotNull @Valid String serviceClassName,
                     @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)

updateCustomerPool

@RequestMapping(method=PUT,
                value="updateCustomerPool/{poolId}/{poolClassName}/{poolName}/{poolDescription}/{userName}/{sessionId}",
                produces="application/json")
void updateCustomerPool(@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)

updateCustomer

@RequestMapping(method=PUT,
                value="updateCustomer/{customerClassName}/{customerId}/{userName}/{sessionId}",
                produces="application/json")
void updateCustomer(@NotNull @Valid @PathVariable(value="customerClassName",required=true)
                    @NotNull @Valid String customerClassName,
                    @NotNull @Valid @PathVariable(value="customerId",required=true)
                    @NotNull @Valid String customerId,
                    @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)

updateServicePool

@RequestMapping(method=PUT,
                value="updateServicePool/{poolId}/{poolClassName}/{poolName}/{poolDescription}/{userName}/{sessionId}",
                produces="application/json")
void updateServicePool(@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)

updateService

@RequestMapping(method=PUT,
                value="updateService/{serviceClassName}/{serviceId}/{userName}/{sessionId}",
                produces="application/json")
void updateService(@NotNull @Valid @PathVariable(value="serviceClassName",required=true)
                   @NotNull @Valid String serviceClassName,
                   @NotNull @Valid @PathVariable(value="serviceId",required=true)
                   @NotNull @Valid String serviceId,
                   @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)

deleteCustomerPool

@RequestMapping(method=DELETE,
                value="deleteCustomerPool/{poolId}/{poolClassName}/{userName}/{sessionId}",
                produces="application/json")
void deleteCustomerPool(@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)

deleteCostumer

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

deleteServicePool

@RequestMapping(method=DELETE,
                value="deleteServicePool/{poolId}/{poolClassName}/{userName}/{sessionId}",
                produces="application/json")
void deleteServicePool(@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)

deleteService

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

getCustomerPools

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

getCustomerPool

@RequestMapping(method=GET,
                value="getCustomerPool/{poolId}/{poolClassName}/{sessionId}",
                produces="application/json")
InventoryObjectPool getCustomerPool(@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)

getAllCustomers

@RequestMapping(method=POST,
                value="getAllCustomers/{page}/{limit}/{sessionId}",
                produces="application/json")
List<BusinessObjectLight> getAllCustomers(@Valid @RequestBody
                                          @Valid HashMap<String,String> filters,
                                          @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)

getCustomersInPool

@RequestMapping(method=GET,
                value="getCustomersInPool/{poolId}/{customerClassName}/{page}/{limit}/{sessionId}",
                produces="application/json")
List<BusinessObjectLight> getCustomersInPool(@NotNull @Valid @PathVariable(value="poolId",required=true)
                                             @NotNull @Valid String poolId,
                                             @NotNull @Valid @PathVariable(value="poolId",required=true)
                                             @NotNull @Valid String customerClassName,
                                             @NotNull @Valid @PathVariable(value="page",required=true)
                                             @javax.validation.constraints.NotNull,@javax.validation.Valid int page,
                                             @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)

getCustomer

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

getServicePoolsInCostumer

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

getServicePool

@RequestMapping(method=GET,
                value="getServicePool/{poolId}/{poolClassName}/{sessionId}",
                produces="application/json")
InventoryObjectPool getServicePool(@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)

getAllServices

@RequestMapping(method=POST,
                value="getAllServices/{page}/{limit}/{sessionId}",
                produces="application/json")
List<BusinessObjectLight> getAllServices(@Valid @RequestBody
                                         @Valid HashMap<String,String> filters,
                                         @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)

getServicesInPool

@RequestMapping(method=GET,
                value="getServicesInPool/{poolId}/{serviceClassName}/{page}/{limit}/{sessionId}",
                produces="application/json")
List<BusinessObjectLight> getServicesInPool(@NotNull @Valid @PathVariable(value="poolId",required=true)
                                            @NotNull @Valid String poolId,
                                            @NotNull @Valid @PathVariable(value="serviceClassName",required=true)
                                            @NotNull @Valid String serviceClassName,
                                            @NotNull @Valid @PathVariable(value="page",required=true)
                                            @javax.validation.constraints.NotNull,@javax.validation.Valid int page,
                                            @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)

getService

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

getObjectsRelatedToService

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

relateObjectToService

@RequestMapping(method=PUT,
                value="relateObjectToService/{objectClassName}/{objectId}/{serviceClassName}/{serviceId}/{userName}/{sessionId}",
                produces="application/json")
void relateObjectToService(@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="serviceClassName",required=true)
                           @NotNull @Valid String serviceClassName,
                           @NotNull @Valid @PathVariable(value="serviceId",required=true)
                           @NotNull @Valid String serviceId,
                           @NotNull @Valid @PathVariable(value="userName",required=true)
                           @NotNull @Valid String userName,
                           @NotNull @Valid @PathVariable(value="sessionId",required=true)
                           @NotNull @Valid String sessionId)

relateObjectsToService

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

releaseObjectFromService

@RequestMapping(method=PUT,
                value="releaseObjectFromService/{serviceClassName}/{serviceId}/{objectId}/{userName}/{sessionId}",
                produces="application/json")
void releaseObjectFromService(@NotNull @Valid @PathVariable(value="serviceClassName",required=true)
                              @NotNull @Valid String serviceClassName,
                              @NotNull @Valid @PathVariable(value="serviceId",required=true)
                              @NotNull @Valid String serviceId,
                              @NotNull @Valid @PathVariable(value="objectId",required=true)
                              @NotNull @Valid String objectId,
                              @NotNull @Valid @PathVariable(value="userName",required=true)
                              @NotNull @Valid String userName,
                              @NotNull @Valid @PathVariable(value="sessionId",required=true)
                              @NotNull @Valid String sessionId)