org.opendaylight.sfc.provider

Class SfcProviderRpc

java.lang.Object

org.opendaylight.sfc.provider.SfcProviderRpc

All Implemented Interfaces:

ServicePathIdService, RenderedServicePathService, ServiceFunctionService, ServiceFunctionChainService, org.opendaylight.yangtools.yang.binding.RpcService

public class SfcProviderRpc
extends Object
implements ServiceFunctionService, ServiceFunctionChainService, RenderedServicePathService, ServicePathIdService

This class holds all RPCs methods for SFC Provider.

Since:

2014-06-30

Version:

0.1

Author:

Reinaldo Penno (rapenno@gmail.com), Konstantin Blagov (blagov.sk@hotmail.com)

Constructor Summary

Constructors

Constructor and Description
SfcProviderRpc(org.opendaylight.controller.md.sal.binding.api.DataBroker dataBroker)

Method Summary

Modifier and Type	Method and Description
Future<org.opendaylight.yangtools.yang.common.RpcResult<AllocatePathIdOutput>>	allocatePathId(AllocatePathIdInput input) Allocate a path-id
Future<org.opendaylight.yangtools.yang.common.RpcResult<CreateRenderedPathOutput>>	createRenderedPath(CreateRenderedPathInput createRenderedPathInput) Created a Rendered Service Path
Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>>	deleteAllServiceFunction() Deletes all service functions
Future<org.opendaylight.yangtools.yang.common.RpcResult<DeletePathIdOutput>>	deletePathId(DeletePathIdInput input) Delete a Path Id
Future<org.opendaylight.yangtools.yang.common.RpcResult<DeleteRenderedPathOutput>>	deleteRenderedPath(DeleteRenderedPathInput input) Remove RSP from all the operational state.
Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>>	deleteServiceFunction(DeleteServiceFunctionInput input) Deletes a service function
Future<org.opendaylight.yangtools.yang.common.RpcResult<InstantiateServiceFunctionChainOutput>>	instantiateServiceFunctionChain(InstantiateServiceFunctionChainInput input) Instantiates a single service function
Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>>	putServiceFunction(PutServiceFunctionInput input) Creates a service function
Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>>	putServiceFunctionChains(PutServiceFunctionChainsInput input) Creates Service-Functions
Future<org.opendaylight.yangtools.yang.common.RpcResult<ReadPathIdOutput>>	readPathId(ReadPathIdInput input) Read all the necessary information for the first hop of a Rendered Service Path
Future<org.opendaylight.yangtools.yang.common.RpcResult<ReadRenderedServicePathFirstHopOutput>>	readRenderedServicePathFirstHop(ReadRenderedServicePathFirstHopInput input) This method gets all necessary information for a system to construct a NSH header and associated overlay packet to target the first service hop of a Rendered Service Path.
Future<org.opendaylight.yangtools.yang.common.RpcResult<ReadRspFirstHopBySftListOutput>>	readRspFirstHopBySftList(ReadRspFirstHopBySftListInput input) This method reads all the necessary information for the first hop of a Rendered Service Path by ServiceFunctionTypeIdentity list.
Future<org.opendaylight.yangtools.yang.common.RpcResult<ReadServiceFunctionOutput>>	readServiceFunction(ReadServiceFunctionInput input) Reads a service function
Future<org.opendaylight.yangtools.yang.common.RpcResult<ReservePathIdRangeOutput>>	reservePathIdRange(ReservePathIdRangeInput input) Reserve a path-id range
Future<org.opendaylight.yangtools.yang.common.RpcResult<SetGenerationAlgorithmOutput>>	setGenerationAlgorithm(SetGenerationAlgorithmInput input) Set the path-id generation algorithm to be used
Future<org.opendaylight.yangtools.yang.common.RpcResult<TraceRenderedServicePathOutput>>	traceRenderedServicePath(TraceRenderedServicePathInput input) Requests a NSH Traceroute through the specified rendered service path

Methods inherited from class java.lang.Object

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

Constructor Detail

SfcProviderRpc

public SfcProviderRpc(org.opendaylight.controller.md.sal.binding.api.DataBroker dataBroker)

Method Detail

deleteAllServiceFunction

public Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>> deleteAllServiceFunction()

Description copied from interface: ServiceFunctionService

Deletes all service functions

Specified by:

deleteAllServiceFunction in interface ServiceFunctionService

deleteServiceFunction

public Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>> deleteServiceFunction(DeleteServiceFunctionInput input)

Description copied from interface: ServiceFunctionService

Deletes a service function

Specified by:

deleteServiceFunction in interface ServiceFunctionService

putServiceFunction

public Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>> putServiceFunction(PutServiceFunctionInput input)

Description copied from interface: ServiceFunctionService

Creates a service function

Specified by:

putServiceFunction in interface ServiceFunctionService

readServiceFunction

public Future<org.opendaylight.yangtools.yang.common.RpcResult<ReadServiceFunctionOutput>> readServiceFunction(ReadServiceFunctionInput input)

Description copied from interface: ServiceFunctionService

Reads a service function

Specified by:

readServiceFunction in interface ServiceFunctionService

instantiateServiceFunctionChain

public Future<org.opendaylight.yangtools.yang.common.RpcResult<InstantiateServiceFunctionChainOutput>> instantiateServiceFunctionChain(InstantiateServiceFunctionChainInput input)

Description copied from interface: ServiceFunctionChainService

Instantiates a single service function

Specified by:

instantiateServiceFunctionChain in interface ServiceFunctionChainService

putServiceFunctionChains

public Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>> putServiceFunctionChains(PutServiceFunctionChainsInput input)

Description copied from interface: ServiceFunctionChainService

Creates Service-Functions

Specified by:

putServiceFunctionChains in interface ServiceFunctionChainService

createRenderedPath

public Future<org.opendaylight.yangtools.yang.common.RpcResult<CreateRenderedPathOutput>> createRenderedPath(CreateRenderedPathInput createRenderedPathInput)

Description copied from interface: RenderedServicePathService

Created a Rendered Service Path

Specified by:

createRenderedPath in interface RenderedServicePathService

deleteRenderedPath

public Future<org.opendaylight.yangtools.yang.common.RpcResult<DeleteRenderedPathOutput>> deleteRenderedPath(DeleteRenderedPathInput input)

Remove RSP from all the operational state.

Specified by:

deleteRenderedPath in interface RenderedServicePathService

Parameters:

input - schema path rendered-service-path/delete-rendered-path/input

Returns:

RPC output

readRenderedServicePathFirstHop

public Future<org.opendaylight.yangtools.yang.common.RpcResult<ReadRenderedServicePathFirstHopOutput>> readRenderedServicePathFirstHop(ReadRenderedServicePathFirstHopInput input)

This method gets all necessary information for a system to construct a NSH header and associated overlay packet to target the first service hop of a Rendered Service Path.

Specified by:

readRenderedServicePathFirstHop in interface RenderedServicePathService

Parameters:

input - RPC input including a Rendered Service Path name

Returns:

RPC output including a renderedServicePathFirstHop.

readRspFirstHopBySftList

public Future<org.opendaylight.yangtools.yang.common.RpcResult<ReadRspFirstHopBySftListOutput>> readRspFirstHopBySftList(ReadRspFirstHopBySftListInput input)

This method reads all the necessary information for the first hop of a Rendered Service Path by ServiceFunctionTypeIdentity list.

Specified by:

readRspFirstHopBySftList in interface RenderedServicePathService

Parameters:

input - RPC input including a ServiceFunctionTypeIdentity list

Returns:

RPC output including a renderedServicePathFirstHop.

traceRenderedServicePath

public Future<org.opendaylight.yangtools.yang.common.RpcResult<TraceRenderedServicePathOutput>> traceRenderedServicePath(TraceRenderedServicePathInput input)

Description copied from interface: RenderedServicePathService

Requests a NSH Traceroute through the specified rendered service path

Specified by:

traceRenderedServicePath in interface RenderedServicePathService

reservePathIdRange

public Future<org.opendaylight.yangtools.yang.common.RpcResult<ReservePathIdRangeOutput>> reservePathIdRange(ReservePathIdRangeInput input)

Description copied from interface: ServicePathIdService

Reserve a path-id range

Specified by:

reservePathIdRange in interface ServicePathIdService

readPathId

public Future<org.opendaylight.yangtools.yang.common.RpcResult<ReadPathIdOutput>> readPathId(ReadPathIdInput input)

Description copied from interface: ServicePathIdService

Read all the necessary information for the first hop of a Rendered Service Path

Specified by:

readPathId in interface ServicePathIdService

allocatePathId

public Future<org.opendaylight.yangtools.yang.common.RpcResult<AllocatePathIdOutput>> allocatePathId(AllocatePathIdInput input)

Description copied from interface: ServicePathIdService

Allocate a path-id

Specified by:

allocatePathId in interface ServicePathIdService

deletePathId

public Future<org.opendaylight.yangtools.yang.common.RpcResult<DeletePathIdOutput>> deletePathId(DeletePathIdInput input)

Description copied from interface: ServicePathIdService

Delete a Path Id

Specified by:

deletePathId in interface ServicePathIdService

setGenerationAlgorithm

public Future<org.opendaylight.yangtools.yang.common.RpcResult<SetGenerationAlgorithmOutput>> setGenerationAlgorithm(SetGenerationAlgorithmInput input)

Description copied from interface: ServicePathIdService

Set the path-id generation algorithm to be used

Specified by:

setGenerationAlgorithm in interface ServicePathIdService