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

Interface PhysicalConnectionRestOpenApi

All Known Implementing Classes:

PhysicalConnectionRestController

@RequestMapping("/v2.1.1/physical-connections/")
public interface PhysicalConnectionRestOpenApi

Swagger documentation for physical connections.

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	createPhysicalConnection(@NotNull @Valid String aObjectClassName, @NotNull @Valid String aObjectId, @Valid String bObjectClassName, @Valid String bObjectId, @Valid String name, @Valid String connectionClassName, @Valid String templateId, @Valid String userName, @NotNull @Valid String sessionId)
void	deletePhysicalConnection(@NotNull @Valid String objectClassName, @NotNull @Valid String objectId, @Valid String userName, @NotNull @Valid String sessionId)
List<BusinessObjectLight>	getPhysicalPath(@NotNull @Valid String objectClassName, @NotNull @Valid String objectId, @NotNull @Valid String sessionId)
HashMap<BusinessObjectLight,List<BusinessObjectLight>>	getPhysicalTree(@NotNull @Valid String objectClassName, @NotNull @Valid String objectId, @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

createPhysicalConnection

@RequestMapping(method=POST,
                value="createPhysicalConnection/{aObjectClassName}/{aObjectId}/{bObjectClassName}/{bObjectId}/{name}/{connectionClassName}/{templateId}/{userName}/{sessionId}",
                produces="application/json")
String createPhysicalConnection(@NotNull @Valid @PathVariable(value="aObjectClassName",required=true)
                                @NotNull @Valid String aObjectClassName,
                                @NotNull @Valid @PathVariable(value="aObjectId",required=true)
                                @NotNull @Valid String aObjectId,
                                @Valid @PathVariable(value="bObjectClassName",required=true)
                                @Valid String bObjectClassName,
                                @Valid @PathVariable(value="bObjectId",required=true)
                                @Valid String bObjectId,
                                @Valid @PathVariable(value="name",required=true)
                                @Valid String name,
                                @Valid @PathVariable(value="connectionClassName",required=true)
                                @Valid String connectionClassName,
                                @Valid @PathVariable(value="templateId",required=true)
                                @Valid String templateId,
                                @Valid @PathVariable(value="userName",required=true)
                                @Valid String userName,
                                @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                @NotNull @Valid String sessionId)

deletePhysicalConnection

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

getPhysicalPath

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

getPhysicalTree

@RequestMapping(method=GET,
                value="getPhysicalTree/{objectClassName}/{objectId}/{sessionId}",
                produces="application/json")
HashMap<BusinessObjectLight,List<BusinessObjectLight>> getPhysicalTree(@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)