freenet.client

Interface HighLevelSimpleClient

All Known Implementing Classes:

HighLevelSimpleClientImpl

public interface HighLevelSimpleClient

Method Summary

Modifier and Type	Method and Description
void	addEventHook(ClientEventListener listener) Add a ClientEventListener.
HighLevelSimpleClient	clone()
FetchResult	fetch(FreenetURI uri) Blocking fetch of a URI
ClientGetter	fetch(FreenetURI uri, ClientGetCallback callback, FetchContext fctx, short prio) Non-blocking fetch of a URI with a configurable max-size (in bytes), context object, callback and context.
FetchResult	fetch(FreenetURI uri, long maxSize) Blocking fetch of a URI with a configurable max-size.
ClientGetter	fetch(FreenetURI uri, long maxSize, ClientGetCallback callback, FetchContext fctx) Non-blocking fetch of a URI with a configurable max-size (in bytes), context object, callback and context.
ClientGetter	fetch(FreenetURI uri, long maxSize, ClientGetCallback callback, FetchContext fctx, short priorityClass) Non-blocking fetch of a URI with a configurable max-size (in bytes), context object, callback and context.
FetchResult	fetch(FreenetURI uri, long maxSize, RequestClient context) Blocking fetch of a URI with a configurable max-size and context object.
FetchResult	fetchFromMetadata(Bucket initialMetadata) Blocking fetch from metadata
ClientGetter	fetchFromMetadata(Bucket initialMetadata, ClientGetCallback callback, FetchContext fctx, short prio) Non-blocking fetch of a URI with a configurable max-size (in bytes), context object, callback and context.
FreenetURI[]	generateKeyPair(java.lang.String docName) Generates a new key pair, consisting of the insert URI at index 0 and the request URI at index 1.
FetchContext	getFetchContext() Get the FetchContext so you can customise the search process.
FetchContext	getFetchContext(long size)
FetchContext	getFetchContext(long size, java.lang.String schemeHostAndPort)
InsertContext	getInsertContext(boolean forceNonPersistent) Get an InsertContext.
FreenetURI	insert(InsertBlock insert, boolean getCHKOnly, java.lang.String filenameHint) Blocking insert.
FreenetURI	insert(InsertBlock insert, boolean getCHKOnly, java.lang.String filenameHint, short priority) Blocking insert.
ClientPutter	insert(InsertBlock insert, java.lang.String filenameHint, boolean isMetadata, InsertContext ctx, ClientPutCallback cb) Non-blocking insert.
ClientPutter	insert(InsertBlock insert, java.lang.String filenameHint, boolean isMetadata, InsertContext ctx, ClientPutCallback cb, short priority) Non-blocking insert.
FreenetURI	insert(InsertBlock insert, java.lang.String filenameHint, short priority, InsertContext ctx) Blocking insert.
FreenetURI	insertManifest(FreenetURI insertURI, java.util.HashMap<java.lang.String,java.lang.Object> bucketsByName, java.lang.String defaultName) Blocking insert of multiple files as a manifest (or zip manifest, etc).
FreenetURI	insertManifest(FreenetURI insertURI, java.util.HashMap<java.lang.String,java.lang.Object> bucketsByName, java.lang.String defaultName, short priorityClass) Blocking insert of multiple files as a manifest (or zip manifest, etc).
FreenetURI	insertManifest(FreenetURI insertURI, java.util.HashMap<java.lang.String,java.lang.Object> bucketsByName, java.lang.String defaultName, short priorityClass, byte[] forceCryptoKey) Blocking insert of multiple files as a manifest, with a crypto key override.
FreenetURI	insertRedirect(FreenetURI insertURI, FreenetURI target) Blocking insert of a redirect.
void	prefetch(FreenetURI uri, long timeout, long maxSize, java.util.Set<java.lang.String> allowedTypes) Prefetch a key at a very low priority.
void	prefetch(FreenetURI uri, long timeout, long maxSize, java.util.Set<java.lang.String> allowedTypes, short prio) Prefetch a key at the given priority.
void	setMaxIntermediateLength(long maxIntermediateLength) Set the maximum length of any intermediate data, e.g.
void	setMaxLength(long maxLength) Set the maximum length of the fetched data.

Method Detail

setMaxLength

void setMaxLength(long maxLength)

Set the maximum length of the fetched data.

setMaxIntermediateLength

void setMaxIntermediateLength(long maxIntermediateLength)

Set the maximum length of any intermediate data, e.g. ZIP manifests.

fetch

FetchResult fetch(FreenetURI uri)
           throws FetchException

Blocking fetch of a URI

Throws:

FetchException - If there is an error fetching the data

fetchFromMetadata

FetchResult fetchFromMetadata(Bucket initialMetadata)
                       throws FetchException

Blocking fetch from metadata

Throws:

FetchException - If there is an error fetching the data

fetch

FetchResult fetch(FreenetURI uri,
                  long maxSize)
           throws FetchException

Blocking fetch of a URI with a configurable max-size.

Parameters:

maxSize - The maximum size in bytes of the return data or any intermediary data processed to obtain the final output (e.g. containers).

Throws:

FetchException

fetch

FetchResult fetch(FreenetURI uri,
                  long maxSize,
                  RequestClient context)
           throws FetchException

Blocking fetch of a URI with a configurable max-size and context object.

Parameters:

context - Used mainly for scheduling, we round-robin between request clients within a given priority and retry count. Also indicates whether the request is persistent, and if so, can remove it.

Throws:

FetchException

fetch

ClientGetter fetch(FreenetURI uri,
                   ClientGetCallback callback,
                   FetchContext fctx,
                   short prio)
            throws FetchException

Non-blocking fetch of a URI with a configurable max-size (in bytes), context object, callback and context. Will return immediately, the callback will be called later.

Parameters:

callback - Will be called when the request completes, fails, etc. If the request is persistent this will be called on the database thread with a container parameter.

fctx - Fetch context so you can customise the search process.

Returns:

The ClientGetter object, which will have been started already.

Throws:

FetchException

fetchFromMetadata

ClientGetter fetchFromMetadata(Bucket initialMetadata,
                               ClientGetCallback callback,
                               FetchContext fctx,
                               short prio)
                        throws FetchException

Non-blocking fetch of a URI with a configurable max-size (in bytes), context object, callback and context. Will return immediately, the callback will be called later.

Parameters:

callback - Will be called when the request completes, fails, etc. If the request is persistent this will be called on the database thread with a container parameter.

fctx - Fetch context so you can customise the search process.

Returns:

The ClientGetter object, which will have been started already.

Throws:

FetchException

fetch

ClientGetter fetch(FreenetURI uri,
                   long maxSize,
                   ClientGetCallback callback,
                   FetchContext fctx)
            throws FetchException

Non-blocking fetch of a URI with a configurable max-size (in bytes), context object, callback and context. Will return immediately, the callback will be called later.

Parameters:

callback - Will be called when the request completes, fails, etc. If the request is persistent this will be called on the database thread with a container parameter.

fctx - Fetch context so you can customise the search process.

maxSize - IGNORED. FIXME DEPRECATE

Returns:

The ClientGetter object, which will have been started already.

Throws:

FetchException

fetch

ClientGetter fetch(FreenetURI uri,
                   long maxSize,
                   ClientGetCallback callback,
                   FetchContext fctx,
                   short priorityClass)
            throws FetchException

Non-blocking fetch of a URI with a configurable max-size (in bytes), context object, callback and context. Will return immediately, the callback will be called later.

Parameters:

callback - Will be called when the request completes, fails, etc. If the request is persistent this will be called on the database thread with a container parameter.

fctx - Fetch context so you can customise the search process.

priorityClass - What priority to start at. It is much more efficient to specify it here than to change it later.

Returns:

The ClientGetter object, which will have been started already.

Throws:

FetchException

insert

FreenetURI insert(InsertBlock insert,
                  boolean getCHKOnly,
                  java.lang.String filenameHint)
           throws InsertException

Blocking insert.

Parameters:

filenameHint - If set, insert a single-file manifest containing only this file, under the given filename.

Throws:

InsertException - If there is an error inserting the data

insert

FreenetURI insert(InsertBlock insert,
                  boolean getCHKOnly,
                  java.lang.String filenameHint,
                  short priority)
           throws InsertException

Blocking insert.

Parameters:

filenameHint - If set, insert a single-file manifest containing only this file, under the given filename.

Throws:

InsertException - If there is an error inserting the data

insert

FreenetURI insert(InsertBlock insert,
                  java.lang.String filenameHint,
                  short priority,
                  InsertContext ctx)
           throws InsertException

Blocking insert.

Parameters:

filenameHint - If set, insert a single-file manifest containing only this file, under the given filename.

Throws:

InsertException - If there is an error inserting the data

insert

ClientPutter insert(InsertBlock insert,
                    java.lang.String filenameHint,
                    boolean isMetadata,
                    InsertContext ctx,
                    ClientPutCallback cb)
             throws InsertException

Non-blocking insert.

Parameters:

isMetadata - If true, insert metadata.

cb - Will be called when the insert completes. If the request is persistent this will be called on the database thread with a container parameter.

ctx - Insert context so you can customise the insertion process.

Throws:

InsertException

insert

ClientPutter insert(InsertBlock insert,
                    java.lang.String filenameHint,
                    boolean isMetadata,
                    InsertContext ctx,
                    ClientPutCallback cb,
                    short priority)
             throws InsertException

Non-blocking insert.

Parameters:

isMetadata - If true, insert metadata.

cb - Will be called when the insert completes. If the request is persistent this will be called on the database thread with a container parameter.

ctx - Insert context so you can customise the insertion process.

Throws:

InsertException

insertRedirect

FreenetURI insertRedirect(FreenetURI insertURI,
                          FreenetURI target)
                   throws InsertException

Blocking insert of a redirect.

Throws:

InsertException

insertManifest

FreenetURI insertManifest(FreenetURI insertURI,
                          java.util.HashMap<java.lang.String,java.lang.Object> bucketsByName,
                          java.lang.String defaultName)
                   throws InsertException

Blocking insert of multiple files as a manifest (or zip manifest, etc). The map can contain either string -> bucket, string -> manifestitem or string -> map, the latter indicating subdirs.

Throws:

InsertException

insertManifest

FreenetURI insertManifest(FreenetURI insertURI,
                          java.util.HashMap<java.lang.String,java.lang.Object> bucketsByName,
                          java.lang.String defaultName,
                          short priorityClass)
                   throws InsertException

Blocking insert of multiple files as a manifest (or zip manifest, etc). The map can contain either string -> bucket, string -> manifestitem or string -> map, the latter indicating subdirs.

Throws:

InsertException

insertManifest

FreenetURI insertManifest(FreenetURI insertURI,
                          java.util.HashMap<java.lang.String,java.lang.Object> bucketsByName,
                          java.lang.String defaultName,
                          short priorityClass,
                          byte[] forceCryptoKey)
                   throws InsertException

Blocking insert of multiple files as a manifest, with a crypto key override.

Throws:

InsertException

getFetchContext

FetchContext getFetchContext()

Get the FetchContext so you can customise the search process. Has settings for all sorts of things such as how many times to retry each block, whether to follow redirects, whether to open containers, etc. IMPORTANT: This is created new for each and every request! Changing settings here will not change them on fetch()'es unless you pass the modified FetchContext in to the fetch() call.

getFetchContext

FetchContext getFetchContext(long size)

getFetchContext

FetchContext getFetchContext(long size,
                             java.lang.String schemeHostAndPort)

getInsertContext

InsertContext getInsertContext(boolean forceNonPersistent)

Get an InsertContext. Has settings for controlling the insertion process, for example which compression algorithms to try.

Parameters:

forceNonPersistent - If true, force the request to use the non-persistent bucket pool.

addEventHook

void addEventHook(ClientEventListener listener)

Add a ClientEventListener.

generateKeyPair

FreenetURI[] generateKeyPair(java.lang.String docName)

Generates a new key pair, consisting of the insert URI at index 0 and the request URI at index 1.

Parameters:

docName - The document name

Returns:

An array containing the insert and request URI

prefetch

void prefetch(FreenetURI uri,
              long timeout,
              long maxSize,
              java.util.Set<java.lang.String> allowedTypes)

Prefetch a key at a very low priority. If it hasn't been fetched within the timeout, kill the fetch.

Parameters:

allowedTypes - Kill the request if the MIME type is not one of these types. Normally null.

prefetch

void prefetch(FreenetURI uri,
              long timeout,
              long maxSize,
              java.util.Set<java.lang.String> allowedTypes,
              short prio)

Prefetch a key at the given priority. If it hasn't been fetched within the timeout, kill the fetch.

Parameters:

allowedTypes - Kill the request if the MIME type is not one of these types. Normally null.

clone

HighLevelSimpleClient clone()