FetchContext (fred API)

java.lang.Object
- freenet.client.FetchContext

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class FetchContext
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable
```
Context for a Fetcher. Contains all the settings a Fetcher needs to know about. FIXME these should be final or private, with getters/setters and checking for valid values e.g. maxRecursionLevel >= 1.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`java.util.Set<java.lang.String>`	`allowedMIMETypes` If non-null, the request will be stopped if it has a MIME type that is not one of these, or has no MIME type.
`boolean`	`allowSplitfiles` Whether to download splitfiles
`BlockSet`	`blocks` If set, contains a set of blocks to be consulted before checking the datastore.
`boolean`	`canWriteClientCache` Can this request write to the client-cache? We don't store all requests in the client cache, in particular big stuff usually isn't written to it, to maximise its effectiveness.
`java.lang.String`	`charset` If not-null, the request, if it requires a charset for filtration, will be assumed to use this charset
`boolean`	`dontEnterImplicitArchives`
`ClientEventProducer`	`eventProducer` Client events will be published to this, you can subscribe to them
`boolean`	`filterData`
`boolean`	`followRedirects` Whether to follow simple redirects
`static int`	`IDENTICAL_MASK`
`boolean`	`ignoreStore` If true, send the request to the network without checking whether the data is in the local store
`boolean`	`ignoreTooManyPathComponents`
`boolean`	`ignoreUSKDatehints` Ignore USK DATEHINTs
`boolean`	`localRequestOnly` If true, only read from the datastore and caches, do not send the request to the network
`int`	`maxArchiveLevels` Maximum number of manifest lookups during a request.
`int`	`maxArchiveRestarts`
`int`	`maxCheckBlocksPerSegment` Maximum number of check blocks per segment for splitfiles.
`int`	`maxDataBlocksPerSegment` Maximum number of data blocks per segment for splitfiles
`int`	`maxMetadataSize`
`int`	`maxNonSplitfileRetries` Maximum number of retries (after the original attempt) for a non-splitfile block.
`long`	`maxOutputLength` Maximum length of the final returned data
`int`	`maxRecursionLevel` 1 = only fetch a single block.
`int`	`maxSplitfileBlockRetries` Maximum number of retries (after the original attempt) for a splitfile block.
`long`	`maxTempLength` Maximum length of data fetched in order to obtain the final data - metadata, containers, etc.
`int`	`maxUSKRetries`
`java.lang.String`	`overrideMIME` Force the content fiter to use this MIME type
`FoundURICallback`	`prefetchHook` Prefetch hook for HTML documents.
`boolean`	`returnZIPManifests` If true, and we get a ZIP manifest, and we have no meta-strings left, then return the manifest contents as data.
`static int`	`SET_RETURN_ARCHIVES`
`static int`	`SPLITFILE_DEFAULT_BLOCK_MASK`
`static int`	`SPLITFILE_DEFAULT_MASK`
`TagReplacerCallback`	`tagReplacer` Callback needed for web-pushing

Constructor Summary

Constructors
Constructor and Description
`FetchContext(java.io.DataInputStream dis)` Create from a saved form, e.g.
`FetchContext(FetchContext ctx, int maskID)` Copy a FetchContext, creating a new EventProducer and not changing the blocks list.
`FetchContext(FetchContext ctx, int maskID, boolean keepProducer, BlockSet blocks)` Copy a FetchContext.
FetchContext(long curMaxLength, long curMaxTempLength, int maxMetadataSize, int maxRecursionLevel, int maxArchiveRestarts, int maxArchiveLevels, boolean dontEnterImplicitArchives, int maxSplitfileBlockRetries, int maxNonSplitfileRetries, int maxUSKRetries, boolean allowSplitfiles, boolean followRedirects, boolean localRequestOnly, boolean filterData, int maxDataBlocksPerSegment, int maxCheckBlocksPerSegment, BucketFactory bucketFactory, ClientEventProducer producer, boolean ignoreTooManyPathComponents, boolean canWriteClientCache, java.lang.String charset, java.lang.String overrideMIME, java.lang.String schemeHostAndPort)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FetchContext`	`clone()` Make public, but just call parent for a field for field copy
`boolean`	`equals(java.lang.Object obj)` Are two InsertContext's equal? Ignores the EventProducer, compares only the actual config values.
`int`	`getCooldownRetries()`
`long`	`getCooldownTime()`
`java.lang.String`	`getSchemeHostAndPort()`
`int`	`hashCode()`
`void`	`setCooldownRetries(int cooldownRetries)`
`void`	`setCooldownTime(long cooldownTime)` Set the cooldown time
`void`	`setCooldownTime(long cooldownTime, boolean force)` Only for tests
`void`	`writeTo(java.io.DataOutputStream dos)`

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - IDENTICAL_MASK
```
public static final int IDENTICAL_MASK
```
    See Also:
    
    Constant Field Values
  - SPLITFILE_DEFAULT_BLOCK_MASK
```
public static final int SPLITFILE_DEFAULT_BLOCK_MASK
```
    See Also:
    
    Constant Field Values
  - SPLITFILE_DEFAULT_MASK
```
public static final int SPLITFILE_DEFAULT_MASK
```
    See Also:
    
    Constant Field Values
  - SET_RETURN_ARCHIVES
```
public static final int SET_RETURN_ARCHIVES
```
    See Also:
    
    Constant Field Values
  - maxOutputLength
```
public long maxOutputLength
```
    Maximum length of the final returned data
  - maxTempLength
```
public long maxTempLength
```
    Maximum length of data fetched in order to obtain the final data - metadata, containers, etc.
  - maxRecursionLevel
```
public int maxRecursionLevel
```
    1 = only fetch a single block. 2 = allow one redirect, e.g. metadata block pointing to actual data block. Etc. 0 may work sometimes but is not recommended.
  - maxArchiveRestarts
```
public int maxArchiveRestarts
```
  - maxArchiveLevels
```
public int maxArchiveLevels
```
    Maximum number of manifest lookups during a request. A manifest lookup is looking up a part of a pathname in a "manifest", which is essentially a directory (folder). Usually manifest lookups are inside containers (archives), which are usually tar files, which may or may not be compressed (compression occurs transparently on a different level). This is not necessarily the same as the number of slashes in the key after the part for the key itself, since keys can redirect to other keys. If you are fetching user-uploaded keys, e.g. in fproxy, especially freesites, you will want this to be non-zero. However if you are using keys only internally, and never upload freesites, you should set this to 0.
    
    See Also:
    
    where this is enforced.
  - dontEnterImplicitArchives
```
public boolean dontEnterImplicitArchives
```
  - maxSplitfileBlockRetries
```
public int maxSplitfileBlockRetries
```
    Maximum number of retries (after the original attempt) for a splitfile block. -1 = try forever or until success or a fatal error. A fatal error is either an internal error (problem with the node) or something resulting from the original data being corrupt as inserted. So with retries = -1 we will not report Data not found, Route not found, All data not found, etc, because these are nonfatal errors and we will retry. Note that after every 3 attempts the request is put on the cooldown queue for 30 minutes, so the cost of retries = -1 is really not that high.
  - maxNonSplitfileRetries
```
public int maxNonSplitfileRetries
```
    Maximum number of retries (after the original attempt) for a non-splitfile block. -1 = try forever or until success or a fatal error.. -1 = try forever or until success or a fatal error. A fatal error is either an internal error (problem with the node) or something resulting from the original data being corrupt as inserted. So with retries = -1 we will not report Data not found, Route not found, All data not found, etc, because these are nonfatal errors and we will retry. Note that after every 3 attempts the request is put on the cooldown queue for 30 minutes, so the cost of retries = -1 is really not that high.
  - maxUSKRetries
```
public final int maxUSKRetries
```
  - allowSplitfiles
```
public boolean allowSplitfiles
```
    Whether to download splitfiles
  - followRedirects
```
public boolean followRedirects
```
    Whether to follow simple redirects
  - localRequestOnly
```
public boolean localRequestOnly
```
    If true, only read from the datastore and caches, do not send the request to the network
  - ignoreStore
```
public boolean ignoreStore
```
    If true, send the request to the network without checking whether the data is in the local store
  - eventProducer
```
public final ClientEventProducer eventProducer
```
    Client events will be published to this, you can subscribe to them
  - maxMetadataSize
```
public int maxMetadataSize
```
  - maxDataBlocksPerSegment
```
public int maxDataBlocksPerSegment
```
    Maximum number of data blocks per segment for splitfiles
  - maxCheckBlocksPerSegment
```
public int maxCheckBlocksPerSegment
```
    Maximum number of check blocks per segment for splitfiles.
  - returnZIPManifests
```
public boolean returnZIPManifests
```
    If true, and we get a ZIP manifest, and we have no meta-strings left, then return the manifest contents as data.
  - filterData
```
public boolean filterData
```
  - ignoreTooManyPathComponents
```
public final boolean ignoreTooManyPathComponents
```
  - blocks
```
public final BlockSet blocks
```
    If set, contains a set of blocks to be consulted before checking the datastore.
  - allowedMIMETypes
```
public java.util.Set<java.lang.String> allowedMIMETypes
```
    If non-null, the request will be stopped if it has a MIME type that is not one of these, or has no MIME type.
  - charset
```
public java.lang.String charset
```
    If not-null, the request, if it requires a charset for filtration, will be assumed to use this charset
  - canWriteClientCache
```
public boolean canWriteClientCache
```
    Can this request write to the client-cache? We don't store all requests in the client cache, in particular big stuff usually isn't written to it, to maximise its effectiveness.
  - prefetchHook
```
public FoundURICallback prefetchHook
```
    Prefetch hook for HTML documents. Only really necessary for FProxy's web-pushing
  - tagReplacer
```
public TagReplacerCallback tagReplacer
```
    Callback needed for web-pushing
  - overrideMIME
```
public java.lang.String overrideMIME
```
    Force the content fiter to use this MIME type
  - ignoreUSKDatehints
```
public boolean ignoreUSKDatehints
```
    Ignore USK DATEHINTs
- Constructor Detail
  - FetchContext
```
public FetchContext(long curMaxLength,
                    long curMaxTempLength,
                    int maxMetadataSize,
                    int maxRecursionLevel,
                    int maxArchiveRestarts,
                    int maxArchiveLevels,
                    boolean dontEnterImplicitArchives,
                    int maxSplitfileBlockRetries,
                    int maxNonSplitfileRetries,
                    int maxUSKRetries,
                    boolean allowSplitfiles,
                    boolean followRedirects,
                    boolean localRequestOnly,
                    boolean filterData,
                    int maxDataBlocksPerSegment,
                    int maxCheckBlocksPerSegment,
                    BucketFactory bucketFactory,
                    ClientEventProducer producer,
                    boolean ignoreTooManyPathComponents,
                    boolean canWriteClientCache,
                    java.lang.String charset,
                    java.lang.String overrideMIME,
                    java.lang.String schemeHostAndPort)
```
  - FetchContext
```
public FetchContext(FetchContext ctx,
                    int maskID)
```
    Copy a FetchContext, creating a new EventProducer and not changing the blocks list.
    
    Parameters:
    
    ctx - The old FetchContext to copy.
    
    maskID - Mask mode for the copy operation e.g. SPLITFILE_DEFAULT_BLOCK_MASK.
  - FetchContext
```
public FetchContext(FetchContext ctx,
                    int maskID,
                    boolean keepProducer,
                    BlockSet blocks)
```
    Copy a FetchContext.
    
    Parameters:
    
    ctx - The old FetchContext to copy.
    
    maskID - Mask mode for the copy operation e.g. SPLITFILE_DEFAULT_BLOCK_MASK.
    
    keepProducer - If true, keep the existing EventProducer. Must be false if we are creating a new request. Can be true if we are masking the FetchContext within a single request, e.g. to download a container. This is important so that we see the progress updates for the request and not for other requests sharing the FetchContext, but also it could break serialization.
    
    blocks - Storing a BlockSet to the database is not supported, see comments on SimpleBlockSet.objectCanNew().
  - FetchContext
```
public FetchContext(java.io.DataInputStream dis)
             throws StorageFormatException,
                    java.io.IOException
```
    Create from a saved form, e.g. for restarting a request from scratch. Will create its own SimpleEventProducer.
    
    Parameters:
    
    dis -
    
    Throws:
    
    StorageFormatException - If the data is badly formatted or cannot be read.
    
    java.io.IOException - If unable to read from the stream.
- Method Detail
  - clone
```
public FetchContext clone()
```
    Make public, but just call parent for a field for field copy
    
    Overrides:
    
    clone in class java.lang.Object
  - setCooldownRetries
```
public void setCooldownRetries(int cooldownRetries)
```
  - setCooldownTime
```
public void setCooldownTime(long cooldownTime)
```
    Set the cooldown time
  - setCooldownTime
```
public void setCooldownTime(long cooldownTime,
                            boolean force)
```
    Only for tests
  - getCooldownRetries
```
public int getCooldownRetries()
```
  - getSchemeHostAndPort
```
public java.lang.String getSchemeHostAndPort()
```
  - getCooldownTime
```
public long getCooldownTime()
```
  - writeTo
```
public void writeTo(java.io.DataOutputStream dos)
             throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Are two InsertContext's equal? Ignores the EventProducer, compares only the actual config values.
    
    Overrides:
    
    equals in class java.lang.Object

Class FetchContext

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

IDENTICAL_MASK

SPLITFILE_DEFAULT_BLOCK_MASK

SPLITFILE_DEFAULT_MASK

SET_RETURN_ARCHIVES

maxOutputLength

maxTempLength

maxRecursionLevel

maxArchiveRestarts

maxArchiveLevels

dontEnterImplicitArchives

maxSplitfileBlockRetries

maxNonSplitfileRetries

maxUSKRetries

allowSplitfiles

followRedirects

localRequestOnly

ignoreStore

eventProducer

maxMetadataSize

maxDataBlocksPerSegment

maxCheckBlocksPerSegment

returnZIPManifests

filterData

ignoreTooManyPathComponents

blocks

allowedMIMETypes

charset

canWriteClientCache

prefetchHook

tagReplacer

overrideMIME

ignoreUSKDatehints

Constructor Detail

FetchContext

FetchContext

FetchContext

FetchContext

Method Detail

clone

setCooldownRetries

setCooldownTime

setCooldownTime

getCooldownRetries

getSchemeHostAndPort

getCooldownTime

writeTo

hashCode

equals