com.hp.ov.sdk.rest.client

Class LogicalSwitchClientImpl

java.lang.Object

com.hp.ov.sdk.rest.client.LogicalSwitchClientImpl

All Implemented Interfaces:

LogicalSwitchClient

public class LogicalSwitchClientImpl
extends Object
implements LogicalSwitchClient

Constructor Summary

Constructors

Constructor and Description
LogicalSwitchClientImpl(HttpRestClient restClient, ResourceAdaptor adaptor, TaskMonitorManager taskMonitor)

Method Summary

Modifier and Type	Method and Description
TaskResourceV2	createLogicalSwitch(RestParams params, AddLogicalSwitch addLogicalSwitch, boolean aSync) Creates a logical switch according to the provided LogicalSwitch object.
TaskResourceV2	deleteLogicalSwitch(RestParams params, String resourceId, boolean aSync) Removes a logical switch identified by the provided resource identifier.
LogicalSwitchCollection	getAllLogicalSwitches(RestParams params) Retrieves the logical switch details for all the logical switches under the current HPE OneView.
static LogicalSwitchClientImpl	getClient()
String	getId(RestParams params, String name) Retrieves the logical switch resource identifier for the specified logical switch name.
LogicalSwitch	getLogicalSwitch(RestParams params, String resourceId) Retrieves the LogicalSwitch details for the specified logical switch resource identifier.
LogicalSwitch	getLogicalSwitchByName(RestParams params, String name) Retrieves the LogicalSwitch details for the specified logical switch name.
TaskResourceV2	refreshLogicalSwitch(RestParams params, String resourceId, boolean aSync) Executes a refresh action for a logical switch identified by the provided resource identifier.
TaskResourceV2	updateLogicalSwitch(RestParams params, String resourceId, AddLogicalSwitch addLogicalSwitch, boolean aSync) Updates a logical switch according to the provided LogicalSwitch object.

Methods inherited from class java.lang.Object

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

Constructor Detail

LogicalSwitchClientImpl

public LogicalSwitchClientImpl(HttpRestClient restClient,
                               ResourceAdaptor adaptor,
                               TaskMonitorManager taskMonitor)

Method Detail

getClient

public static LogicalSwitchClientImpl getClient()

getLogicalSwitch

public LogicalSwitch getLogicalSwitch(RestParams params,
                                      String resourceId)

Description copied from interface: LogicalSwitchClient

Retrieves the LogicalSwitch details for the specified logical switch resource identifier.

Specified by:

getLogicalSwitch in interface LogicalSwitchClient

Parameters:

params - structure containing the connection details.

resourceId - logical switch identifier as seen in HPE OneView.

Returns:

LogicalSwitch object containing the details.

getLogicalSwitchByName

public LogicalSwitch getLogicalSwitchByName(RestParams params,
                                            String name)

Description copied from interface: LogicalSwitchClient

Retrieves the LogicalSwitch details for the specified logical switch name.

Specified by:

getLogicalSwitchByName in interface LogicalSwitchClient

Parameters:

params - structure containing the connection details.

name - logical switch name as seen in HPE OneView.

Returns:

LogicalSwitch object containing the details.

getAllLogicalSwitches

public LogicalSwitchCollection getAllLogicalSwitches(RestParams params)

Description copied from interface: LogicalSwitchClient

Retrieves the logical switch details for all the logical switches under the current HPE OneView.

Specified by:

getAllLogicalSwitches in interface LogicalSwitchClient

Parameters:

params - structure containing the connection details.

Returns:

LogicalSwitchCollection object containing the details for all the logical switches found in HPE OneView.

createLogicalSwitch

public TaskResourceV2 createLogicalSwitch(RestParams params,
                                          AddLogicalSwitch addLogicalSwitch,
                                          boolean aSync)

Description copied from interface: LogicalSwitchClient

Creates a logical switch according to the provided LogicalSwitch object. The request can be processed asynchronously or synchronously.

Specified by:

createLogicalSwitch in interface LogicalSwitchClient

Parameters:

params - structure containing the connection details.

addLogicalSwitch - object containing the logical switch details.

aSync - flag to indicate whether the request should be processed asynchronously or synchronously.

Returns:

TaskResourceV2 containing the task status for the process.

updateLogicalSwitch

public TaskResourceV2 updateLogicalSwitch(RestParams params,
                                          String resourceId,
                                          AddLogicalSwitch addLogicalSwitch,
                                          boolean aSync)

Description copied from interface: LogicalSwitchClient

Updates a logical switch according to the provided LogicalSwitch object. The request can be processed asynchronously or synchronously.

Specified by:

updateLogicalSwitch in interface LogicalSwitchClient

Parameters:

params - structure containing the connection details.

resourceId - logical switch identifier as seen in HPE OneView.

addLogicalSwitch - object containing the logical switch details.

aSync - flag to indicate whether the request should be processed asynchronously or synchronously.

Returns:

TaskResourceV2 containing the task status for the process.

deleteLogicalSwitch

public TaskResourceV2 deleteLogicalSwitch(RestParams params,
                                          String resourceId,
                                          boolean aSync)

Description copied from interface: LogicalSwitchClient

Removes a logical switch identified by the provided resource identifier. The request can be processed asynchronously or synchronously.

Specified by:

deleteLogicalSwitch in interface LogicalSwitchClient

Parameters:

params - structure containing the connection details.

resourceId - logical switch identifier as seen in HPE OneView.

aSync - flag to indicate whether the request should be processed asynchronously or synchronously.

Returns:

TaskResourceV2 containing the task status for the process.

refreshLogicalSwitch

public TaskResourceV2 refreshLogicalSwitch(RestParams params,
                                           String resourceId,
                                           boolean aSync)

Description copied from interface: LogicalSwitchClient

Executes a refresh action for a logical switch identified by the provided resource identifier. The request can be processed asynchronously or synchronously.

Specified by:

refreshLogicalSwitch in interface LogicalSwitchClient

Parameters:

params - structure containing the connection details.

resourceId - logical switch identifier as seen in HPE OneView.

aSync - flag to indicate whether the request should be processed asynchronously or synchronously.

Returns:

TaskResourceV2 containing the task status for the process.

getId

public String getId(RestParams params,
                    String name)

Description copied from interface: LogicalSwitchClient

Retrieves the logical switch resource identifier for the specified logical switch name.

Specified by:

getId in interface LogicalSwitchClient

Parameters:

params - structure containing the connection details.

name - logical switch name as seen in HPE OneView.

Returns:

the resource identifier for the logical switch.