org.rvpf.pap

Class PAPProxy

Object

PAPProxy

Direct Known Subclasses:

CIPProxy, DNP3Proxy, ModbusProxy

public abstract class PAPProxy
extends Object

PAP proxy.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PAPProxy.Responder Responder.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PAPProxy(PAPContext context, Origin origin) Constructs an instance.
protected	PAPProxy(PAPProxy other) Constructs an instance from an other.

Method Summary

Modifier and Type	Method and Description
abstract PAPProxy	copy() Creates a copy of this.
void	disconnect() Disconnects.
PAPConnectionListener	getConnectionListener() Gets the connection listener.
Optional<Point>	getConnectionStatePoint() Gets the connection state point.
PAPContext	getContext() Gets the context.
Optional<String>	getName() Gets the origin name.
Origin	getOrigin() Gets the origin representing the remote.
protected Logger	getThisLogger() Gets the logger for this instance.
void	setConnectionListener(PAPConnectionListener connectionListener) Sets the connection listener.
boolean	setConnectionStatePoint(Point connectionStatePoint) Sets the connection state point.
boolean	supportsWildcardAddress() Asks if this proxy can be configured with a wildcard address.
String	toString()

Methods inherited from class Object

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

Constructor Detail

PAPProxy

protected PAPProxy(@Nonnull
                   PAPProxy other)

Constructs an instance from an other.

Parameters:

other - The other instance.

PAPProxy

protected PAPProxy(@Nonnull
                   PAPContext context,
                   @Nonnull
                   Origin origin)

Constructs an instance.

Parameters:

context - The context.

origin - The origin representing the remote.

Method Detail

copy

@Nonnull
 @CheckReturnValue
public abstract PAPProxy copy()

Creates a copy of this.

Returns:

The copy.

disconnect

public void disconnect()

Disconnects.

getConnectionListener

@Nonnull
 @CheckReturnValue
public PAPConnectionListener getConnectionListener()

Gets the connection listener.

Returns:

The connection istener.

getConnectionStatePoint

@Nonnull
 @CheckReturnValue
public final Optional<Point> getConnectionStatePoint()

Gets the connection state point.

Returns:

The connection state point (empty if none).

getContext

@Nonnull
 @CheckReturnValue
public PAPContext getContext()

Gets the context.

Returns:

The context.

getName

@Nonnull
 @CheckReturnValue
public final Optional<String> getName()

Gets the origin name.

Returns:

The optional origin name.

getOrigin

@Nonnull
 @CheckReturnValue
public final Origin getOrigin()

Gets the origin representing the remote.

Returns:

The origin representing the remote.

setConnectionListener

public final void setConnectionListener(@Nonnull
                                        PAPConnectionListener connectionListener)

Sets the connection listener.

Parameters:

connectionListener - The connection listener.

setConnectionStatePoint

@CheckReturnValue
public final boolean setConnectionStatePoint(@Nonnull
                                                                Point connectionStatePoint)

Sets the connection state point.

Parameters:

connectionStatePoint - The connection state point.

Returns:

True on success.

supportsWildcardAddress

@CheckReturnValue
public boolean supportsWildcardAddress()

Asks if this proxy can be configured with a wildcard address.

Returns:

True if a wildcard address is supported.

toString

public String toString()

Overrides:

toString in class Object

getThisLogger

@Nonnull
 @CheckReturnValue
protected final Logger getThisLogger()

Gets the logger for this instance.

Returns:

The logger.