org.rvpf.pap.dnp3

Class DNP3Context

Object

PAPContext

DNP3Context

Direct Known Subclasses:

DNP3MasterContext, DNP3OutstationContext

public abstract class DNP3Context
extends PAPContext

DNP3 context.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DNP3Context(Optional<Metadata> metadata, Optional<Traces> traces) Constructs an instance.

Method Summary

Modifier and Type	Method and Description
boolean	addRemoteOrigin(Origin remoteOrigin, Attributes originAttributes) Adds a remote origin.
boolean	addRemotePoint(Point remotePoint, Attributes pointAttributes) Adds a remote point.
protected int	getDefaultPortForRemoteOrigin() Gets the default port for a remote origin.
Optional<Point>	getPoint(PointType pointType, ObjectRange objectRange) Gets the point for a point type and object range.
String	getProtocolName() Gets the protocol name.
Collection<? extends DNP3Proxy>	getRemoteProxies() Gets all the remote proxies.
Optional<DNP3Proxy>	getRemoteProxyBySerialPortName(String serialPortName) Gets the remote proxy for the specified serial port name.
Optional<DNP3Proxy>	getRemoteProxyByTCPAddress(InetAddress address) Gets the remote proxy for the specified TCP address.
Optional<DNP3Proxy>	getRemoteProxyByUDPAddress(InetAddress address) Gets the remote proxy for the specified UDP address.
DNP3StationPoint	getRemoteStationPoint(Point point) Gets a remote station point.
LogicalDevice[]	logicalDevices(String[] logicalDeviceDecls, String endPointName) Returns logical devices from the declarations.
protected abstract DNP3Proxy	newRemoteProxy(Origin remoteOrigin) Returns a new remote proxy.

Methods inherited from class PAPContext

fetchMetadata, getMetadata, getRemoteOrigin, getRemotePoint, getRemotePoints, getRemoteProxy, getRemoteProxyByOrigin, getRemoteProxyByOrigin, getSupport, getThisLogger, getTraces, getValueFilters, hasLogged, isClientContext, isPointActive, isRemoteOriginNeeded, isRemotePointNeeded, isServerContext, registerRemotePoint, registerRemoteProxy, setUp, tearDown

Methods inherited from class Object

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

Constructor Detail

DNP3Context

protected DNP3Context(@Nonnull
                      Optional<Metadata> metadata,
                      @Nonnull
                      Optional<Traces> traces)

Constructs an instance.

Parameters:

metadata - The optional metadata.

traces - The traces (optional).

Method Detail

addRemoteOrigin

public boolean addRemoteOrigin(Origin remoteOrigin,
                               Attributes originAttributes)

Adds a remote origin.

Specified by:

addRemoteOrigin in class PAPContext

Parameters:

remoteOrigin - The remote origin.

originAttributes - The origin attributes.

Returns:

True on success.

addRemotePoint

public boolean addRemotePoint(Point remotePoint,
                              Attributes pointAttributes)

Adds a remote point.

Specified by:

addRemotePoint in class PAPContext

Parameters:

remotePoint - The remote point.

pointAttributes - The point attributes.

Returns:

True on success.

getPoint

@Nonnull
 @CheckReturnValue
public final Optional<Point> getPoint(@Nonnull
                                                                    PointType pointType,
                                                                    @Nonnull
                                                                    ObjectRange objectRange)

Gets the point for a point type and object range.

Parameters:

pointType - The point type.

objectRange - The object range for the point.

Returns:

The point (empty if unconfigured).

getProtocolName

public String getProtocolName()

Gets the protocol name.

Specified by:

getProtocolName in class PAPContext

Returns:

The protocol name.

getRemoteProxies

public Collection<? extends DNP3Proxy> getRemoteProxies()

Gets all the remote proxies.

Overrides:

getRemoteProxies in class PAPContext

Returns:

The remote proxies.

getRemoteProxyBySerialPortName

@Nonnull
 @CheckReturnValue
public final Optional<DNP3Proxy> getRemoteProxyBySerialPortName(@Nonnull
                                                                                              String serialPortName)

Gets the remote proxy for the specified serial port name.

Parameters:

serialPortName - The serial port name.

Returns:

The remote proxy (empty if unknown).

getRemoteProxyByTCPAddress

@Nonnull
 @CheckReturnValue
public final Optional<DNP3Proxy> getRemoteProxyByTCPAddress(@Nonnull
                                                                                          InetAddress address)

Gets the remote proxy for the specified TCP address.

Parameters:

address - The TCP address.

Returns:

The remote proxy (empty if unknown).

getRemoteProxyByUDPAddress

@Nonnull
 @CheckReturnValue
public final Optional<DNP3Proxy> getRemoteProxyByUDPAddress(@Nonnull
                                                                                          InetAddress address)

Gets the remote proxy for the specified UDP address.

Parameters:

address - The UDP address.

Returns:

The remote proxy (empty if unknown).

getRemoteStationPoint

@Nonnull
 @CheckReturnValue
public DNP3StationPoint getRemoteStationPoint(@Nonnull
                                                                            Point point)

Gets a remote station point.

Parameters:

point - A metadata point.

Returns:

The remote station point.

Throws:

IllegalArgumentException - When the station point is unknown.

logicalDevices

@Nullable
 @CheckReturnValue
public final LogicalDevice[] logicalDevices(@Nonnull
                                                                           String[] logicalDeviceDecls,
                                                                           @Nonnull
                                                                           String endPointName)

Returns logical devices from the declarations.

Parameters:

logicalDeviceDecls - The logical device declarations.

endPointName - The end point name.

Returns:

The logical devices (null on failure).

getDefaultPortForRemoteOrigin

protected int getDefaultPortForRemoteOrigin()

Gets the default port for a remote origin.

Overrides:

getDefaultPortForRemoteOrigin in class PAPContext

Returns:

The default port for a remote origin.

newRemoteProxy

protected abstract DNP3Proxy newRemoteProxy(Origin remoteOrigin)

Returns a new remote proxy.

Specified by:

newRemoteProxy in class PAPContext

Parameters:

remoteOrigin - The remote origin for the proxy.

Returns:

The new remote proxy.