Class RPTorrentManager

java.lang.Object

com.biglybt.pifimpl.remote.RPObject

com.biglybt.pifimpl.remote.torrent.RPTorrentManager

All Implemented Interfaces:

TorrentManager, Serializable

public class RPTorrentManager
extends RPObject
implements TorrentManager

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected TorrentManager	delegate

Fields inherited from class RPObject

__delegate, _dispatcher, _object_id, next_key, object_registry, object_registry_reverse

Fields inherited from interface TorrentManager

PRESERVE_ALL, PRESERVE_ENCODING, PRESERVE_NONE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RPTorrentManager(TorrentManager _delegate)

Method Summary

Modifier and Type	Method	Description
RPReply	_process(RPRequest request)
protected void	_setDelegate(Object _delegate)
Object	_setLocal()
void	addListener(TorrentManagerListener l)
static RPTorrentManager	create(TorrentManager _delegate)
Torrent	createFromBEncodedData(byte[] data)	decodes a torrent encoded using the normal "bencoding" rules from a byte array
Torrent	createFromBEncodedData(byte[] data, int preserve)	decodes a torrent encoded using the normal "bencoding" rules from a byte array
Torrent	createFromBEncodedFile(File file)	decodes a torrent encoded using the normal "bencoding" rules from a file
Torrent	createFromBEncodedFile(File file, boolean for_seeding)	decodes a torrent encoded using the normal "bencoding" rules from a file but discards the piece hashes to save memory.
Torrent	createFromBEncodedFile(File file, int preserve)	decodes a torrent encoded using the normal "bencoding" rules from a file
Torrent	createFromBEncodedInputStream(InputStream data)	decodes a torrent encoded using the normal "bencoding" rules from an InputStream
Torrent	createFromBEncodedInputStream(InputStream data, int preserve)	decodes a torrent encoded using the normal "bencoding" rules from an InputStream
Torrent	createFromDataFile(File data, URL announce_url)	creates a new torrent from an input file
Torrent	createFromDataFile(File data, URL announce_url, boolean include_other_hashes)
TorrentCreator	createFromDataFileEx(File data, URL announce_url, boolean include_other_hashes)
TorrentAttribute	getAttribute(String name)	Gives access to the standard built-in attributes
TorrentAttribute[]	getDefinedAttributes()	Gives access to the currently defined torrent attributes.
TorrentAttribute	getPluginAttribute(String name)	Gives access to/creates arbitrary String attributes for plugins to use.
TorrentDownloader	getURLDownloader(URL url)
TorrentDownloader	getURLDownloader(URL url, String user_name, String password)
void	removeListener(TorrentManagerListener l)

Methods inherited from class RPObject

_fixupLocal, _getDelegate, _getName, _getOID, _lookupLocal, _lookupLocal, _refresh, _setRemote, getDispatcher, notSupported, notSupported

Methods inherited from class Object

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

Field Details

delegate

protected transient TorrentManager delegate

Constructor Details

RPTorrentManager

protected RPTorrentManager(TorrentManager _delegate)

Method Details

create

public static RPTorrentManager create(TorrentManager _delegate)

_setDelegate

protected void _setDelegate(Object _delegate)

Overrides:

_setDelegate in class RPObject

_setLocal

public Object _setLocal()
                 throws RPException

Overrides:

_setLocal in class RPObject

Throws:

RPException

_process

public RPReply _process(RPRequest request)

Overrides:

_process in class RPObject

getURLDownloader

public TorrentDownloader getURLDownloader(URL url)
                                   throws TorrentException

Specified by:

getURLDownloader in interface TorrentManager

Throws:

TorrentException

getURLDownloader

public TorrentDownloader getURLDownloader(URL url,
 String user_name,
 String password)
                                   throws TorrentException

Specified by:

getURLDownloader in interface TorrentManager

Throws:

TorrentException

createFromBEncodedFile

public Torrent createFromBEncodedFile(File file)
                               throws TorrentException

Description copied from interface: TorrentManager

decodes a torrent encoded using the normal "bencoding" rules from a file

Specified by:

createFromBEncodedFile in interface TorrentManager

Parameters:

file -

Returns:

Throws:

TorrentException

createFromBEncodedFile

public Torrent createFromBEncodedFile(File file,
 boolean for_seeding)
                               throws TorrentException

Description copied from interface: TorrentManager

decodes a torrent encoded using the normal "bencoding" rules from a file but discards the piece hashes to save memory. note that this means that if something reads the hashes they will be re-read from the torrent file and if the file has since been deleted things go smelly

Specified by:

createFromBEncodedFile in interface TorrentManager

Parameters:

file -

for_seeding - reduces memory usage by discarding piece hashes

Returns:

Throws:

TorrentException

createFromBEncodedInputStream

public Torrent createFromBEncodedInputStream(InputStream data)
                                      throws TorrentException

Description copied from interface: TorrentManager

decodes a torrent encoded using the normal "bencoding" rules from an InputStream

Specified by:

createFromBEncodedInputStream in interface TorrentManager

Returns:

Throws:

TorrentException

createFromBEncodedData

public Torrent createFromBEncodedData(byte[] data)
                               throws TorrentException

Description copied from interface: TorrentManager

decodes a torrent encoded using the normal "bencoding" rules from a byte array

Specified by:

createFromBEncodedData in interface TorrentManager

Returns:

Throws:

TorrentException

createFromBEncodedData

public Torrent createFromBEncodedData(byte[] data,
 int preserve)
                               throws TorrentException

Description copied from interface: TorrentManager

decodes a torrent encoded using the normal "bencoding" rules from a byte array

Specified by:

createFromBEncodedData in interface TorrentManager

Parameters:

data -

preserve - PRESERVE_* flags

Returns:

Throws:

TorrentException

createFromBEncodedFile

public Torrent createFromBEncodedFile(File file,
 int preserve)
                               throws TorrentException

Description copied from interface: TorrentManager

decodes a torrent encoded using the normal "bencoding" rules from a file

Specified by:

createFromBEncodedFile in interface TorrentManager

Parameters:

file -

preserve - PRESERVE_* flags

Returns:

Throws:

TorrentException

createFromBEncodedInputStream

public Torrent createFromBEncodedInputStream(InputStream data,
 int preserve)
                                      throws TorrentException

Description copied from interface: TorrentManager

decodes a torrent encoded using the normal "bencoding" rules from an InputStream

Specified by:

createFromBEncodedInputStream in interface TorrentManager

Parameters:

data -

preserve - PRESERVE_* flags

Returns:

Throws:

TorrentException

createFromDataFile

public Torrent createFromDataFile(File data,
 URL announce_url)
                           throws TorrentException

Description copied from interface: TorrentManager

creates a new torrent from an input file

Specified by:

createFromDataFile in interface TorrentManager

Parameters:

data -

Returns:

Throws:

TorrentException

createFromDataFile

public Torrent createFromDataFile(File data,
 URL announce_url,
 boolean include_other_hashes)
                           throws TorrentException

Specified by:

createFromDataFile in interface TorrentManager

Throws:

TorrentException

createFromDataFileEx

public TorrentCreator createFromDataFileEx(File data,
 URL announce_url,
 boolean include_other_hashes)
                                    throws TorrentException

Specified by:

createFromDataFileEx in interface TorrentManager

Throws:

TorrentException

getDefinedAttributes

public TorrentAttribute[] getDefinedAttributes()

Description copied from interface: TorrentManager

Gives access to the currently defined torrent attributes. As of 2.1.0.2 only "category" is defined, however in the future more could be added such as "quality", "bit rate" etc.

Specified by:

getDefinedAttributes in interface TorrentManager

Returns:

getAttribute

public TorrentAttribute getAttribute(String name)

Description copied from interface: TorrentManager

Gives access to the standard built-in attributes

Specified by:

getAttribute in interface TorrentManager

Parameters:

name -

Returns:

getPluginAttribute

public TorrentAttribute getPluginAttribute(String name)

Description copied from interface: TorrentManager

Gives access to/creates arbitrary String attributes for plugins to use. The attribute will be specific to the plugin, so you can use short torrent names like "name", you won't need to add the plugin ID or any other sort of unique identifier to the attribute name.

Specified by:

getPluginAttribute in interface TorrentManager

Parameters:

name -

Returns:

addListener

public void addListener(TorrentManagerListener l)

Specified by:

addListener in interface TorrentManager

removeListener

public void removeListener(TorrentManagerListener l)

Specified by:

removeListener in interface TorrentManager