freenet.client

Class HighLevelSimpleClientImpl

java.lang.Object

freenet.client.HighLevelSimpleClientImpl

All Implemented Interfaces:

HighLevelSimpleClient, RequestClient, java.lang.Cloneable

public class HighLevelSimpleClientImpl
extends java.lang.Object
implements HighLevelSimpleClient, RequestClient, java.lang.Cloneable

Field Summary

Fields

Modifier and Type	Field and Description
static int	EXTRA_INSERTS_SINGLE_BLOCK
static int	EXTRA_INSERTS_SPLITFILE_HEADER
static int	SPLITFILE_BLOCKS_PER_SEGMENT
static int	SPLITFILE_CHECK_BLOCKS_PER_SEGMENT
static int	SPLITFILE_SCALING_BLOCKS_PER_SEGMENT

Constructor Summary

Constructors

Constructor and Description
HighLevelSimpleClientImpl(HighLevelSimpleClientImpl hlsc)
HighLevelSimpleClientImpl(NodeClientCore node, BucketFactory bf, RandomSource r, short priorityClass, boolean forceDontIgnoreTooManyPathComponents, boolean realTimeFlag)

Method Summary

Modifier and Type	Method and Description
void	addEventHook(ClientEventListener listener) Add a ClientEventListener.
HighLevelSimpleClientImpl	clone()
FetchResult	fetch(FreenetURI uri) Fetch a key.
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 overrideMaxSize) 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 prio) Non-blocking fetch of a URI with a configurable max-size (in bytes), context object, callback and context.
FetchResult	fetch(FreenetURI uri, long overrideMaxSize, RequestClient clientContext) Blocking fetch of a URI with a configurable max-size and context object.
FetchResult	fetchFromMetadata(Bucket initialMetadata) Fetch a key.
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 overrideMaxSize)
FetchContext	getFetchContext(long overrideMaxSize, 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, boolean isMetadata, short priority)
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, boolean isMetadata, short priority, InsertContext ctx)
FreenetURI	insert(InsertBlock insert, java.lang.String filenameHint, boolean isMetadata, short priority, InsertContext ctx, byte[] forceCryptoKey)
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 targetURI) Blocking insert of a redirect.
static FetchContext	makeDefaultFetchContext(long maxLength, long maxTempLength, BucketFactory bucketFactory, SimpleEventProducer eventProducer)
static InsertContext	makeDefaultInsertContext(BucketFactory bucketFactory, SimpleEventProducer eventProducer)
boolean	persistent() Is this request persistent? **Must not change!**
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.
boolean	realTimeFlag() Send the request with the real time flag enabled? Real-time requests are given a higher priority in data transfers, but fewer of them are accepted.
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.

Methods inherited from class java.lang.Object

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

Field Detail

SPLITFILE_SCALING_BLOCKS_PER_SEGMENT

public static final int SPLITFILE_SCALING_BLOCKS_PER_SEGMENT

See Also:

Constant Field Values

SPLITFILE_BLOCKS_PER_SEGMENT

public static final int SPLITFILE_BLOCKS_PER_SEGMENT

See Also:

Constant Field Values

SPLITFILE_CHECK_BLOCKS_PER_SEGMENT

public static final int SPLITFILE_CHECK_BLOCKS_PER_SEGMENT

See Also:

Constant Field Values

EXTRA_INSERTS_SINGLE_BLOCK

public static final int EXTRA_INSERTS_SINGLE_BLOCK

See Also:

Constant Field Values

EXTRA_INSERTS_SPLITFILE_HEADER

public static final int EXTRA_INSERTS_SPLITFILE_HEADER

See Also:

Constant Field Values

Constructor Detail

HighLevelSimpleClientImpl

public HighLevelSimpleClientImpl(NodeClientCore node,
                                 BucketFactory bf,
                                 RandomSource r,
                                 short priorityClass,
                                 boolean forceDontIgnoreTooManyPathComponents,
                                 boolean realTimeFlag)

HighLevelSimpleClientImpl

public HighLevelSimpleClientImpl(HighLevelSimpleClientImpl hlsc)

Method Detail

clone

public HighLevelSimpleClientImpl clone()

Specified by:

clone in interface HighLevelSimpleClient

Overrides:

clone in class java.lang.Object

setMaxLength

public void setMaxLength(long maxLength)

Description copied from interface: HighLevelSimpleClient

Set the maximum length of the fetched data.

Specified by:

setMaxLength in interface HighLevelSimpleClient

setMaxIntermediateLength

public void setMaxIntermediateLength(long maxIntermediateLength)

Description copied from interface: HighLevelSimpleClient

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

Specified by:

setMaxIntermediateLength in interface HighLevelSimpleClient

fetch

public FetchResult fetch(FreenetURI uri)
                  throws FetchException

Fetch a key. Either returns the data, or throws an exception.

Specified by:

fetch in interface HighLevelSimpleClient

Throws:

FetchException - If there is an error fetching the data

fetchFromMetadata

public FetchResult fetchFromMetadata(Bucket initialMetadata)
                              throws FetchException

Fetch a key. Either returns the data, or throws an exception.

Specified by:

fetchFromMetadata in interface HighLevelSimpleClient

Throws:

FetchException - If there is an error fetching the data

fetch

public FetchResult fetch(FreenetURI uri,
                         long overrideMaxSize)
                  throws FetchException

Description copied from interface: HighLevelSimpleClient

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

Specified by:

fetch in interface HighLevelSimpleClient

overrideMaxSize - 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

public FetchResult fetch(FreenetURI uri,
                         long overrideMaxSize,
                         RequestClient clientContext)
                  throws FetchException

Description copied from interface: HighLevelSimpleClient

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

Specified by:

fetch in interface HighLevelSimpleClient

clientContext - 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

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

Description copied from interface: HighLevelSimpleClient

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.

Specified by:

fetch in interface HighLevelSimpleClient

maxSize - IGNORED. FIXME DEPRECATE

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

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

Description copied from interface: HighLevelSimpleClient

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.

Specified by:

fetch in interface HighLevelSimpleClient

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.

prio - 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

fetch

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

Description copied from interface: HighLevelSimpleClient

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.

Specified by:

fetch in interface HighLevelSimpleClient

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

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

Description copied from interface: HighLevelSimpleClient

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.

Specified by:

fetchFromMetadata in interface HighLevelSimpleClient

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

insert

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

Description copied from interface: HighLevelSimpleClient

Blocking insert.

Specified by:

insert in interface HighLevelSimpleClient

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

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

Description copied from interface: HighLevelSimpleClient

Blocking insert.

Specified by:

insert in interface HighLevelSimpleClient

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

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

Throws:

InsertException

insert

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

Description copied from interface: HighLevelSimpleClient

Blocking insert.

Specified by:

insert in interface HighLevelSimpleClient

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

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

Throws:

InsertException

insert

public FreenetURI insert(InsertBlock insert,
                         java.lang.String filenameHint,
                         boolean isMetadata,
                         short priority,
                         InsertContext ctx,
                         byte[] forceCryptoKey)
                  throws InsertException

Throws:

InsertException

insert

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

Description copied from interface: HighLevelSimpleClient

Non-blocking insert.

Specified by:

insert in interface HighLevelSimpleClient

isMetadata - If true, insert metadata.

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

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.

Throws:

InsertException

insert

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

Description copied from interface: HighLevelSimpleClient

Non-blocking insert.

Specified by:

insert in interface HighLevelSimpleClient

isMetadata - If true, insert metadata.

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

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.

Throws:

InsertException

insertRedirect

public FreenetURI insertRedirect(FreenetURI insertURI,
                                 FreenetURI targetURI)
                          throws InsertException

Description copied from interface: HighLevelSimpleClient

Blocking insert of a redirect.

Specified by:

insertRedirect in interface HighLevelSimpleClient

Throws:

InsertException

insertManifest

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

Description copied from interface: HighLevelSimpleClient

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.

Specified by:

insertManifest in interface HighLevelSimpleClient

Throws:

InsertException

insertManifest

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

Description copied from interface: HighLevelSimpleClient

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.

Specified by:

insertManifest in interface HighLevelSimpleClient

Throws:

InsertException

insertManifest

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

Description copied from interface: HighLevelSimpleClient

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

Specified by:

insertManifest in interface HighLevelSimpleClient

Throws:

InsertException

addEventHook

public void addEventHook(ClientEventListener listener)

Description copied from interface: HighLevelSimpleClient

Add a ClientEventListener.

Specified by:

addEventHook in interface HighLevelSimpleClient

getFetchContext

public FetchContext getFetchContext()

Description copied from interface: HighLevelSimpleClient

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.

Specified by:

getFetchContext in interface HighLevelSimpleClient

getFetchContext

public FetchContext getFetchContext(long overrideMaxSize)

Specified by:

getFetchContext in interface HighLevelSimpleClient

getFetchContext

public FetchContext getFetchContext(long overrideMaxSize,
                                    java.lang.String schemeHostAndPort)

Specified by:

getFetchContext in interface HighLevelSimpleClient

makeDefaultFetchContext

public static FetchContext makeDefaultFetchContext(long maxLength,
                                                   long maxTempLength,
                                                   BucketFactory bucketFactory,
                                                   SimpleEventProducer eventProducer)

getInsertContext

public InsertContext getInsertContext(boolean forceNonPersistent)

Description copied from interface: HighLevelSimpleClient

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

Specified by:

getInsertContext in interface HighLevelSimpleClient

Parameters:

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

makeDefaultInsertContext

public static InsertContext makeDefaultInsertContext(BucketFactory bucketFactory,
                                                     SimpleEventProducer eventProducer)

generateKeyPair

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

Description copied from interface: HighLevelSimpleClient

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

Specified by:

generateKeyPair in interface HighLevelSimpleClient

Parameters:

docName - The document name

Returns:

An array containing the insert and request URI

prefetch

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

Description copied from interface: HighLevelSimpleClient

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

Specified by:

prefetch in interface HighLevelSimpleClient

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

prefetch

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

Description copied from interface: HighLevelSimpleClient

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

Specified by:

prefetch in interface HighLevelSimpleClient

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

persistent

public boolean persistent()

Description copied from interface: RequestClient

Is this request persistent? **Must not change!**

Specified by:

persistent in interface RequestClient

realTimeFlag

public boolean realTimeFlag()

Description copied from interface: RequestClient

Send the request with the real time flag enabled? Real-time requests are given a higher priority in data transfers, but fewer of them are accepted. They are optimised for latency rather than throughput, and are expected to be bursty rather than continual. **Must not change!**

Specified by:

realTimeFlag in interface RequestClient