com.hp.ov.sdk.rest.client

Class ConnectionTemplateClientImpl

java.lang.Object

com.hp.ov.sdk.rest.client.ConnectionTemplateClientImpl

All Implemented Interfaces:

ConnectionTemplateClient

public class ConnectionTemplateClientImpl
extends Object
implements ConnectionTemplateClient

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ConnectionTemplateClientImpl(ConnectionTemplateAdaptor adaptor)

Method Summary

Modifier and Type	Method and Description
ConnectionTemplateCollection	getAllConnectionTemplates(RestParams params) The module aids in fetching the connection template details for all networks found under the current HPE OneView.
static ConnectionTemplateClient	getClient()
ConnectionTemplate	getConnectionTemplate(RestParams params, String resourceId) The module aids in fetching the connection template when provided with the ConnectionTemplate resource identifier.
ConnectionTemplate	getConnectionTemplateByName(RestParams params, String resourceName) The module aids in fetching the connection template when provided with the connection template name.
ConnectionTemplate	getDefaultConnectionTemplateForConnectionTemplate(RestParams params) The module aids in fetching the default connection template details for the network found under the current HPE OneView.
String	getId(RestParams params, String name) The module aids in fetching the connection template resource identifier for the connection template name as specified in HPE OneView.
ConnectionTemplate	updateConnectionTemplate(RestParams params, String resourceId, ConnectionTemplate connectionTemplateDto, boolean useJsonRequest) The module takes in a ConnectionTemplate object or JsonRequest and updates the existing connection template based on the resource identifier.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConnectionTemplateClientImpl

protected ConnectionTemplateClientImpl(ConnectionTemplateAdaptor adaptor)

Method Detail

getClient

public static ConnectionTemplateClient getClient()

getConnectionTemplate

public ConnectionTemplate getConnectionTemplate(RestParams params,
                                                String resourceId)

Description copied from interface: ConnectionTemplateClient

The module aids in fetching the connection template when provided with the ConnectionTemplate resource identifier.

Specified by:

getConnectionTemplate in interface ConnectionTemplateClient

Parameters:

params - The RestParams is a structure containing the connection details.

resourceId - The resource identifier for the connection template as seen in HPE OneView.

Returns:

ConnectionTemplate containing the connection template details.

getConnectionTemplateByName

public ConnectionTemplate getConnectionTemplateByName(RestParams params,
                                                      String resourceName)

Description copied from interface: ConnectionTemplateClient

The module aids in fetching the connection template when provided with the connection template name.

Specified by:

getConnectionTemplateByName in interface ConnectionTemplateClient

Parameters:

params - The RestParams is a structure containing the connection details.

resourceName - The resourceName is the connection template name as seen in HPE OneView.

Returns:

ConnectionTemplate containing the connection template details.

updateConnectionTemplate

public ConnectionTemplate updateConnectionTemplate(RestParams params,
                                                   String resourceId,
                                                   ConnectionTemplate connectionTemplateDto,
                                                   boolean useJsonRequest)

Description copied from interface: ConnectionTemplateClient

The module takes in a ConnectionTemplate object or JsonRequest and updates the existing connection template based on the resource identifier.

Specified by:

updateConnectionTemplate in interface ConnectionTemplateClient

Parameters:

params - The RestParams is a structure containing the connection details.

resourceId - The resource identifier for the connection template as seen in HPE OneView.

connectionTemplateDto - This is a object containing the update to be made to an existing ConnectionTemplate pointed to by the above mentioned resource identifier.

useJsonRequest - The JsonRequest body is part of ConnectionTemplate Object which takes in a String containing the update to be made, which is converted to ConnectionTemplate Object using adaptor and processed.

Returns:

ConnectionTemplate containing the updated connection template details.

getAllConnectionTemplates

public ConnectionTemplateCollection getAllConnectionTemplates(RestParams params)

Description copied from interface: ConnectionTemplateClient

The module aids in fetching the connection template details for all networks found under the current HPE OneView.

Specified by:

getAllConnectionTemplates in interface ConnectionTemplateClient

Parameters:

params - The RestParams is a structure containing the connection details.

Returns:

ConnectionTemplateCollection containing the collection of connection template details.

getDefaultConnectionTemplateForConnectionTemplate

public ConnectionTemplate getDefaultConnectionTemplateForConnectionTemplate(RestParams params)

Description copied from interface: ConnectionTemplateClient

The module aids in fetching the default connection template details for the network found under the current HPE OneView.

Specified by:

getDefaultConnectionTemplateForConnectionTemplate in interface ConnectionTemplateClient

Parameters:

params - The RestParams is a structure containing the connection details.

Returns:

ConnectionTemplate containing the connection template details.

getId

public String getId(RestParams params,
                    String name)

Description copied from interface: ConnectionTemplateClient

The module aids in fetching the connection template resource identifier for the connection template name as specified in HPE OneView.

Specified by:

getId in interface ConnectionTemplateClient

Parameters:

params - The RestParams is a structure containing the connection details.

name - The name is the connection template name as seen in HPE OneView.

Returns:

String which is the resource identifier for the connection template name as seen in HPE OneView.