net.tomp2p.utils

Class Utils

java.lang.Object

net.tomp2p.utils.Utils

public class Utils
extends Object

Author:

Thomas Bocek, Maxat Pernebayev

Field Summary

Fields

Modifier and Type	Field and Description
static int	BYTE_BITS
static int	BYTE_BYTE_SIZE
static byte[]	EMPTY_BYTE_ARRAY
static int	INTEGER_BYTE_SIZE
static int	IPV4_BYTES
static int	IPV6_BYTES
static int	LONG_BYTE_SIZE
static int	MASK_0F
static int	MASK_80
static int	MASK_FF
static int	SHORT_BYTE_SIZE

Constructor Summary

Constructors

Constructor and Description
Utils()

Method Summary

Methods

Modifier and Type	Method and Description
static void	addReleaseListener(ChannelCreator channelCreator, BaseFuture... baseFutures) Adds a listener to the response future and releases all aquired channels in channel creator.
static void	addReleaseListener(FutureChannelCreator fcc, BaseFuture baseFuture)
static void	bestEffortclose(Closeable... closables)
static int	byteArrayToInt(byte[] b)
static byte[]	compress(byte[] input)
static BitSet	createBitSet(byte b) Convert a byte to a bit set.
static byte	createByte(BitSet bitSet) Convert a BitSet to a byte.
static InputStream	createInputStream(ByteBuffer buf)
static Number160	createRandomNodeID()
static File	createTempDir()
static String	debugArray(byte[] array)
static String	debugArray(byte[] array, int offset, int length)
static Object	decodeJavaObject(byte[] me, int offset, int length)
static Object	decodeJavaObject(io.netty.buffer.ByteBuf channelBuffer)
static Object	decodeJavaObject(DataBuffer dataBuffer)
static <K> Collection<K>	difference(Collection<K> collection1, Collection<K> result, Collection<K>... collections2) Stores the differences of multiple collections in a result collection.
static <K> Collection<K>	difference(Collection<K> collection1, Collection<K> result, Collection<K> collection2) Stores the differences of two collections in a result collection.
static <K,V> Map<K,V>	disjunction(Map<K,V> a, Collection<K> b)
static byte[]	encodeJavaObject(Object attachement)
static boolean	equals(Object a, Object b)
static Collection<Number160>	extractContentKeys(Collection<Number480> collection)
static PeerSocketAddress	extractRandomRelay(Message message) This method ensures that if a peer sends a message via reverse connection or hole punching, a random relay is chosen as the relay/rendez-vous peer
static Inet4Address	fromInteger(int address) Returns an Inet4Address having the integer value specified by the argument.
static <K> K	getLast(List<K> list)
static String	hash(PublicKey publicKey)
static InetAddress	inet4FromBytes(byte[] src, int offset) Converts a byte array to a Inet4Address.
static InetAddress	inet6FromBytes(byte[] me, int offset) Converts a byte array to a Inet6Address.
static byte[]	intToByteArray(int value)
static <T> boolean	isSameSets(Collection<T> set1, Collection<T> set2) Compares if two sets have the exact same elements.
static <K> Collection<K>	limit(Collection<K> a, int size)
static <K,V> Map<K,V>	limit(Map<K,V> a, int i)
static TrackerData	limitRandom(TrackerData activePeers, int trackerSize)
static ByteBuffer	loadFile(File file)
static byte[]	makeMD5Hash(byte[] buffer) It returns MD5 hash for the buffer.
static byte[]	makeMD5Hash(byte[] buffer, int offset, int length)
static Number160	makeSHAHash(byte[] buffer)
static Number160	makeSHAHash(byte[] buffer, int offset, int length)
static Number160	makeSHAHash(ByteBuffer buffer)
static Number160	makeSHAHash(DataBuffer buffer)
static Number160	makeSHAHash(File file)
static Number160	makeSHAHash(String strInput)
static InetSocketAddress	natReflection(InetSocketAddress recipient, boolean udp, PeerAddress self)
static void	nullCheck(Object... objects)
static boolean	nullCheckRetVal(Object... objects)
static <K> K	peekRandom(Collection<K> collection, Random rnd)
static <K> K	pollRandom(Collection<K> collection, Random rnd) Returns a random element from a collection.
static <K,V> Map.Entry<K,V>	pollRandomKey(Map<K,V> queueToAsk, Random rnd)
static int	randomPositiveInt(int upperBound) This method returns a random positve int within a given upper limit.
static Map<Number640,Byte>	setMapError(Map<Number640,?> dataMap, byte reason)
static <K> Collection<K>	subtract(Collection<K> a, Collection<K> b)
static <K,V> Map<K,V>	subtract(Map<K,V> a, Collection<K> b)
static byte[]	uncompress(byte[] compressedData)
static byte[]	uncompress(byte[] compressedData, int offset, int length)

Methods inherited from class java.lang.Object

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

Field Detail

IPV4_BYTES

public static final int IPV4_BYTES

See Also:

Constant Field Values

IPV6_BYTES

public static final int IPV6_BYTES

See Also:

Constant Field Values

BYTE_BITS

public static final int BYTE_BITS

See Also:

Constant Field Values

MASK_0F

public static final int MASK_0F

See Also:

Constant Field Values

MASK_80

public static final int MASK_80

See Also:

Constant Field Values

MASK_FF

public static final int MASK_FF

See Also:

Constant Field Values

BYTE_BYTE_SIZE

public static final int BYTE_BYTE_SIZE

See Also:

Constant Field Values

SHORT_BYTE_SIZE

public static final int SHORT_BYTE_SIZE

See Also:

Constant Field Values

INTEGER_BYTE_SIZE

public static final int INTEGER_BYTE_SIZE

See Also:

Constant Field Values

LONG_BYTE_SIZE

public static final int LONG_BYTE_SIZE

See Also:

Constant Field Values

EMPTY_BYTE_ARRAY

public static final byte[] EMPTY_BYTE_ARRAY

Constructor Detail

Utils

public Utils()

Method Detail

loadFile

public static ByteBuffer loadFile(File file)
                           throws IOException

Throws:

IOException

makeSHAHash

public static Number160 makeSHAHash(File file)

makeSHAHash

public static Number160 makeSHAHash(String strInput)

makeSHAHash

public static Number160 makeSHAHash(ByteBuffer buffer)

makeSHAHash

public static Number160 makeSHAHash(DataBuffer buffer)

makeSHAHash

public static Number160 makeSHAHash(byte[] buffer)

makeSHAHash

public static Number160 makeSHAHash(byte[] buffer,
                    int offset,
                    int length)

makeMD5Hash

public static byte[] makeMD5Hash(byte[] buffer)

It returns MD5 hash for the buffer.

Parameters:

buffer - The buffer to generate the checksum from

Returns:

The strong checksum

makeMD5Hash

public static byte[] makeMD5Hash(byte[] buffer,
                 int offset,
                 int length)

createRandomNodeID

public static Number160 createRandomNodeID()

compress

public static byte[] compress(byte[] input)

uncompress

public static byte[] uncompress(byte[] compressedData,
                int offset,
                int length)

uncompress

public static byte[] uncompress(byte[] compressedData)

encodeJavaObject

public static byte[] encodeJavaObject(Object attachement)
                               throws IOException

Throws:

IOException

decodeJavaObject

public static Object decodeJavaObject(io.netty.buffer.ByteBuf channelBuffer)
                               throws ClassNotFoundException,
                                      IOException

Throws:

ClassNotFoundException

IOException

decodeJavaObject

public static Object decodeJavaObject(DataBuffer dataBuffer)
                               throws ClassNotFoundException,
                                      IOException

Throws:

ClassNotFoundException

IOException

createInputStream

public static InputStream createInputStream(ByteBuffer buf)

decodeJavaObject

public static Object decodeJavaObject(byte[] me,
                      int offset,
                      int length)
                               throws ClassNotFoundException,
                                      IOException

Throws:

ClassNotFoundException

IOException

difference

public static <K> Collection<K> difference(Collection<K> collection1,
                           Collection<K> result,
                           Collection<K> collection2)

Stores the differences of two collections in a result collection. The result will contain items from collection1 without those items that are in collection2.

Parameters:

collection1 - The first collection (master collection) that will be iterated and checked against duplicates in collection2.

result - The collection to store the result

collection2 - The second collection that will be searched for duplicates

Returns:

Returns the collection the user specified as the resulting collection

difference

public static <K> Collection<K> difference(Collection<K> collection1,
                           Collection<K> result,
                           Collection<K>... collections2)

Stores the differences of multiple collections in a result collection. The result will contain items from collection1 without those items that are in collections2. The calling method might need to provide a

Parameters:

collection1 - The first collection (master collection) that will be iterated and checked against duplicates in collection2.

result - The collection to store the result

collection2 - The second collections that will be searched for duplicates

Returns:

Returns the collection the user specified as the resulting collection

bestEffortclose

public static void bestEffortclose(Closeable... closables)

intToByteArray

public static final byte[] intToByteArray(int value)

byteArrayToInt

public static final int byteArrayToInt(byte[] b)

pollRandom

public static <K> K pollRandom(Collection<K> collection,
               Random rnd)

Returns a random element from a collection. This method is pretty slow O(n), but the Java collection framework does not offer a better solution. This method puts the collection into a List and fetches a random element using List.get(int).

Parameters:

collection - The collection from which we want to pick a random element

rnd - The random object

Returns:

A random element

peekRandom

public static <K> K peekRandom(Collection<K> collection,
               Random rnd)

pollRandomKey

public static <K,V> Map.Entry<K,V> pollRandomKey(Map<K,V> queueToAsk,
                                 Random rnd)

subtract

public static <K> Collection<K> subtract(Collection<K> a,
                         Collection<K> b)

subtract

public static <K,V> Map<K,V> subtract(Map<K,V> a,
                      Collection<K> b)

disjunction

public static <K,V> Map<K,V> disjunction(Map<K,V> a,
                         Collection<K> b)

limit

public static <K> Collection<K> limit(Collection<K> a,
                      int size)

limit

public static <K,V> Map<K,V> limit(Map<K,V> a,
                   int i)

debugArray

public static String debugArray(byte[] array,
                int offset,
                int length)

debugArray

public static String debugArray(byte[] array)

limitRandom

public static TrackerData limitRandom(TrackerData activePeers,
                      int trackerSize)

getLast

public static <K> K getLast(List<K> list)

fromInteger

public static Inet4Address fromInteger(int address)

Returns an Inet4Address having the integer value specified by the argument.

Parameters:

address - int, the 32bit integer address to be converted

Returns:

Inet4Address equivalent of the argument

createTempDir

public static File createTempDir()
                          throws IOException

Throws:

IOException

nullCheck

public static void nullCheck(Object... objects)

nullCheckRetVal

public static boolean nullCheckRetVal(Object... objects)

extractContentKeys

public static Collection<Number160> extractContentKeys(Collection<Number480> collection)

inet4FromBytes

public static InetAddress inet4FromBytes(byte[] src,
                         int offset)

Converts a byte array to a Inet4Address.

Parameters:

me - the byte array

offset - where to start in the byte array

Returns:

The Inet4Address

Throws:

IndexOutOfBoundsException - if copying would cause access of data outside array bounds for src.

NullPointerException - if either src is null.

inet6FromBytes

public static InetAddress inet6FromBytes(byte[] me,
                         int offset)

Converts a byte array to a Inet6Address.

Parameters:

me - me the byte array

offset - where to start in the byte array

Returns:

The Inet6Address

Throws:

IndexOutOfBoundsException - if copying would cause access of data outside array bounds for src.

NullPointerException - if either src is null.

createBitSet

public static BitSet createBitSet(byte b)

Convert a byte to a bit set. BitSet.valueOf(new byte[] {b}) is only available in 1.7, so we need to do this on our own.

Parameters:

b - The byte to be converted

Returns:

The resulting bit set

createByte

public static byte createByte(BitSet bitSet)

Convert a BitSet to a byte. (Only takes the first 8 bits.) Cannot use relayType.toByteArray()[0]; since its only available in 1.7

Parameters:

bitSet - The bit set

Returns:

The resulting byte

addReleaseListener

public static void addReleaseListener(ChannelCreator channelCreator,
                      BaseFuture... baseFutures)

Adds a listener to the response future and releases all aquired channels in channel creator.

Parameters:

channelCreator - The channel creator that will be shutdown and all connections will be closed

baseFutures - The futures to listen to. If all the futures finished, then the channel creator is shutdown. If null provided, the channel creator is shutdown immediately.

addReleaseListener

public static void addReleaseListener(FutureChannelCreator fcc,
                      BaseFuture baseFuture)

isSameSets

public static <T> boolean isSameSets(Collection<T> set1,
                     Collection<T> set2)

Compares if two sets have the exact same elements.

Type Parameters:

T - Type of the collection

Parameters:

set1 - The first set

set2 - The second set

Returns:

True if both sets have the exact same elements

equals

public static boolean equals(Object a,
             Object b)

hash

public static String hash(PublicKey publicKey)

setMapError

public static Map<Number640,Byte> setMapError(Map<Number640,?> dataMap,
                              byte reason)

randomPositiveInt

public static int randomPositiveInt(int upperBound)

This method returns a random positve int within a given upper limit.

Parameters:

upperBound -

Returns:

randomInt

natReflection

public static InetSocketAddress natReflection(InetSocketAddress recipient,
                              boolean udp,
                              PeerAddress self)

extractRandomRelay

public static PeerSocketAddress extractRandomRelay(Message message)

This method ensures that if a peer sends a message via reverse connection or hole punching, a random relay is chosen as the relay/rendez-vous peer

Parameters:

message -

Returns:

socketAddress