org.gudy.azureus2.core3.download
Interface DownloadManagerState

All Known Implementing Classes:
DownloadManagerStateImpl, DownloadManagerStateImpl.nullState, LWSDiskManagerState

public interface DownloadManagerState

Author:
parg

Field Summary
static String AT_AGGREGATE_SCRAPE_CACHE
           
static String AT_AVAIL_BAD_TIME
           
static String AT_CANONICAL_SD_DMAP
           
static String AT_CATEGORY
           
static String AT_COMPLETE_LAST_TIME
           
static String AT_DISPLAY_NAME
           
static String AT_DL_FILE_ALERTS
           
static String AT_DND_PREFIX
           
static String AT_DND_SUBFOLDER
           
static String AT_FILE_DOWNLOADED
           
static String AT_FILE_LINKS_DEPRECATED
           
static String AT_FILE_LINKS2
           
static String AT_FILE_OTHER_HASHES
           
static String AT_FILE_STORE_TYPES
           
static String AT_FILES_EXPANDED
           
static String AT_FLAGS
           
static String AT_INCOMP_FILE_SUFFIX
           
static String AT_LAST_ADDED_TO_ACTIVE_TAG
           
static String AT_MD_INFO_DICT_SIZE
           
static String AT_MERGED_DATA
           
static String AT_NETWORKS
           
static String AT_PARAMETERS
           
static String AT_PEAK_RECEIVE_RATE
           
static String AT_PEAK_SEND_RATE
           
static String AT_PEER_SOURCES
           
static String AT_PEER_SOURCES_DENIED
           
static String AT_PRIMARY_FILE
           
static String AT_PRIMARY_FILE_IDX
           
static String AT_RELATIVE_SAVE_PATH
           
static String AT_REORDER_MIN_MB
           
static String AT_RESUME_STATE
           
static String AT_SCRAPE_CACHE
           
static String AT_SCRAPE_CACHE_SOURCE
           
static String AT_SECRETS
           
static String AT_SHARE_RATIO_PROGRESS
           
static String AT_TIME_SINCE_DOWNLOAD
           
static String AT_TIME_SINCE_UPLOAD
           
static String AT_TIME_STOPPED
           
static String AT_TRACKER_CLIENT_EXTENSIONS
           
static String AT_USER
           
static String AT_USER_COMMENT
           
static String AT_VERSION
           
static Object[][] ATTRIBUTE_DEFAULTS
           
static int DEFAULT_MAX_UPLOADS
           
static int DEFAULT_UPLOAD_PRIORITY
           
static long FLAG_ALLOW_PERMITTED_PEER_SOURCE_CHANGES
           
static long FLAG_DISABLE_AUTO_FILE_MOVE
           
static long FLAG_DISABLE_IP_FILTER
           
static long FLAG_DO_NOT_DELETE_DATA_ON_REMOVE
           
static long FLAG_ERROR_REPORTED
           
static long FLAG_FORCE_DIRECT_DELETE
           
static long FLAG_INITIAL_NETWORKS_SET
           
static long FLAG_LOW_NOISE
           
static long FLAG_METADATA_DOWNLOAD
           
static long FLAG_MOVE_ON_COMPLETION_DONE
           
static long FLAG_ONLY_EVER_SEEDED
           
static long FLAG_SCAN_INCOMPLETE_PIECES
           
static int MIN_MAX_UPLOADS
           
static String PARAM_DND_FLAGS
           
static String PARAM_DOWNLOAD_ADDED_TIME
           
static String PARAM_DOWNLOAD_COMPLETED_TIME
           
static String PARAM_DOWNLOAD_FILE_COMPLETED_TIME
           
static String PARAM_DOWNLOAD_LAST_ACTIVE_TIME
           
static String PARAM_MAX_PEERS
           
static String PARAM_MAX_PEERS_WHEN_SEEDING
           
static String PARAM_MAX_PEERS_WHEN_SEEDING_ENABLED
           
static String PARAM_MAX_SEEDS
           
static String PARAM_MAX_SHARE_RATIO
           
static String PARAM_MAX_UPLOAD_WHEN_BUSY
           
static String PARAM_MAX_UPLOADS
           
static String PARAM_MAX_UPLOADS_WHEN_SEEDING
           
static String PARAM_MAX_UPLOADS_WHEN_SEEDING_ENABLED
           
static String PARAM_MIN_SHARE_RATIO
           
static String PARAM_RANDOM_SEED
           
static String PARAM_STATS_COUNTED
           
static String PARAM_UPLOAD_PRIORITY
           
static Object[][] PARAMETERS
           
 
Method Summary
 void addListener(DownloadManagerStateAttributeListener l, String attribute, int event_type)
           
 void addListener(DownloadManagerStateListener l)
           
 void clearFileLinks()
           
 void clearResumeData()
           
 void clearTrackerResponseCache()
           
 void delete()
          deletes the saved state
 void discardFluff()
           
 void dump(IndentWriter writer)
           
 boolean exportState(File target_dir)
           
 void generateEvidence(IndentWriter writer)
           
 String getAttribute(String name)
           
 boolean getBooleanAttribute(String name)
           
 boolean getBooleanParameter(String name)
           
 Category getCategory()
           
 String getDisplayName()
           
 DownloadManager getDownloadManager()
           
 File getFileLink(int source_index, File link_source)
           
 LinkFileMap getFileLinks()
          returns a File -> File map of the defined links (empty if no links)
 boolean getFlag(long flag)
           
 long getFlags()
           
 int getIntAttribute(String name)
           
 int getIntParameter(String name)
           
 String[] getListAttribute(String name)
           
 String getListAttribute(String name, int idx)
           
 long getLongAttribute(String name)
           
 long getLongParameter(String name)
           
 Map getMapAttribute(String name)
           
 String[] getNetworks()
           
 String[] getPeerSources()
           
 DiskManagerFileInfo getPrimaryFile()
           
 String getRelativeSavePath()
           
 Map getResumeData()
           
 File getStateFile()
           
 TOTorrent getTorrent()
           
 String getTrackerClientExtensions()
           
 Map getTrackerResponseCache()
           
 String getUserComment()
           
 boolean hasAttribute(String name)
           
 boolean isNetworkEnabled(String network)
           
 boolean isOurContent()
           
 boolean isPeerSourceEnabled(String peerSource)
           
 boolean isPeerSourcePermitted(String peerSource)
           
 boolean isResumeDataComplete()
           
 boolean parameterExists(String name)
           
 void removeListener(DownloadManagerStateAttributeListener l, String attribute, int event_type)
           
 void removeListener(DownloadManagerStateListener l)
           
 void save()
           
 void setActive(boolean active)
           
 void setAttribute(String name, String value)
           
 void setBooleanAttribute(String name, boolean value)
           
 void setBooleanParameter(String name, boolean value)
           
 void setCategory(Category cat)
           
 void setDisplayName(String name)
           
 void setFileLink(int source_index, File link_source, File link_destination)
           
 void setFileLinks(List<Integer> source_indexes, List<File> link_sources, List<File> link_destinations)
           
 void setFlag(long flag, boolean set)
           
 void setIntAttribute(String name, int value)
           
 void setIntParameter(String name, int value)
           
 void setListAttribute(String name, String[] values)
           
 void setLongAttribute(String name, long value)
           
 void setLongParameter(String name, long value)
           
 void setMapAttribute(String name, Map value)
           
 void setNetworkEnabled(String network, boolean enabled)
           
 void setNetworks(String[] networks)
           
 void setParameterDefault(String name)
          Reset to default value
 void setPeerSourceEnabled(String source, boolean enabled)
           
 void setPeerSourcePermitted(String peerSource, boolean permitted)
           
 void setPeerSources(String[] sources)
           
 void setPrimaryFile(DiskManagerFileInfo dmfi)
           
 void setResumeData(Map data)
           
 void setTrackerClientExtensions(String value)
           
 void setTrackerResponseCache(Map value)
           
 void setUserComment(String name)
           
 void suppressStateSave(boolean suppress)
          This method should only be invoked in matching try-finally pairs.
 

Field Detail

AT_VERSION

static final String AT_VERSION
See Also:
Constant Field Values

AT_CATEGORY

static final String AT_CATEGORY
See Also:
Constant Field Values

AT_NETWORKS

static final String AT_NETWORKS
See Also:
Constant Field Values

AT_USER

static final String AT_USER
See Also:
Constant Field Values

AT_PEER_SOURCES

static final String AT_PEER_SOURCES
See Also:
Constant Field Values

AT_PEER_SOURCES_DENIED

static final String AT_PEER_SOURCES_DENIED
See Also:
Constant Field Values

AT_TRACKER_CLIENT_EXTENSIONS

static final String AT_TRACKER_CLIENT_EXTENSIONS
See Also:
Constant Field Values

AT_FILE_LINKS_DEPRECATED

static final String AT_FILE_LINKS_DEPRECATED
See Also:
Constant Field Values

AT_FILE_LINKS2

static final String AT_FILE_LINKS2
See Also:
Constant Field Values

AT_FILE_STORE_TYPES

static final String AT_FILE_STORE_TYPES
See Also:
Constant Field Values

AT_FILE_DOWNLOADED

static final String AT_FILE_DOWNLOADED
See Also:
Constant Field Values

AT_FLAGS

static final String AT_FLAGS
See Also:
Constant Field Values

AT_PARAMETERS

static final String AT_PARAMETERS
See Also:
Constant Field Values

AT_DISPLAY_NAME

static final String AT_DISPLAY_NAME
See Also:
Constant Field Values

AT_USER_COMMENT

static final String AT_USER_COMMENT
See Also:
Constant Field Values

AT_RELATIVE_SAVE_PATH

static final String AT_RELATIVE_SAVE_PATH
See Also:
Constant Field Values

AT_SECRETS

static final String AT_SECRETS
See Also:
Constant Field Values

AT_RESUME_STATE

static final String AT_RESUME_STATE
See Also:
Constant Field Values

AT_PRIMARY_FILE

static final String AT_PRIMARY_FILE
See Also:
Constant Field Values

AT_PRIMARY_FILE_IDX

static final String AT_PRIMARY_FILE_IDX
See Also:
Constant Field Values

AT_TIME_SINCE_DOWNLOAD

static final String AT_TIME_SINCE_DOWNLOAD
See Also:
Constant Field Values

AT_TIME_SINCE_UPLOAD

static final String AT_TIME_SINCE_UPLOAD
See Also:
Constant Field Values

AT_AVAIL_BAD_TIME

static final String AT_AVAIL_BAD_TIME
See Also:
Constant Field Values

AT_TIME_STOPPED

static final String AT_TIME_STOPPED
See Also:
Constant Field Values

AT_INCOMP_FILE_SUFFIX

static final String AT_INCOMP_FILE_SUFFIX
See Also:
Constant Field Values

AT_SCRAPE_CACHE

static final String AT_SCRAPE_CACHE
See Also:
Constant Field Values

AT_SCRAPE_CACHE_SOURCE

static final String AT_SCRAPE_CACHE_SOURCE
See Also:
Constant Field Values

AT_REORDER_MIN_MB

static final String AT_REORDER_MIN_MB
See Also:
Constant Field Values

AT_MD_INFO_DICT_SIZE

static final String AT_MD_INFO_DICT_SIZE
See Also:
Constant Field Values

AT_FILE_OTHER_HASHES

static final String AT_FILE_OTHER_HASHES
See Also:
Constant Field Values

AT_CANONICAL_SD_DMAP

static final String AT_CANONICAL_SD_DMAP
See Also:
Constant Field Values

AT_DND_SUBFOLDER

static final String AT_DND_SUBFOLDER
See Also:
Constant Field Values

AT_PEAK_RECEIVE_RATE

static final String AT_PEAK_RECEIVE_RATE
See Also:
Constant Field Values

AT_PEAK_SEND_RATE

static final String AT_PEAK_SEND_RATE
See Also:
Constant Field Values

AT_DL_FILE_ALERTS

static final String AT_DL_FILE_ALERTS
See Also:
Constant Field Values

AT_SHARE_RATIO_PROGRESS

static final String AT_SHARE_RATIO_PROGRESS
See Also:
Constant Field Values

AT_FILES_EXPANDED

static final String AT_FILES_EXPANDED
See Also:
Constant Field Values

AT_MERGED_DATA

static final String AT_MERGED_DATA
See Also:
Constant Field Values

AT_DND_PREFIX

static final String AT_DND_PREFIX
See Also:
Constant Field Values

AT_AGGREGATE_SCRAPE_CACHE

static final String AT_AGGREGATE_SCRAPE_CACHE
See Also:
Constant Field Values

AT_COMPLETE_LAST_TIME

static final String AT_COMPLETE_LAST_TIME
See Also:
Constant Field Values

AT_LAST_ADDED_TO_ACTIVE_TAG

static final String AT_LAST_ADDED_TO_ACTIVE_TAG
See Also:
Constant Field Values

ATTRIBUTE_DEFAULTS

static final Object[][] ATTRIBUTE_DEFAULTS

FLAG_ONLY_EVER_SEEDED

static final long FLAG_ONLY_EVER_SEEDED
See Also:
Constant Field Values

FLAG_SCAN_INCOMPLETE_PIECES

static final long FLAG_SCAN_INCOMPLETE_PIECES
See Also:
Constant Field Values

FLAG_DISABLE_AUTO_FILE_MOVE

static final long FLAG_DISABLE_AUTO_FILE_MOVE
See Also:
Constant Field Values

FLAG_MOVE_ON_COMPLETION_DONE

static final long FLAG_MOVE_ON_COMPLETION_DONE
See Also:
Constant Field Values

FLAG_LOW_NOISE

static final long FLAG_LOW_NOISE
See Also:
Constant Field Values

FLAG_ALLOW_PERMITTED_PEER_SOURCE_CHANGES

static final long FLAG_ALLOW_PERMITTED_PEER_SOURCE_CHANGES
See Also:
Constant Field Values

FLAG_DO_NOT_DELETE_DATA_ON_REMOVE

static final long FLAG_DO_NOT_DELETE_DATA_ON_REMOVE
See Also:
Constant Field Values

FLAG_FORCE_DIRECT_DELETE

static final long FLAG_FORCE_DIRECT_DELETE
See Also:
Constant Field Values

FLAG_DISABLE_IP_FILTER

static final long FLAG_DISABLE_IP_FILTER
See Also:
Constant Field Values

FLAG_METADATA_DOWNLOAD

static final long FLAG_METADATA_DOWNLOAD
See Also:
Constant Field Values

FLAG_ERROR_REPORTED

static final long FLAG_ERROR_REPORTED
See Also:
Constant Field Values

FLAG_INITIAL_NETWORKS_SET

static final long FLAG_INITIAL_NETWORKS_SET
See Also:
Constant Field Values

PARAM_MAX_PEERS

static final String PARAM_MAX_PEERS
See Also:
Constant Field Values

PARAM_MAX_PEERS_WHEN_SEEDING

static final String PARAM_MAX_PEERS_WHEN_SEEDING
See Also:
Constant Field Values

PARAM_MAX_PEERS_WHEN_SEEDING_ENABLED

static final String PARAM_MAX_PEERS_WHEN_SEEDING_ENABLED
See Also:
Constant Field Values

PARAM_MAX_SEEDS

static final String PARAM_MAX_SEEDS
See Also:
Constant Field Values

PARAM_MAX_UPLOADS

static final String PARAM_MAX_UPLOADS
See Also:
Constant Field Values

PARAM_MAX_UPLOADS_WHEN_SEEDING

static final String PARAM_MAX_UPLOADS_WHEN_SEEDING
See Also:
Constant Field Values

PARAM_MAX_UPLOADS_WHEN_SEEDING_ENABLED

static final String PARAM_MAX_UPLOADS_WHEN_SEEDING_ENABLED
See Also:
Constant Field Values

PARAM_STATS_COUNTED

static final String PARAM_STATS_COUNTED
See Also:
Constant Field Values

PARAM_DOWNLOAD_ADDED_TIME

static final String PARAM_DOWNLOAD_ADDED_TIME
See Also:
Constant Field Values

PARAM_DOWNLOAD_COMPLETED_TIME

static final String PARAM_DOWNLOAD_COMPLETED_TIME
See Also:
Constant Field Values

PARAM_DOWNLOAD_FILE_COMPLETED_TIME

static final String PARAM_DOWNLOAD_FILE_COMPLETED_TIME
See Also:
Constant Field Values

PARAM_DOWNLOAD_LAST_ACTIVE_TIME

static final String PARAM_DOWNLOAD_LAST_ACTIVE_TIME
See Also:
Constant Field Values

PARAM_MAX_UPLOAD_WHEN_BUSY

static final String PARAM_MAX_UPLOAD_WHEN_BUSY
See Also:
Constant Field Values

PARAM_DND_FLAGS

static final String PARAM_DND_FLAGS
See Also:
Constant Field Values

PARAM_RANDOM_SEED

static final String PARAM_RANDOM_SEED
See Also:
Constant Field Values

PARAM_UPLOAD_PRIORITY

static final String PARAM_UPLOAD_PRIORITY
See Also:
Constant Field Values

PARAM_MIN_SHARE_RATIO

static final String PARAM_MIN_SHARE_RATIO
See Also:
Constant Field Values

PARAM_MAX_SHARE_RATIO

static final String PARAM_MAX_SHARE_RATIO
See Also:
Constant Field Values

DEFAULT_MAX_UPLOADS

static final int DEFAULT_MAX_UPLOADS
See Also:
Constant Field Values

MIN_MAX_UPLOADS

static final int MIN_MAX_UPLOADS
See Also:
Constant Field Values

DEFAULT_UPLOAD_PRIORITY

static final int DEFAULT_UPLOAD_PRIORITY
See Also:
Constant Field Values

PARAMETERS

static final Object[][] PARAMETERS
Method Detail

getTorrent

TOTorrent getTorrent()

getDownloadManager

DownloadManager getDownloadManager()

getStateFile

File getStateFile()

setFlag

void setFlag(long flag,
             boolean set)

getFlag

boolean getFlag(long flag)

getFlags

long getFlags()

setParameterDefault

void setParameterDefault(String name)
Reset to default value

Parameters:
name -

getIntParameter

int getIntParameter(String name)

setIntParameter

void setIntParameter(String name,
                     int value)

getLongParameter

long getLongParameter(String name)

setLongParameter

void setLongParameter(String name,
                      long value)

getBooleanParameter

boolean getBooleanParameter(String name)

setBooleanParameter

void setBooleanParameter(String name,
                         boolean value)

clearResumeData

void clearResumeData()

getResumeData

Map getResumeData()

setResumeData

void setResumeData(Map data)

isResumeDataComplete

boolean isResumeDataComplete()

clearTrackerResponseCache

void clearTrackerResponseCache()

getTrackerResponseCache

Map getTrackerResponseCache()

setTrackerResponseCache

void setTrackerResponseCache(Map value)

getCategory

Category getCategory()

setCategory

void setCategory(Category cat)

getDisplayName

String getDisplayName()

setDisplayName

void setDisplayName(String name)

getUserComment

String getUserComment()

setUserComment

void setUserComment(String name)

getRelativeSavePath

String getRelativeSavePath()

setPrimaryFile

void setPrimaryFile(DiskManagerFileInfo dmfi)

getPrimaryFile

DiskManagerFileInfo getPrimaryFile()

getTrackerClientExtensions

String getTrackerClientExtensions()

setTrackerClientExtensions

void setTrackerClientExtensions(String value)

getNetworks

String[] getNetworks()

isNetworkEnabled

boolean isNetworkEnabled(String network)

setNetworks

void setNetworks(String[] networks)

setNetworkEnabled

void setNetworkEnabled(String network,
                       boolean enabled)

getPeerSources

String[] getPeerSources()

isPeerSourcePermitted

boolean isPeerSourcePermitted(String peerSource)

setPeerSourcePermitted

void setPeerSourcePermitted(String peerSource,
                            boolean permitted)

isPeerSourceEnabled

boolean isPeerSourceEnabled(String peerSource)

setPeerSources

void setPeerSources(String[] sources)

setPeerSourceEnabled

void setPeerSourceEnabled(String source,
                          boolean enabled)

setFileLink

void setFileLink(int source_index,
                 File link_source,
                 File link_destination)

setFileLinks

void setFileLinks(List<Integer> source_indexes,
                  List<File> link_sources,
                  List<File> link_destinations)

clearFileLinks

void clearFileLinks()

getFileLink

File getFileLink(int source_index,
                 File link_source)

getFileLinks

LinkFileMap getFileLinks()
returns a File -> File map of the defined links (empty if no links)

Returns:

isOurContent

boolean isOurContent()
Returns:

setAttribute

void setAttribute(String name,
                  String value)

getAttribute

String getAttribute(String name)

setMapAttribute

void setMapAttribute(String name,
                     Map value)

getMapAttribute

Map getMapAttribute(String name)

setListAttribute

void setListAttribute(String name,
                      String[] values)

getListAttribute

String[] getListAttribute(String name)

getListAttribute

String getListAttribute(String name,
                        int idx)

setIntAttribute

void setIntAttribute(String name,
                     int value)

getIntAttribute

int getIntAttribute(String name)

setLongAttribute

void setLongAttribute(String name,
                      long value)

getLongAttribute

long getLongAttribute(String name)

setBooleanAttribute

void setBooleanAttribute(String name,
                         boolean value)

getBooleanAttribute

boolean getBooleanAttribute(String name)

hasAttribute

boolean hasAttribute(String name)

setActive

void setActive(boolean active)

discardFluff

void discardFluff()

save

void save()

exportState

boolean exportState(File target_dir)

delete

void delete()
deletes the saved state


addListener

void addListener(DownloadManagerStateListener l)

removeListener

void removeListener(DownloadManagerStateListener l)

parameterExists

boolean parameterExists(String name)
Parameters:
name -
Returns:

generateEvidence

void generateEvidence(IndentWriter writer)

dump

void dump(IndentWriter writer)

suppressStateSave

void suppressStateSave(boolean suppress)
This method should only be invoked in matching try-finally pairs. If it is invoked with true multiple times it must be invoked with false the equal amount of times to reallow state writes

Parameters:
suppress - when set to true prevents flushing of the state/increments the internal nesting counter, decrements/allows flush otherwise

addListener

void addListener(DownloadManagerStateAttributeListener l,
                 String attribute,
                 int event_type)

removeListener

void removeListener(DownloadManagerStateAttributeListener l,
                    String attribute,
                    int event_type)