Class NatPMPDeviceImpl

java.lang.Object

com.biglybt.net.natpmp.impl.NatPMPDeviceImpl

All Implemented Interfaces:

NatPMPDevice

public class NatPMPDeviceImpl
extends Object
implements NatPMPDevice

Main class

Field Summary

Fields

Modifier and Type	Field	Description
private NATPMPDeviceAdapter	adapter
private String	current_router_address
private InetAddress	hostInet
private int	nat_epoch
(package private) static final int	NATAddrReplyLen
(package private) static final int	NATAddrRequest
(package private) static final int	NATMAP_DEFAULT_LEASE
(package private) static final int	NATMAP_INIT_RETRY
(package private) static final String	NATMAP_LLM
(package private) static final int	NATMAP_MAX_RETRY
(package private) static final int	NATMAP_PORT
(package private) static final int	NATMAP_RESPONSE_MASK
(package private) static final int	NATMAP_VER
(package private) static final byte	NATOp_AddrRequest
(package private) static final byte	NATOp_MapTCP
(package private) static final byte	NATOp_MapUDP
private static NatPMPDeviceImpl	NatPMPDeviceSingletonRef	Singleton creation
(package private) static final int	NATPortMapReplyLen
(package private) static final int	NATPortMapRequestLen
private InetAddress	natPriInet
private InetAddress	natPubInet
(package private) static final int	NATResultNetFailure	Network Failure (e.g.
(package private) static final int	NATResultNoResc
(package private) static final int	NATResultNotAuth	Not Authorized/Refused (e.g.
(package private) static final int	NATResultSuccess
(package private) static final int	NATResultUnsupportedOp
(package private) static final int	NATResultUnsupportedVer
private NetworkInterface	networkInterface

Constructor Summary

Constructors

Modifier	Constructor	Description
private	NatPMPDeviceImpl(NATPMPDeviceAdapter _adapter)

Method Summary

Modifier and Type	Method	Description
int	addPortMapping(boolean tcp, int publicPort, int privatePort)	Asks for a public port to be mapped to a private port from this host.
String	byteArrayString(byte[] buf)
protected void	checkRouterAddress()
boolean	connect()	Try to connect with a NAT-PMP device.
private String	convertHost2RouterAddress(InetAddress inet)
void	deletePortMapping(boolean tcp, int publicPort, int privatePort)	Delete a mapped public port
int	getEpoch()
String	getExternalIPAddress()
InetAddress	getLocalAddress(boolean ipv4)
NetworkInterface	getNetworkInterface()
static NatPMPDeviceImpl	getSingletonObject(NATPMPDeviceAdapter adapter)
String	intArrayString(int[] buf)
byte[]	intToByteArray(int v)	Convert a 32-bit int into a 4 byte array
protected void	log(String str)
int	portMappingProtocol(boolean tcp, int publicPort, int privatePort, int lifetime)	General port mapping protocol
DatagramPacket	sendNATMsg(InetAddress dstInet, DatagramPacket dstPkt, byte[] recBuf)	Send a request and wait for reply This class should be threaded!!! This sends to the default NATPMP_PORT.
byte[]	shortToByteArray(short v)	Convert a 16-bit short into a 2 byte array
static int	unsigned16ByteArrayToInt(byte[] b, int offset)	Convert the byte array containing 16-bits to an int starting from the given offset.
static int	unsigned32ByteArrayToInt(byte[] b, int offset)	Convert the byte array containing 32-bit to an int starting from the given offset.
static int	unsigned8ByteArrayToInt(byte[] b, int offset)	Convert the byte array containing 8-bits to an int starting from the given offset.
short	unsignedByteArrayToShort(byte[] buf)

Methods inherited from class Object

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

Field Details

NATMAP_VER

static final int NATMAP_VER

See Also:

• Constant Field Values

NATMAP_PORT

static final int NATMAP_PORT

See Also:

• Constant Field Values

NATMAP_RESPONSE_MASK

static final int NATMAP_RESPONSE_MASK

See Also:

• Constant Field Values

NATMAP_INIT_RETRY

static final int NATMAP_INIT_RETRY

See Also:

• Constant Field Values

NATMAP_MAX_RETRY

static final int NATMAP_MAX_RETRY

See Also:

• Constant Field Values

NATMAP_DEFAULT_LEASE

static final int NATMAP_DEFAULT_LEASE

See Also:

• Constant Field Values

NATMAP_LLM

static final String NATMAP_LLM

See Also:

• Constant Field Values

NATOp_AddrRequest

static final byte NATOp_AddrRequest

See Also:

• Constant Field Values

NATOp_MapUDP

static final byte NATOp_MapUDP

See Also:

• Constant Field Values

NATOp_MapTCP

static final byte NATOp_MapTCP

See Also:

• Constant Field Values

NATAddrRequest

static final int NATAddrRequest

See Also:

• Constant Field Values

NATPortMapRequestLen

static final int NATPortMapRequestLen

See Also:

• Constant Field Values

NATAddrReplyLen

static final int NATAddrReplyLen

See Also:

• Constant Field Values

NATPortMapReplyLen

static final int NATPortMapReplyLen

See Also:

• Constant Field Values

NATResultSuccess

static final int NATResultSuccess

See Also:

• Constant Field Values

NATResultUnsupportedVer

static final int NATResultUnsupportedVer

See Also:

• Constant Field Values

NATResultNotAuth

static final int NATResultNotAuth

Not Authorized/Refused (e.g. box supports mapping, but user has turned feature off)

See Also:

• Constant Field Values

NATResultNetFailure

static final int NATResultNetFailure

Network Failure (e.g. NAT box itself has not obtained a DHCP lease)

See Also:

• Constant Field Values

NATResultNoResc

static final int NATResultNoResc

See Also:

• Constant Field Values

NATResultUnsupportedOp

static final int NATResultUnsupportedOp

See Also:

• Constant Field Values

current_router_address

private String current_router_address

hostInet

private InetAddress hostInet

natPriInet

private InetAddress natPriInet

natPubInet

private InetAddress natPubInet

networkInterface

private NetworkInterface networkInterface

nat_epoch

private int nat_epoch

adapter

private NATPMPDeviceAdapter adapter

NatPMPDeviceSingletonRef

private static NatPMPDeviceImpl NatPMPDeviceSingletonRef

Singleton creation

Constructor Details

NatPMPDeviceImpl

private NatPMPDeviceImpl(NATPMPDeviceAdapter _adapter)
                  throws Exception

Throws:

Exception

Method Details

getSingletonObject

public static NatPMPDeviceImpl getSingletonObject(NATPMPDeviceAdapter adapter)
                                           throws Exception

Throws:

Exception

checkRouterAddress

protected void checkRouterAddress()
                           throws Exception

Throws:

Exception

sendNATMsg

public DatagramPacket sendNATMsg(InetAddress dstInet,
 DatagramPacket dstPkt,
 byte[] recBuf)
                          throws Exception

Send a request and wait for reply This class should be threaded!!! This sends to the default NATPMP_PORT.

Parameters:

dstInet - destination address (should be the private NAT address)

dstPkt - packet to send

recBuf - byte buffer big enough to hold received

Throws:

Exception

connect

public boolean connect()
                throws Exception

Try to connect with a NAT-PMP device. This could take sometime.

Specified by:

connect in interface NatPMPDevice

Returns:

true if it found one

Throws:

Exception

addPortMapping

public int addPortMapping(boolean tcp,
 int publicPort,
 int privatePort)
                   throws Exception

Asks for a public port to be mapped to a private port from this host. NAP-PMP allows the device to assign another public port if the requested one is taken. So, you should check the returned port.

Specified by:

addPortMapping in interface NatPMPDevice

Parameters:

tcp - true TCP, false UDP

Returns:

the returned publicPort. -1 if error occured

Throws:

Exception

deletePortMapping

public void deletePortMapping(boolean tcp,
 int publicPort,
 int privatePort)
                       throws Exception

Delete a mapped public port

Specified by:

deletePortMapping in interface NatPMPDevice

Parameters:

tcp - true TCP, false UDP port

publicPort - the public port to close

privatePort - the private port that it is mapped to

Throws:

Exception

portMappingProtocol

public int portMappingProtocol(boolean tcp,
 int publicPort,
 int privatePort,
 int lifetime)
                        throws Exception

General port mapping protocol

Throws:

Exception

getLocalAddress

public InetAddress getLocalAddress(boolean ipv4)

Specified by:

getLocalAddress in interface NatPMPDevice

getNetworkInterface

public NetworkInterface getNetworkInterface()

Specified by:

getNetworkInterface in interface NatPMPDevice

getExternalIPAddress

public String getExternalIPAddress()

Specified by:

getExternalIPAddress in interface NatPMPDevice

getEpoch

public int getEpoch()

Specified by:

getEpoch in interface NatPMPDevice

log

protected void log(String str)

unsigned32ByteArrayToInt

public static int unsigned32ByteArrayToInt(byte[] b,
 int offset)

Convert the byte array containing 32-bit to an int starting from the given offset.

Parameters:

b - The byte array

offset - The array offset

Returns:

The integer

unsigned16ByteArrayToInt

public static int unsigned16ByteArrayToInt(byte[] b,
 int offset)

Convert the byte array containing 16-bits to an int starting from the given offset.

Parameters:

b - The byte array

offset - The array offset

Returns:

The integer

unsigned8ByteArrayToInt

public static int unsigned8ByteArrayToInt(byte[] b,
 int offset)

Convert the byte array containing 8-bits to an int starting from the given offset.

Parameters:

b - The byte array

offset - The array offset

Returns:

The integer

unsignedByteArrayToShort

public short unsignedByteArrayToShort(byte[] buf)

shortToByteArray

public byte[] shortToByteArray(short v)

Convert a 16-bit short into a 2 byte array

Returns:

unsigned byte array

intToByteArray

public byte[] intToByteArray(int v)

Convert a 32-bit int into a 4 byte array

Returns:

unsigned byte array

intArrayString

public String intArrayString(int[] buf)

byteArrayString

public String byteArrayString(byte[] buf)

convertHost2RouterAddress

private String convertHost2RouterAddress(InetAddress inet)

Parameters:

init - takes the host address

Returns:

String the address as (xxx.xxx.xxx.1)