com.exalead.mercury.mami.connect.v10

Class SourceFetchConfig

java.lang.Object

com.exalead.mercury.mami.connect.v10.SourceFetchConfig

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

public class SourceFetchConfig
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable

Defines how source documents are "fetched" for download, preview and thumbnails

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
boolean	allowRawDocumentFetch
java.lang.String	customFetcherClass
java.lang.String	customFetcherUrl
static boolean	DEFAULT_ALLOW_RAW_DOCUMENT_FETCH
java.lang.String	fetchProtocol

Constructor Summary

Constructors

Constructor and Description
SourceFetchConfig()
SourceFetchConfig(SourceFetchConfig o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this SourceFetchConfig.
static SourceFetchConfig	fromString(java.lang.String s) String representation of this SourceFetchConfig.
java.lang.String	getCustomFetcherClass()
java.lang.String	getCustomFetcherUrl() Base URL used for retrieving documents from this connector. This is used for preview, thumbnails and raw fetch from the search results. For unmanaged connectors, this is always used. For managed connectors, if this parameter is given, it completely replaces the retriever within the connectors server.
java.lang.String	getFetchProtocol() Protocol implemented by the customFetcherURL. One of v1, v2, rpv3, or networkRetriever
boolean	isAllowRawDocumentFetch()
SourceFetchConfig	makeCopy() Creates and returns a deep copy of this SourceFetchConfig.
static SourceFetchConfig	readFrom(java.io.InputStream is) Read this SourceFetchConfig from an XML fragment.
void	setAllowRawDocumentFetch(boolean allowRawDocumentFetch)
void	setCustomFetcherClass(java.lang.String customFetcherClass)
void	setCustomFetcherUrl(java.lang.String customFetcherUrl) Base URL used for retrieving documents from this connector. This is used for preview, thumbnails and raw fetch from the search results. For unmanaged connectors, this is always used. For managed connectors, if this parameter is given, it completely replaces the retriever within the connectors server.
void	setFetchProtocol(java.lang.String fetchProtocol) Protocol implemented by the customFetcherURL. One of v1, v2, rpv3, or networkRetriever
java.lang.String	toString() String representation of this SourceFetchConfig.
SourceFetchConfig	withAllowRawDocumentFetch(boolean allowRawDocumentFetch)
SourceFetchConfig	withAllowRawDocumentFetch(java.lang.Boolean allowRawDocumentFetch)
SourceFetchConfig	withCustomFetcherClass(java.lang.String customFetcherClass)
SourceFetchConfig	withCustomFetcherUrl(java.lang.String customFetcherUrl)
SourceFetchConfig	withFetchProtocol(java.lang.String fetchProtocol)
void	writeTo(java.io.OutputStream os) Write this SourceFetchConfig as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

allowRawDocumentFetch

public boolean allowRawDocumentFetch

DEFAULT_ALLOW_RAW_DOCUMENT_FETCH

public static final boolean DEFAULT_ALLOW_RAW_DOCUMENT_FETCH

See Also:

Constant Field Values

customFetcherClass

public java.lang.String customFetcherClass

customFetcherUrl

public java.lang.String customFetcherUrl

fetchProtocol

public java.lang.String fetchProtocol

Constructor Detail

SourceFetchConfig

public SourceFetchConfig()

SourceFetchConfig

public SourceFetchConfig(SourceFetchConfig o)

Copy constructor

Method Detail

setAllowRawDocumentFetch

public void setAllowRawDocumentFetch(boolean allowRawDocumentFetch)

isAllowRawDocumentFetch

public boolean isAllowRawDocumentFetch()

withAllowRawDocumentFetch

public SourceFetchConfig withAllowRawDocumentFetch(boolean allowRawDocumentFetch)

withAllowRawDocumentFetch

public SourceFetchConfig withAllowRawDocumentFetch(java.lang.Boolean allowRawDocumentFetch)

setCustomFetcherClass

public void setCustomFetcherClass(java.lang.String customFetcherClass)

getCustomFetcherClass

public java.lang.String getCustomFetcherClass()

withCustomFetcherClass

public SourceFetchConfig withCustomFetcherClass(java.lang.String customFetcherClass)

setCustomFetcherUrl

public void setCustomFetcherUrl(java.lang.String customFetcherUrl)

Base URL used for retrieving documents from this connector.
This is used for preview, thumbnails and raw fetch from the search results.
For unmanaged connectors, this is always used.
For managed connectors, if this parameter is given, it completely replaces the retriever within the connectors server.

getCustomFetcherUrl

public java.lang.String getCustomFetcherUrl()

Base URL used for retrieving documents from this connector.
This is used for preview, thumbnails and raw fetch from the search results.
For unmanaged connectors, this is always used.
For managed connectors, if this parameter is given, it completely replaces the retriever within the connectors server.

withCustomFetcherUrl

public SourceFetchConfig withCustomFetcherUrl(java.lang.String customFetcherUrl)

setFetchProtocol

public void setFetchProtocol(java.lang.String fetchProtocol)

Protocol implemented by the customFetcherURL.
One of v1, v2, rpv3, or networkRetriever

getFetchProtocol

public java.lang.String getFetchProtocol()

Protocol implemented by the customFetcherURL.
One of v1, v2, rpv3, or networkRetriever

withFetchProtocol

public SourceFetchConfig withFetchProtocol(java.lang.String fetchProtocol)

makeCopy

public SourceFetchConfig makeCopy()

Creates and returns a deep copy of this SourceFetchConfig.

readFrom

public static SourceFetchConfig readFrom(java.io.InputStream is)
                                  throws javax.xml.bind.JAXBException

Read this SourceFetchConfig from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Write this SourceFetchConfig as an XML fragment

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static SourceFetchConfig fromString(java.lang.String s)
                                    throws javax.xml.bind.JAXBException,
                                           java.io.UnsupportedEncodingException

String representation of this SourceFetchConfig.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this SourceFetchConfig.

Overrides:

toString in class java.lang.Object

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this SourceFetchConfig.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException