Class LWSTorrent

java.lang.Object

com.biglybt.core.logging.LogRelation

com.biglybt.core.lws.LWSTorrent

All Implemented Interfaces:

TOTorrent

public class LWSTorrent
extends LogRelation
implements TOTorrent

Field Summary

Fields

Modifier and Type	Field	Description
private static final TOTorrentAnnounceURLGroup	announce_group
private final LightWeightSeed	lws

Fields inherited from interface TOTorrent

AZUREUS_PRIVATE_PROPERTIES, AZUREUS_PROPERTIES, DEFAULT_IGNORE_FILES, ENCODING_ACTUALLY_UTF8_KEYS, TT_V1, TT_V1_V2, TT_V2

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	LWSTorrent(LightWeightSeed _lws)

Method Summary

Modifier and Type	Method	Description
void	addListener(TOTorrentListener l)
byte[]	getAdditionalByteArrayProperty(String name)
List	getAdditionalListProperty(String name)
Long	getAdditionalLongProperty(String name)
Map	getAdditionalMapProperty(String name)
Object	getAdditionalProperty(String name)
String	getAdditionalStringProperty(String name)
URL	getAnnounceURL()	A torrent must have a URL that identifies the tracker.
TOTorrentAnnounceURLGroup	getAnnounceURLGroup()	When a group of sets of trackers is defined their URLs are accessed via this method
byte[]	getComment()	Comment is an optional torrent property
byte[]	getCreatedBy()
long	getCreationDate()	Gets the creation date of the torrent.
protected TOTorrent	getDelegate()
int	getFileCount()
TOTorrentFile[]	getFiles()	A torrent consists of one or more files.
byte[]	getFullHash(int type)
byte[]	getHash()	For a V1 or hybrid torrent this returns the SHA1 hash For a V2 only torrent it returns the truncated SHA256 hash
HashWrapper	getHashWrapper()	convenience method to get a wrapped hash for performance purposes
AEMonitor	getMonitor()
byte[]	getName()	Get the name of the torrent
int	getNumberOfPieces()
long	getPieceLength()	Returns the piece length used for the torrent
byte[][]	getPieces()	This method provides access to the SHA1/SHA256 hash values (20/32 bytes each) that correspond to the pieces of the torrent.
boolean	getPrivate()
Object[]	getQueryableInterfaces()	Query this class for a reference to another class that it may hold
String	getRelationText()	A short description of what your class holds that can be printed by the logger
long	getSize()
String	getSource()
int	getTorrentType()
String	getUTF8Name()	Retrieves the utf8 name of the torrent ONLY if the torrent specified one in it's info map.
boolean	hasSameHashAs(TOTorrent other)	compares two torrents by hash
boolean	isDecentralised()
boolean	isExportable()	Is the torrent in a fit state to export and share?
boolean	isSimpleTorrent()	A "simple torrent" is one that consists of a single file on its own (i.e.
boolean	isSimpleTorrentDisabled()
private static void	notSupported()
void	print()	A diagnostic method for dumping the tracker contents to "stdout"
void	removeAdditionalProperties()	remove all additional properties to clear out the torrent
void	removeAdditionalProperty(String name)
void	removeListener(TOTorrentListener l)
TOTorrent	selectHybridHashType(int type)
void	serialiseToBEncodedFile(File file)	This method will serialise a torrent using the standard "b-encoding" mechanism into a file
Map	serialiseToMap()	This method will serialise a torrent into a Map consistent with that used by the "b-encoding" routines defined elsewhere
void	serialiseToXMLFile(File file)	This method will serialise a torrent using an XML encoding to a file
void	setAdditionalByteArrayProperty(String name, byte[] value)
void	setAdditionalListProperty(String name, List value)
void	setAdditionalLongProperty(String name, Long value)
void	setAdditionalMapProperty(String name, Map value)
void	setAdditionalProperty(String name, Object value)	set an arbitrary property.
void	setAdditionalStringProperty(String name, String value)	The additional properties are used for holding non-core data for Azureus' own user
boolean	setAnnounceURL(URL url)
void	setComment(String comment)
void	setCreatedBy(byte[] cb)
void	setCreationDate(long date)
void	setHashOverride(byte[] hash)
void	setPieces(byte[][] pieces)	This method exists to support the temporary discarding of piece hashes to conserver memory.
void	setPrivate(boolean _private)	Note - changing the private attribute CHANGES THE TORRENT HASH
TOTorrent	setSimpleTorrentDisabled(boolean disabled)
void	setSource(String str)	Note - changing the source CHANGES THE TORRENT HASH
boolean	updateExportability(TOTorrent from)	Propagate exportability from another torrent to this one - has to have same hash.

Methods inherited from class LogRelation

propogatedRelationText, queryForClass

Methods inherited from class Object

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

Methods inherited from interface TOTorrent

getEffectiveTorrentType, getTruncatedHash

Field Details

announce_group

private static final TOTorrentAnnounceURLGroup announce_group

lws

private final LightWeightSeed lws

Constructor Details

LWSTorrent

protected LWSTorrent(LightWeightSeed _lws)

Method Details

notSupported

private static void notSupported()

getTorrentType

public int getTorrentType()

Specified by:

getTorrentType in interface TOTorrent

Returns:

One of the TT_ constants

isExportable

public boolean isExportable()

Description copied from interface: TOTorrent

Is the torrent in a fit state to export and share?

Specified by:

isExportable in interface TOTorrent

Returns:

updateExportability

public boolean updateExportability(TOTorrent from)

Description copied from interface: TOTorrent

Propagate exportability from another torrent to this one - has to have same hash. Required because an internal torrent can become exportable whilst the 'saved' (unexportable) original torrent is sitting there untouched...

Specified by:

updateExportability in interface TOTorrent

Parameters:

from -

Returns:

getDelegate

protected TOTorrent getDelegate()

getName

public byte[] getName()

Description copied from interface: TOTorrent

Get the name of the torrent

Specified by:

getName in interface TOTorrent

Returns:

getUTF8Name

public String getUTF8Name()

Description copied from interface: TOTorrent

Retrieves the utf8 name of the torrent ONLY if the torrent specified one in it's info map. Otherwise, returns null (you'll have to use getName() and decode it yourself)

Specified by:

getUTF8Name in interface TOTorrent

isSimpleTorrent

public boolean isSimpleTorrent()

Description copied from interface: TOTorrent

A "simple torrent" is one that consists of a single file on its own (i.e. not in a nested directory).

Specified by:

isSimpleTorrent in interface TOTorrent

Returns:

getComment

public byte[] getComment()

Description copied from interface: TOTorrent

Comment is an optional torrent property

Specified by:

getComment in interface TOTorrent

Returns:

setComment

public void setComment(String comment)

Specified by:

setComment in interface TOTorrent

getCreationDate

public long getCreationDate()

Description copied from interface: TOTorrent

Gets the creation date of the torrent. Optional property, 0 returned if not set

Specified by:

getCreationDate in interface TOTorrent

Returns:

isDecentralised

public boolean isDecentralised()

Specified by:

isDecentralised in interface TOTorrent

setCreationDate

public void setCreationDate(long date)

Specified by:

setCreationDate in interface TOTorrent

getCreatedBy

public byte[] getCreatedBy()

Specified by:

getCreatedBy in interface TOTorrent

setCreatedBy

public void setCreatedBy(byte[] cb)

Specified by:

setCreatedBy in interface TOTorrent

getAnnounceURL

public URL getAnnounceURL()

Description copied from interface: TOTorrent

A torrent must have a URL that identifies the tracker. This method returns it. However an extension to this exists to allow multiple trackers, and their backups, to be defined. See below

Specified by:

getAnnounceURL in interface TOTorrent

Returns:

setAnnounceURL

public boolean setAnnounceURL(URL url)

Specified by:

setAnnounceURL in interface TOTorrent

Parameters:

url -

Returns:

true-changed; false-not changed

getAnnounceURLGroup

public TOTorrentAnnounceURLGroup getAnnounceURLGroup()

Description copied from interface: TOTorrent

When a group of sets of trackers is defined their URLs are accessed via this method

Specified by:

getAnnounceURLGroup in interface TOTorrent

Returns:

the group, always present, which may have 0 members

getPieces

public byte[][] getPieces()
                   throws TOTorrentException

Description copied from interface: TOTorrent

This method provides access to the SHA1/SHA256 hash values (20/32 bytes each) that correspond to the pieces of the torrent.

Specified by:

getPieces in interface TOTorrent

Returns:

Throws:

TOTorrentException

setPieces

public void setPieces(byte[][] pieces)
               throws TOTorrentException

Description copied from interface: TOTorrent

This method exists to support the temporary discarding of piece hashes to conserver memory. It should only be used with care!

Specified by:

setPieces in interface TOTorrent

Parameters:

pieces -

Throws:

TOTorrentException

getPieceLength

public long getPieceLength()

Description copied from interface: TOTorrent

Returns the piece length used for the torrent

Specified by:

getPieceLength in interface TOTorrent

Returns:

getNumberOfPieces

public int getNumberOfPieces()

Specified by:

getNumberOfPieces in interface TOTorrent

getSize

public long getSize()

Specified by:

getSize in interface TOTorrent

getFileCount

public int getFileCount()

Specified by:

getFileCount in interface TOTorrent

getFiles

public TOTorrentFile[] getFiles()

Description copied from interface: TOTorrent

A torrent consists of one or more files. These are accessed via this method.

Specified by:

getFiles in interface TOTorrent

Returns:

getHash

public byte[] getHash()
               throws TOTorrentException

Description copied from interface: TOTorrent

For a V1 or hybrid torrent this returns the SHA1 hash For a V2 only torrent it returns the truncated SHA256 hash

Specified by:

getHash in interface TOTorrent

Returns:

Throws:

TOTorrentException

getFullHash

public byte[] getFullHash(int type)
                   throws TOTorrentException

Specified by:

getFullHash in interface TOTorrent

Returns:

SHA1 hash for v1/hybrid torrents, SHA256 hash for hybrid/v2 torrents

Throws:

TOTorrentException

getHashWrapper

public HashWrapper getHashWrapper()
                           throws TOTorrentException

Description copied from interface: TOTorrent

convenience method to get a wrapped hash for performance purposes

Specified by:

getHashWrapper in interface TOTorrent

Returns:

Throws:

TOTorrentException

selectHybridHashType

public TOTorrent selectHybridHashType(int type)
                               throws TOTorrentException

Specified by:

selectHybridHashType in interface TOTorrent

Throws:

TOTorrentException

setSimpleTorrentDisabled

public TOTorrent setSimpleTorrentDisabled(boolean disabled)
                                   throws TOTorrentException

Specified by:

setSimpleTorrentDisabled in interface TOTorrent

Throws:

TOTorrentException

isSimpleTorrentDisabled

public boolean isSimpleTorrentDisabled()
                                throws TOTorrentException

Specified by:

isSimpleTorrentDisabled in interface TOTorrent

Throws:

TOTorrentException

setHashOverride

public void setHashOverride(byte[] hash)
                     throws TOTorrentException

Specified by:

setHashOverride in interface TOTorrent

Throws:

TOTorrentException

hasSameHashAs

public boolean hasSameHashAs(TOTorrent other)

Description copied from interface: TOTorrent

compares two torrents by hash

Specified by:

hasSameHashAs in interface TOTorrent

Parameters:

other -

Returns:

getPrivate

public boolean getPrivate()

Specified by:

getPrivate in interface TOTorrent

setPrivate

public void setPrivate(boolean _private)
                throws TOTorrentException

Description copied from interface: TOTorrent

Note - changing the private attribute CHANGES THE TORRENT HASH

Specified by:

setPrivate in interface TOTorrent

Parameters:

_private -

Throws:

TOTorrentException

getSource

public String getSource()

Specified by:

getSource in interface TOTorrent

setSource

public void setSource(String str)
               throws TOTorrentException

Description copied from interface: TOTorrent

Note - changing the source CHANGES THE TORRENT HASH

Specified by:

setSource in interface TOTorrent

Parameters:

str -

Throws:

TOTorrentException

setAdditionalStringProperty

public void setAdditionalStringProperty(String name,
 String value)

Description copied from interface: TOTorrent

The additional properties are used for holding non-core data for Azureus' own user

Specified by:

setAdditionalStringProperty in interface TOTorrent

Parameters:

name - name of the property (e.g. "encoding")

value - value. This will be encoded with default encoding

getAdditionalStringProperty

public String getAdditionalStringProperty(String name)

Specified by:

getAdditionalStringProperty in interface TOTorrent

setAdditionalByteArrayProperty

public void setAdditionalByteArrayProperty(String name,
 byte[] value)

Specified by:

setAdditionalByteArrayProperty in interface TOTorrent

getAdditionalByteArrayProperty

public byte[] getAdditionalByteArrayProperty(String name)

Specified by:

getAdditionalByteArrayProperty in interface TOTorrent

setAdditionalLongProperty

public void setAdditionalLongProperty(String name,
 Long value)

Specified by:

setAdditionalLongProperty in interface TOTorrent

getAdditionalLongProperty

public Long getAdditionalLongProperty(String name)

Specified by:

getAdditionalLongProperty in interface TOTorrent

setAdditionalListProperty

public void setAdditionalListProperty(String name,
 List value)

Specified by:

setAdditionalListProperty in interface TOTorrent

getAdditionalListProperty

public List getAdditionalListProperty(String name)

Specified by:

getAdditionalListProperty in interface TOTorrent

setAdditionalMapProperty

public void setAdditionalMapProperty(String name,
 Map value)

Specified by:

setAdditionalMapProperty in interface TOTorrent

getAdditionalMapProperty

public Map getAdditionalMapProperty(String name)

Specified by:

getAdditionalMapProperty in interface TOTorrent

getAdditionalProperty

public Object getAdditionalProperty(String name)

Specified by:

getAdditionalProperty in interface TOTorrent

setAdditionalProperty

public void setAdditionalProperty(String name,
 Object value)

Description copied from interface: TOTorrent

set an arbitrary property. Make sure its compatible with bencoding!

Specified by:

setAdditionalProperty in interface TOTorrent

removeAdditionalProperty

public void removeAdditionalProperty(String name)

Specified by:

removeAdditionalProperty in interface TOTorrent

removeAdditionalProperties

public void removeAdditionalProperties()

Description copied from interface: TOTorrent

remove all additional properties to clear out the torrent

Specified by:

removeAdditionalProperties in interface TOTorrent

serialiseToBEncodedFile

public void serialiseToBEncodedFile(File file)
                             throws TOTorrentException

Description copied from interface: TOTorrent

This method will serialise a torrent using the standard "b-encoding" mechanism into a file

Specified by:

serialiseToBEncodedFile in interface TOTorrent

Parameters:

file -

Throws:

TOTorrentException

addListener

public void addListener(TOTorrentListener l)

Specified by:

addListener in interface TOTorrent

removeListener

public void removeListener(TOTorrentListener l)

Specified by:

removeListener in interface TOTorrent

serialiseToMap

public Map serialiseToMap()
                   throws TOTorrentException

Description copied from interface: TOTorrent

This method will serialise a torrent into a Map consistent with that used by the "b-encoding" routines defined elsewhere

Specified by:

serialiseToMap in interface TOTorrent

Returns:

Throws:

TOTorrentException

serialiseToXMLFile

public void serialiseToXMLFile(File file)
                        throws TOTorrentException

Description copied from interface: TOTorrent

This method will serialise a torrent using an XML encoding to a file

Specified by:

serialiseToXMLFile in interface TOTorrent

Parameters:

file -

Throws:

TOTorrentException

getMonitor

public AEMonitor getMonitor()

Specified by:

getMonitor in interface TOTorrent

print

public void print()

Description copied from interface: TOTorrent

A diagnostic method for dumping the tracker contents to "stdout"

Specified by:

print in interface TOTorrent

getRelationText

public String getRelationText()

Description copied from class: LogRelation

A short description of what your class holds that can be printed by the logger

Overrides:

getRelationText in class LogRelation

Returns:

getQueryableInterfaces

public Object[] getQueryableInterfaces()

Description copied from class: LogRelation

Query this class for a reference to another class that it may hold

Overrides:

getQueryableInterfaces in class LogRelation

Returns:

If found, the class desired. Otherwise, null.