org.eclipse.kura.net.firewall

Class FirewallPortForwardConfigIP<T extends IPAddress>

java.lang.Object

org.eclipse.kura.net.firewall.FirewallPortForwardConfigIP<T>

Type Parameters:

T -

All Implemented Interfaces:

FirewallPortForwardConfig, NetConfig

Direct Known Subclasses:

FirewallPortForwardConfigIP4

@ProviderType
public abstract class FirewallPortForwardConfigIP<T extends IPAddress>
extends java.lang.Object
implements FirewallPortForwardConfig

The base class for firewall port forward configurations

Constructor Summary

Constructors

Constructor and Description
FirewallPortForwardConfigIP() Creates and empty port forward configuration
FirewallPortForwardConfigIP(java.lang.String inboundIface, java.lang.String outboundIface, IP4Address address, NetProtocol protocol, int inPort, int outPort, boolean masquerade, NetworkPair<T> permittedNetwork, java.lang.String permittedMac, java.lang.String sourcePortRange) Creates a complete port forward configuration

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
IP4Address	getAddress() The LAN IP address to forward connections to
java.lang.String	getInboundInterface() The external (WAN) interface to listen for inbound connections on
int	getInPort() The inbound (WAN) port to use for this configuration
java.lang.String	getOutboundInterface() The internal (LAN) interface packets will be forwarded to
int	getOutPort() The outbound (LAN) port to use for this configuration
java.lang.String	getPermittedMac() Gets the (optional) permitted MAC address that is allowed to make inbound connections
NetworkPair<T>	getPermittedNetwork() Gets the (optional) permitted remote network that can make inbound connections
NetProtocol	getProtocol() Gets the type of network protocol (TCP or UDP) that is used for this configuration
java.lang.String	getSourcePortRange() Gets the (optional) permitted source port range that is allowed to make inbound connections
int	hashCode()
boolean	isMasquerade() Use masquerading
boolean	isValid() Checks whether or not this configuration is valid.
void	setAddress(IP4Address address)
void	setInboundInterface(java.lang.String interfaceName)
void	setInPort(int inPort)
void	setMasquerade(boolean masquerade)
void	setOutboundInterface(java.lang.String interfaceName)
void	setOutPort(int outPort)
void	setPermittedMac(java.lang.String permittedMac)
void	setPermittedNetwork(NetworkPair<T> permittedNetwork)
void	setProtocol(NetProtocol protocol)
void	setSourcePortRange(java.lang.String sourcePortRange)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FirewallPortForwardConfigIP

public FirewallPortForwardConfigIP()

Creates and empty port forward configuration

FirewallPortForwardConfigIP

public FirewallPortForwardConfigIP(java.lang.String inboundIface,
                                   java.lang.String outboundIface,
                                   IP4Address address,
                                   NetProtocol protocol,
                                   int inPort,
                                   int outPort,
                                   boolean masquerade,
                                   NetworkPair<T> permittedNetwork,
                                   java.lang.String permittedMac,
                                   java.lang.String sourcePortRange)

Creates a complete port forward configuration

Parameters:

inboundIface - The interface name on which this configuration will listen for inbound connections

outboundIface - The inetrface name on which packet will be forwarded

address - The LAN address to forward to

protocol - The protocol (TCP or UDP) to listen for and forward

inPort - The inbound (WAN) port to listen on

outPort - The outbound (LAN) port to listen on

masquerade - Use masquerade

permittedNetwork - The (optional) permitted network for inbound connections

permittedMac - The (optional) permitted MAC address for inbound connections

sourcePortRange - The (options) permitted source port range for inbound connections

Method Detail

getInboundInterface

public java.lang.String getInboundInterface()

Description copied from interface: FirewallPortForwardConfig

The external (WAN) interface to listen for inbound connections on

Specified by:

getInboundInterface in interface FirewallPortForwardConfig

Returns:

The interface name used for this port forward configuration

setInboundInterface

public void setInboundInterface(java.lang.String interfaceName)

getOutboundInterface

public java.lang.String getOutboundInterface()

Description copied from interface: FirewallPortForwardConfig

The internal (LAN) interface packets will be forwarded to

Specified by:

getOutboundInterface in interface FirewallPortForwardConfig

Returns:

The interface name used for this port forward configuration

setOutboundInterface

public void setOutboundInterface(java.lang.String interfaceName)

getAddress

public IP4Address getAddress()

Description copied from interface: FirewallPortForwardConfig

The LAN IP address to forward connections to

Specified by:

getAddress in interface FirewallPortForwardConfig

Returns:

The LAN IPAddress to forward connections to

setAddress

public void setAddress(IP4Address address)

getProtocol

public NetProtocol getProtocol()

Description copied from interface: FirewallPortForwardConfig

Gets the type of network protocol (TCP or UDP) that is used for this configuration

Specified by:

getProtocol in interface FirewallPortForwardConfig

Returns:

The NetProtocol type associated with this interface

setProtocol

public void setProtocol(NetProtocol protocol)

getInPort

public int getInPort()

Description copied from interface: FirewallPortForwardConfig

The inbound (WAN) port to use for this configuration

Specified by:

getInPort in interface FirewallPortForwardConfig

Returns:

The WAN port number

setInPort

public void setInPort(int inPort)

getOutPort

public int getOutPort()

Description copied from interface: FirewallPortForwardConfig

The outbound (LAN) port to use for this configuration

Specified by:

getOutPort in interface FirewallPortForwardConfig

Returns:

The LAN port number

setOutPort

public void setOutPort(int outPort)

isMasquerade

public boolean isMasquerade()

Description copied from interface: FirewallPortForwardConfig

Use masquerading

Specified by:

isMasquerade in interface FirewallPortForwardConfig

Returns:

boolean

setMasquerade

public void setMasquerade(boolean masquerade)

getPermittedNetwork

public NetworkPair<T> getPermittedNetwork()

Description copied from interface: FirewallPortForwardConfig

Gets the (optional) permitted remote network that can make inbound connections

Specified by:

getPermittedNetwork in interface FirewallPortForwardConfig

Returns:

The NetworkPair representing the permitted network

setPermittedNetwork

public void setPermittedNetwork(NetworkPair<T> permittedNetwork)

getPermittedMac

public java.lang.String getPermittedMac()

Description copied from interface: FirewallPortForwardConfig

Gets the (optional) permitted MAC address that is allowed to make inbound connections

Specified by:

getPermittedMac in interface FirewallPortForwardConfig

Returns:

The MAC address that is allowed to make inbound connections

setPermittedMac

public void setPermittedMac(java.lang.String permittedMac)

getSourcePortRange

public java.lang.String getSourcePortRange()

Description copied from interface: FirewallPortForwardConfig

Gets the (optional) permitted source port range that is allowed to make inbound connections

Specified by:

getSourcePortRange in interface FirewallPortForwardConfig

Returns:

The source port range that is allowed to make inbound connections

setSourcePortRange

public void setSourcePortRange(java.lang.String sourcePortRange)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

isValid

public boolean isValid()

Description copied from interface: NetConfig

Checks whether or not this configuration is valid.

Specified by:

isValid in interface NetConfig

Returns:

true if the configuration is valid, otherwise false

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object