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

Interface SoftwareRestOpenApi

All Known Implementing Classes:

SoftwareRestController

@RequestMapping("/v2.1.1/software-manager/")
public interface SoftwareRestOpenApi

Swagger documentation for software 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	createLicense(@NotNull @Valid String poolId, @NotNull @Valid String licenseClassName, @Valid String licenseName, @Valid String licenseProduct, @Valid String userName, @NotNull @Valid String sessionId)
String	createLicensePool(@NotNull @Valid String poolName, @NotNull @Valid String poolDescription, @Valid String poolClassName, @Valid String userName, @NotNull @Valid String sessionId)
void	deleteLicense(@NotNull @Valid String licenseClassName, @NotNull @Valid String licenseId, @Valid String userName, @NotNull @Valid String sessionId)
void	deleteLicensePool(@NotNull @Valid String poolId, @NotNull @Valid String poolClassName, @Valid String userName, @NotNull @Valid String sessionId)
List<BusinessObjectLight>	getAllLicenses(@NotNull @Valid String sessionId)
List<ClassMetadataLight>	getAllLicenseTypes(@NotNull @Valid String sessionId)
List<BusinessObjectLight>	getAllProducts(@NotNull @Valid String sessionId)
BusinessObject	getLicense(@NotNull @Valid String licenseClassName, @NotNull @Valid String licenseId, @NotNull @Valid String sessionId)
InventoryObjectPool	getLicensePool(@NotNull @Valid String poolId, @NotNull @Valid String poolClassName, @NotNull @Valid String sessionId)
List<InventoryObjectPool>	getLicensePools(@NotNull @Valid String sessionId)
List<BusinessObjectLight>	getLicensesInPool(@NotNull @Valid String poolId, @javax.validation.constraints.NotNull,@javax.validation.Valid int limit, @NotNull @Valid String sessionId)
void	relateObjectToLicense(@NotNull @Valid String licenseClassName, @NotNull @Valid String licenseId, @NotNull @Valid String objectClassName, @NotNull @Valid String objectId, @NotNull @Valid String sessionId)
void	releaseLicense(@NotNull @Valid String licenseClassName, @NotNull @Valid String licenseId, @NotNull @Valid String sessionId)
void	releaseRelationship(@NotNull @Valid String sourceObjectClassName, @NotNull @Valid String sourceObjectId, @NotNull @Valid String targetObjectId, @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

createLicensePool

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

createLicense

@RequestMapping(method=POST,
                value="createLicense/{poolId}/{licenseClassName}/{licenseName}/{licenseProduct}/{userName}/{sessionId}",
                produces="application/json")
String createLicense(@NotNull @Valid @PathVariable(value="poolId",required=true)
                     @NotNull @Valid String poolId,
                     @NotNull @Valid @PathVariable(value="licenseClassName",required=true)
                     @NotNull @Valid String licenseClassName,
                     @Valid @PathVariable(value="licenseName",required=true)
                     @Valid String licenseName,
                     @Valid @PathVariable(value="licenseProduct",required=true)
                     @Valid String licenseProduct,
                     @Valid @PathVariable(value="userName",required=true)
                     @Valid String userName,
                     @NotNull @Valid @PathVariable(value="sessionId",required=true)
                     @NotNull @Valid String sessionId)

deleteLicensePool

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

deleteLicense

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

getLicensePools

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

getLicensePool

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

getAllLicenses

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

getLicensesInPool

@RequestMapping(method=GET,
                value="getLicensesInPool/{poolId}/{limit}/{sessionId}",
                produces="application/json")
List<BusinessObjectLight> getLicensesInPool(@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)

getLicense

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

getAllLicenseTypes

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

getAllProducts

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

relateObjectToLicense

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

releaseRelationship

@RequestMapping(method=PUT,
                value="releaseRelationship/{sourceObjectClassName}/{sourceObjectId}/{targetObjectId}/{sessionId}",
                produces="application/json")
void releaseRelationship(@NotNull @Valid @PathVariable(value="sourceObjectClassName",required=true)
                         @NotNull @Valid String sourceObjectClassName,
                         @NotNull @Valid @PathVariable(value="sourceObjectId",required=true)
                         @NotNull @Valid String sourceObjectId,
                         @NotNull @Valid @PathVariable(value="targetObjectId",required=true)
                         @NotNull @Valid String targetObjectId,
                         @NotNull @Valid @PathVariable(value="sessionId",required=true)
                         @NotNull @Valid String sessionId)

releaseLicense

@RequestMapping(method=PUT,
                value="releaseLicense/{licenseClassName}/{licenseId}/{sessionId}",
                produces="application/json")
void releaseLicense(@NotNull @Valid @PathVariable(value="licenseClassName",required=true)
                    @NotNull @Valid String licenseClassName,
                    @NotNull @Valid @PathVariable(value="licenseId",required=true)
                    @NotNull @Valid String licenseId,
                    @NotNull @Valid @PathVariable(value="sessionId",required=true)
                    @NotNull @Valid String sessionId)