com.exalead.fetchapi.client

Class FetchClient.Parameter

java.lang.Object

com.exalead.fetchapi.client.FetchClient.Parameter

Enclosing interface:

FetchClient

public static class FetchClient.Parameter
extends java.lang.Object

Untyped additional parameter. E.g. {width, 200} and {height, 300} for the thumbnail methods will resize the returned thumbnail.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ALL_PARTS Requests all parts of the document
static java.lang.String	CACHE Should the local cache be used or the evicted when trying to fetch the document.
static java.lang.String	CONTENTTYPE
static java.lang.String	DOCUMENT_LANG Preview only: document language
static java.lang.String	ENFORCE_SECURITY Should security tokens actually be enforced.
static java.lang.String	FILENAME
static java.lang.String	HEIGHT Thumbnails only: height of the image
static java.lang.String	LANG Preview only: user query language
java.lang.String	name
static java.lang.String	OVERRIDE_CONTENTTYPE Force the MIME Content-type in the Content-Disposition header.
static java.lang.String	OVERRIDE_FILENAME Force the filename in the Content-Disposition header.
static java.lang.String	PAGES HTML-preview only.
static java.lang.String	PART Selects the part of the document to retrieve.
static java.lang.String	QUERY Preview only: user query string
static java.lang.String	REWRITE_BASE Preview only: Base HTTP path for links rewriting.
static java.lang.String	SECURITY Security token for the fetch request.
static java.lang.String	SKIP_DOCUMENT_CACHE Should the document (in the fetch command) cache be skipped when trying to fetch the document.
static java.lang.String	STARTPAGE For thumbnails, page of the document to thumbnail.
java.lang.String	value
static java.lang.String	WIDTH Thumbnails only: width of the image

Constructor Summary

Constructors

Constructor and Description
Parameter(java.lang.String name, java.lang.String value)

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

name

public java.lang.String name

value

public java.lang.String value

HEIGHT

public static final java.lang.String HEIGHT

Thumbnails only: height of the image

See Also:

Constant Field Values

WIDTH

public static final java.lang.String WIDTH

Thumbnails only: width of the image

See Also:

Constant Field Values

STARTPAGE

public static final java.lang.String STARTPAGE

• For thumbnails, page of the document to thumbnail. (By default, the first page of the document is thumbnailed).
• For HTML preview, first page to render.

See Also:

Constant Field Values

PAGES

public static final java.lang.String PAGES

HTML-preview only. Number of pages of the document to render.

See Also:

Constant Field Values

QUERY

public static final java.lang.String QUERY

Preview only: user query string

See Also:

Constant Field Values

LANG

public static final java.lang.String LANG

Preview only: user query language

See Also:

Constant Field Values

DOCUMENT_LANG

public static final java.lang.String DOCUMENT_LANG

Preview only: document language

See Also:

Constant Field Values

SECURITY

public static final java.lang.String SECURITY

Security token for the fetch request. Please refer to technical reference for more details on document-level security

See Also:

Constant Field Values

ENFORCE_SECURITY

public static final java.lang.String ENFORCE_SECURITY

Should security tokens actually be enforced. Please refer to the technical reference for more details about document-level security

See Also:

Constant Field Values

CACHE

public static final java.lang.String CACHE

Should the local cache be used or the evicted when trying to fetch the document. Possible values: "false" to bypass local cache

See Also:

Constant Field Values

SKIP_DOCUMENT_CACHE

public static final java.lang.String SKIP_DOCUMENT_CACHE

Should the document (in the fetch command) cache be skipped when trying to fetch the document.

See Also:

Constant Field Values

OVERRIDE_FILENAME

public static final java.lang.String OVERRIDE_FILENAME

Force the filename in the Content-Disposition header. This is useful when the connector is unable to provide the real filename (in this case a Hit meta could be used to force the filename, for example)

See Also:

Constant Field Values

FILENAME

public static final java.lang.String FILENAME

See Also:

Constant Field Values

OVERRIDE_CONTENTTYPE

public static final java.lang.String OVERRIDE_CONTENTTYPE

Force the MIME Content-type in the Content-Disposition header. This is useful when the connector is unable to provide the real MIME Content-type (in this case a Hit meta could be used to force the MIME Content-type, for example)

See Also:

Constant Field Values

CONTENTTYPE

public static final java.lang.String CONTENTTYPE

See Also:

Constant Field Values

REWRITE_BASE

public static final java.lang.String REWRITE_BASE

Preview only: Base HTTP path for links rewriting. You should set this to the base URL under which you are proxying the preview request.

See Also:

Constant Field Values

ALL_PARTS

public static final java.lang.String ALL_PARTS

Requests all parts of the document

See Also:

Constant Field Values

PART

public static final java.lang.String PART

Selects the part of the document to retrieve.

See Also:

Constant Field Values

Constructor Detail

Parameter

public Parameter(java.lang.String name,
                 java.lang.String value)