Package org.opendaylight.bgpcep.programming.impl

Class ProgrammingServiceImpl

java.lang.Object

org.opendaylight.bgpcep.programming.impl.ProgrammingServiceImpl

All Implemented Interfaces:

AutoCloseable, InstructionScheduler, org.opendaylight.mdsal.singleton.common.api.ClusterSingletonService, ProgrammingService, org.opendaylight.yangtools.concepts.Identifiable<org.opendaylight.mdsal.singleton.common.api.ServiceGroupIdentifier>, org.opendaylight.yangtools.yang.binding.RpcService

public final class ProgrammingServiceImpl
extends Object
implements org.opendaylight.mdsal.singleton.common.api.ClusterSingletonService, InstructionScheduler, ProgrammingService

Method Summary

Modifier and Type	Method	Description
com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<CancelInstructionOutput>>	cancelInstruction(CancelInstructionInput input)	Invoke cancel-instruction RPC.
com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<CleanInstructionsOutput>>	cleanInstructions(CleanInstructionsInput input)	Invoke clean-instructions RPC.
void	close()
com.google.common.util.concurrent.FluentFuture<? extends org.opendaylight.mdsal.common.api.CommitInfo>	closeServiceInstance()
org.opendaylight.mdsal.singleton.common.api.ServiceGroupIdentifier	getIdentifier()
String	getInstructionID()	Returns InstructionID.
void	instantiateServiceInstance()
com.google.common.util.concurrent.ListenableFuture<Instruction>	scheduleInstruction(SubmitInstructionInput input)	Schedule a new instruction for execution.

Methods inherited from class java.lang.Object

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

Method Detail

instantiateServiceInstance

public void instantiateServiceInstance()

Specified by:

instantiateServiceInstance in interface org.opendaylight.mdsal.singleton.common.api.ClusterSingletonService

getIdentifier

public org.opendaylight.mdsal.singleton.common.api.ServiceGroupIdentifier getIdentifier()

Specified by:

getIdentifier in interface org.opendaylight.yangtools.concepts.Identifiable<org.opendaylight.mdsal.singleton.common.api.ServiceGroupIdentifier>

cancelInstruction

public com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<CancelInstructionOutput>> cancelInstruction(CancelInstructionInput input)

Description copied from interface: ProgrammingService

Invoke cancel-instruction RPC.

Specified by:

cancelInstruction in interface ProgrammingService

Parameters:

input - of cancel-instruction

Returns:

output of cancel-instruction

cleanInstructions

public com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<CleanInstructionsOutput>> cleanInstructions(CleanInstructionsInput input)

Description copied from interface: ProgrammingService

Invoke clean-instructions RPC.

     
         Attempt to clean out a certain set of instructions. Instructions flushed this
         way need to be in a terminal state, e.g. Successful, Failed or Cancelled.
         Instructions which were not cleaned are reported in the output of this RPC.
     
 

Specified by:

cleanInstructions in interface ProgrammingService

Parameters:

input - of clean-instructions

Returns:

output of clean-instructions

scheduleInstruction

public com.google.common.util.concurrent.ListenableFuture<Instruction> scheduleInstruction(SubmitInstructionInput input)
                                                                                    throws SchedulerException

Description copied from interface: InstructionScheduler

Schedule a new instruction for execution. This method tries to enqueue an instruction. It will return a Future which represents the scheduling progress. When the future becomes successful, the requestor is expected to start executing on the instruction, as specified by the Instruction contract.

Specified by:

scheduleInstruction in interface InstructionScheduler

Parameters:

input - Instruction scheduling information

Returns:

Scheduling future.

Throws:

SchedulerException - if a failure to schedule the instruction occurs.

getInstructionID

public String getInstructionID()

Description copied from interface: InstructionScheduler

Returns InstructionID.

Specified by:

getInstructionID in interface InstructionScheduler

Returns:

Instruction ID

closeServiceInstance

public com.google.common.util.concurrent.FluentFuture<? extends org.opendaylight.mdsal.common.api.CommitInfo> closeServiceInstance()

Specified by:

closeServiceInstance in interface org.opendaylight.mdsal.singleton.common.api.ClusterSingletonService

close

public void close()

Specified by:

close in interface AutoCloseable