org.gudy.azureus2.core3.util
Class TorrentUtils.torrentDelegate

java.lang.Object
  org.gudy.azureus2.core3.logging.LogRelation
      org.gudy.azureus2.core3.util.TorrentUtils.torrentDelegate

All Implemented Interfaces:

TOTorrent, TorrentUtils.ExtendedTorrent

Enclosing class:

TorrentUtils

public static class TorrentUtils.torrentDelegate
extends LogRelation
implements TorrentUtils.ExtendedTorrent

Field Summary

Fields inherited from interface org.gudy.azureus2.core3.torrent.TOTorrent

AZUREUS_PRIVATE_PROPERTIES, AZUREUS_PROPERTIES, DEFAULT_IGNORE_FILES, ENCODING_ACTUALLY_UTF8_KEYS

Constructor Summary

protected

TorrentUtils.torrentDelegate(TOTorrent _delegate, java.io.File _file)

Method Summary

void	addListener(TOTorrentListener l)
protected void	discardPieces(long now, boolean force)
byte[]	getAdditionalByteArrayProperty(java.lang.String name)
java.util.List	getAdditionalListProperty(java.lang.String name)
java.lang.Long	getAdditionalLongProperty(java.lang.String name)
java.util.Map	getAdditionalMapProperty(java.lang.String name)
java.lang.Object	getAdditionalProperty(java.lang.String name)
java.lang.String	getAdditionalStringProperty(java.lang.String name)
java.net.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
TOTorrentAnnounceURLGroup	getAnnounceURLGroupSupport()
java.net.URL	getAnnounceURLSupport()
byte[]	getComment() Comment is an optional torrent property
byte[]	getCreatedBy()
long	getCreationDate() Gets the creation date of the torrent.
int	getFileCount()
TOTorrentFile[]	getFiles() A torrent consists of one or more files.
byte[]	getHash() A torrent has a unique SHA1 (20 byte) hash that is computed from some of its contents.
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()
boolean	getPrivate()
java.lang.Object[]	getQueryableInterfaces() Query this class for a reference to another class that it may hold
java.lang.String	getRelationText() A short description of what your class holds that can be printed by the logger
long	getSize()
java.lang.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	isCreated()
boolean	isDecentralised() This method provides access to the SHA1 hash values (20 bytes each) that correspond to the pieces of the torrent.
boolean	isSimpleTorrent() A "simple torrent" is one that consists of a single file on its own (i.e.
byte[][]	peekPieces() peeks the pieces, will return null if they are discarded
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(java.lang.String name)
void	removeListener(TOTorrentListener l)
protected boolean[]	restoreState(boolean do_pieces, boolean do_fluff) monitor must be held before calling me
void	serialiseToBEncodedFile(java.io.File target_file) This method will serialise a torrent using the standard "b-encoding" mechanism into a file
java.util.Map	serialiseToMap() This method will serialise a torrent into a Map consistent with that used by the "b-encoding" routines defined elsewhere
void	serialiseToXMLFile(java.io.File target_file) This method will serialise a torrent using an XML encoding to a file
void	setAdditionalByteArrayProperty(java.lang.String name, byte[] value)
void	setAdditionalListProperty(java.lang.String name, java.util.List value)
void	setAdditionalLongProperty(java.lang.String name, java.lang.Long value)
void	setAdditionalMapProperty(java.lang.String name, java.util.Map value)
void	setAdditionalProperty(java.lang.String name, java.lang.Object value) set an arbitrary property.
void	setAdditionalStringProperty(java.lang.String name, java.lang.String value) The additional properties are used for holding non-core data for Azureus' own user
boolean	setAnnounceURL(java.net.URL url)
void	setComment(java.lang.String comment)
void	setCreatedBy(byte[] cb)
void	setCreationDate(long date)
void	setDiscardFluff(boolean discard)
void	setHashOverride(byte[] hash) Only supported for decentralised torrents, allows an alternative hash to be used for them in the DHT
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

Methods inherited from class org.gudy.azureus2.core3.logging.LogRelation

propogatedRelationText, queryForClass, queryForClass

Methods inherited from class java.lang.Object

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

Constructor Detail

TorrentUtils.torrentDelegate

protected TorrentUtils.torrentDelegate(TOTorrent _delegate,
                                       java.io.File _file)

Method Detail

setDiscardFluff

public void setDiscardFluff(boolean discard)

Specified by:

setDiscardFluff in interface TorrentUtils.ExtendedTorrent

getName

public byte[] getName()

Description copied from interface: TOTorrent

Get the name of the torrent

Specified by:

getName in interface TOTorrent

Returns:

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(java.lang.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:

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

isCreated

public boolean isCreated()

Specified by:

isCreated in interface TOTorrent

isDecentralised

public boolean isDecentralised()

Description copied from interface: TOTorrent

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

Specified by:

isDecentralised in interface TOTorrent

Returns:

getAnnounceURL

public java.net.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:

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

getAnnounceURLSupport

public java.net.URL getAnnounceURLSupport()

setAnnounceURL

public boolean setAnnounceURL(java.net.URL url)

Specified by:

setAnnounceURL in interface TOTorrent

Returns:

true-changed; false-not changed

getAnnounceURLGroupSupport

public TOTorrentAnnounceURLGroup getAnnounceURLGroupSupport()

discardPieces

protected void discardPieces(long now,
                             boolean force)

getPieces

public byte[][] getPieces()
                   throws TOTorrentException

Specified by:

getPieces in interface TOTorrent

Throws:

TOTorrentException

restoreState

protected boolean[] restoreState(boolean do_pieces,
                                 boolean do_fluff)
                          throws TOTorrentException

monitor must be held before calling me

Parameters:

do_pieces -

do_fluff -

Throws:

TOTorrentException

peekPieces

public byte[][] peekPieces()
                    throws TOTorrentException

peeks the pieces, will return null if they are discarded

Specified by:

peekPieces in interface TorrentUtils.ExtendedTorrent

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

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

A torrent has a unique SHA1 (20 byte) hash that is computed from some of its contents. It is used, for example, when contacting a tracker to identify the torrent.

Specified by:

getHash in interface TOTorrent

Returns:

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

setHashOverride

public void setHashOverride(byte[] hash)
                     throws TOTorrentException

Description copied from interface: TOTorrent

Only supported for decentralised torrents, allows an alternative hash to be used for them in the DHT

Specified by:

setHashOverride in interface TOTorrent

Throws:

TOTorrentException

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

Throws:

TOTorrentException

hasSameHashAs

public boolean hasSameHashAs(TOTorrent other)

Description copied from interface: TOTorrent

compares two torrents by hash

Specified by:

hasSameHashAs in interface TOTorrent

Returns:

setAdditionalStringProperty

public void setAdditionalStringProperty(java.lang.String name,
                                        java.lang.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 java.lang.String getAdditionalStringProperty(java.lang.String name)

Specified by:

getAdditionalStringProperty in interface TOTorrent

setAdditionalByteArrayProperty

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

Specified by:

setAdditionalByteArrayProperty in interface TOTorrent

getAdditionalByteArrayProperty

public byte[] getAdditionalByteArrayProperty(java.lang.String name)

Specified by:

getAdditionalByteArrayProperty in interface TOTorrent

setAdditionalLongProperty

public void setAdditionalLongProperty(java.lang.String name,
                                      java.lang.Long value)

Specified by:

setAdditionalLongProperty in interface TOTorrent

getAdditionalLongProperty

public java.lang.Long getAdditionalLongProperty(java.lang.String name)

Specified by:

getAdditionalLongProperty in interface TOTorrent

setAdditionalListProperty

public void setAdditionalListProperty(java.lang.String name,
                                      java.util.List value)

Specified by:

setAdditionalListProperty in interface TOTorrent

getAdditionalListProperty

public java.util.List getAdditionalListProperty(java.lang.String name)

Specified by:

getAdditionalListProperty in interface TOTorrent

setAdditionalMapProperty

public void setAdditionalMapProperty(java.lang.String name,
                                     java.util.Map value)

Specified by:

setAdditionalMapProperty in interface TOTorrent

getAdditionalMapProperty

public java.util.Map getAdditionalMapProperty(java.lang.String name)

Specified by:

getAdditionalMapProperty in interface TOTorrent

getAdditionalProperty

public java.lang.Object getAdditionalProperty(java.lang.String name)

Specified by:

getAdditionalProperty in interface TOTorrent

setAdditionalProperty

public void setAdditionalProperty(java.lang.String name,
                                  java.lang.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(java.lang.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(java.io.File target_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

Throws:

TOTorrentException

serialiseToMap

public java.util.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(java.io.File target_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

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

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 java.lang.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 java.lang.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.

getUTF8Name

public java.lang.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