org.opendaylight.usc.plugin

Class UscPlugin

java.lang.Object

org.opendaylight.usc.plugin.UscPlugin

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

UscPluginTcp, UscPluginUdp

public abstract class UscPlugin
extends Object
implements AutoCloseable

This is the base class for all UscPlugin classes. This handles common connection setup and channel/session management capabilities.

Field Summary

Fields

Modifier and Type	Field and Description
static io.netty.util.AttributeKey<UscChannelImpl>	CHANNEL Constant used for setting the UscChannel attribute on a netty channel.
static io.netty.util.AttributeKey<io.netty.channel.Channel>	CLIENT_CHANNEL Constant used for setting the client channel attribute on a server channel
static io.netty.util.AttributeKey<io.netty.channel.Channel>	DIRECT_CHANNEL Constant used for setting the next direct channel between the plugin and device
static io.netty.util.AttributeKey<io.netty.channel.local.LocalChannel>	LOCAL_SERVER_CHANNEL
static io.netty.util.AttributeKey<UscRouteIdentifier>	ROUTE_IDENTIFIER Constant used for setting the UscDevice attribute on a server channel
static io.netty.util.AttributeKey<com.google.common.util.concurrent.SettableFuture<UscSessionImpl>>	SESSION Constant used for setting the UscSession attribute on a netty channel.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UscPlugin(io.netty.channel.local.LocalAddress localAddr)

Method Summary

Modifier and Type	Method and Description
protected void	addCallHomeConnection(InetSocketAddress address, io.netty.channel.Channel channel)
void	close()
com.google.common.util.concurrent.SettableFuture<Boolean>	closeAgentInternalConnection(io.netty.channel.Channel clientChannel)
io.netty.channel.ChannelFuture	connect(io.netty.bootstrap.Bootstrap clientBootstrap, InetSocketAddress address) Initiates a client session to a device service as specified by the address parameter.
io.netty.channel.ChannelFuture	connect(io.netty.bootstrap.Bootstrap clientBootstrap, InetSocketAddress address, boolean remote)
protected abstract io.netty.channel.Channel	connectToAgent(UscDevice device)
protected abstract io.netty.channel.Channel	connectToDeviceDirectly(UscDevice device)
protected abstract UscChannel.ChannelType	getChannelType()
protected ConcurrentMap<io.netty.channel.Channel,com.google.common.util.concurrent.SettableFuture<Boolean>>	getCloseFuture()
protected UscConnectionManager	getConnectionManager()
protected UscDemultiplexer	getDemultiplexer()
protected Demultiplexer	getDmpx()
protected abstract io.netty.channel.ChannelInboundHandler	getFrameDecoder()
protected abstract io.netty.channel.ChannelOutboundHandler	getFrameEncoder()
protected io.netty.channel.ChannelInboundHandler	getMultiplexer()
protected void	initAgentPipeline(io.netty.channel.ChannelPipeline p, io.netty.channel.ChannelHandler securityHandler)
protected void	initDirectPipeline(io.netty.channel.ChannelPipeline p, io.netty.channel.ChannelHandler securityHandler)
boolean	isChannelAvailable(InetSocketAddress address)
UscChannelImpl	retrieveChannelImpl(InetSocketAddress address)
void	sendEvent(UscEvent event) send event to monitor service using monitor

Methods inherited from class java.lang.Object

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

Field Detail

CHANNEL

public static final io.netty.util.AttributeKey<UscChannelImpl> CHANNEL

Constant used for setting the UscChannel attribute on a netty channel.

SESSION

public static final io.netty.util.AttributeKey<com.google.common.util.concurrent.SettableFuture<UscSessionImpl>> SESSION

Constant used for setting the UscSession attribute on a netty channel.

CLIENT_CHANNEL

public static final io.netty.util.AttributeKey<io.netty.channel.Channel> CLIENT_CHANNEL

Constant used for setting the client channel attribute on a server channel

ROUTE_IDENTIFIER

public static final io.netty.util.AttributeKey<UscRouteIdentifier> ROUTE_IDENTIFIER

Constant used for setting the UscDevice attribute on a server channel

DIRECT_CHANNEL

public static final io.netty.util.AttributeKey<io.netty.channel.Channel> DIRECT_CHANNEL

Constant used for setting the next direct channel between the plugin and device

LOCAL_SERVER_CHANNEL

public static final io.netty.util.AttributeKey<io.netty.channel.local.LocalChannel> LOCAL_SERVER_CHANNEL

Constructor Detail

UscPlugin

protected UscPlugin(io.netty.channel.local.LocalAddress localAddr)

Method Detail

initAgentPipeline

protected void initAgentPipeline(io.netty.channel.ChannelPipeline p,
                                 io.netty.channel.ChannelHandler securityHandler)

initDirectPipeline

protected void initDirectPipeline(io.netty.channel.ChannelPipeline p,
                                  io.netty.channel.ChannelHandler securityHandler)

getMultiplexer

protected io.netty.channel.ChannelInboundHandler getMultiplexer()

getDemultiplexer

protected UscDemultiplexer getDemultiplexer()

getDmpx

protected Demultiplexer getDmpx()

getConnectionManager

protected UscConnectionManager getConnectionManager()

getFrameEncoder

protected abstract io.netty.channel.ChannelOutboundHandler getFrameEncoder()

getFrameDecoder

protected abstract io.netty.channel.ChannelInboundHandler getFrameDecoder()

connect

public io.netty.channel.ChannelFuture connect(io.netty.bootstrap.Bootstrap clientBootstrap,
                                              InetSocketAddress address)
                                       throws InterruptedException,
                                              ExecutionException,
                                              Exception

Initiates a client session to a device service as specified by the address parameter.

Parameters:

clientBootstrap - the Netty bootstrap to use to create the session

address - the IP address and port of the device service

Returns:

the Netty ChannelFuture that can be used to communicate with the device service

Throws:

InterruptedException

ExecutionException

Exception

connect

public io.netty.channel.ChannelFuture connect(io.netty.bootstrap.Bootstrap clientBootstrap,
                                              InetSocketAddress address,
                                              boolean remote)
                                       throws InterruptedException,
                                              ExecutionException,
                                              Exception

Throws:

InterruptedException

ExecutionException

Exception

getChannelType

protected abstract UscChannel.ChannelType getChannelType()

connectToAgent

protected abstract io.netty.channel.Channel connectToAgent(UscDevice device)
                                                    throws InterruptedException,
                                                           Exception

Throws:

InterruptedException

Exception

connectToDeviceDirectly

protected abstract io.netty.channel.Channel connectToDeviceDirectly(UscDevice device)
                                                             throws InterruptedException,
                                                                    Exception

Throws:

InterruptedException

Exception

close

public void close()

Specified by:

close in interface AutoCloseable

addCallHomeConnection

protected void addCallHomeConnection(InetSocketAddress address,
                                     io.netty.channel.Channel channel)

getCloseFuture

protected ConcurrentMap<io.netty.channel.Channel,com.google.common.util.concurrent.SettableFuture<Boolean>> getCloseFuture()

sendEvent

public void sendEvent(UscEvent event)

send event to monitor service using monitor

Parameters:

event - event object

closeAgentInternalConnection

public com.google.common.util.concurrent.SettableFuture<Boolean> closeAgentInternalConnection(io.netty.channel.Channel clientChannel)

Parameters:

clientChannel -

Returns:

close status

isChannelAvailable

public boolean isChannelAvailable(InetSocketAddress address)

retrieveChannelImpl

public UscChannelImpl retrieveChannelImpl(InetSocketAddress address)