com.exalead.indexing.analysis.v10

Class RemoteHTTPTransformer

java.lang.Object

com.exalead.indexing.analysis.v10.DocumentProcessor

com.exalead.indexing.analysis.v10.RemoteHTTPTransformer

All Implemented Interfaces:

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

public class RemoteHTTPTransformer
extends DocumentProcessor
implements com.exalead.util.Checkable, java.io.Serializable

The processor posts part bytes to the remote HTTP service, and gets the typed resource as a result.
The remote service may return a Document.MIME_V10 document, or any other document that can later be processed in the pipeline.
If the remote service returns a non "OK" HTTP status (!= 200 error code), the corresponding error is passed as a regular error.
The service may also advertise a filename, using the standard Content-Disposition's 'filename' attribute.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RemoteHTTPTransformer.ArgMapping

Nested classes/interfaces inherited from class com.exalead.indexing.analysis.v10.DocumentProcessor

DocumentProcessor.FromDataModel, DocumentProcessor.Transformer<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected RemoteHTTPTransformer.ArgMapping	argMapping
int	httpIdleTimeoutMs
java.lang.String	remoteUrl
int	timeoutMs

Fields inherited from class com.exalead.indexing.analysis.v10.DocumentProcessor

acceptCondition, dataModelClass, dataModelProperty, dataModelState, DEFAULT_DISABLED, disabled, fromDataModel, name

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
<T> T	accept(DocumentProcessor.Transformer<T> transformer, T[] t)
void	check(boolean deep, java.lang.String errorContext) Checks this RemoteHTTPTransformer.
static RemoteHTTPTransformer	fromString(java.lang.String s) String representation of this RemoteHTTPTransformer.
RemoteHTTPTransformer.ArgMapping	getArgMapping()
int	getHttpIdleTimeoutMs() Cached HTTP connection idle timeout.
java.lang.String	getRemoteUrl() Remote URL
int	getTimeoutMs() Remote processor timeout, in milliseconds. This is the timeout.
RemoteHTTPTransformer	makeCopy() Creates and returns a deep copy of this RemoteHTTPTransformer.
static RemoteHTTPTransformer	readFrom(java.io.InputStream is) Read this RemoteHTTPTransformer from an XML fragment.
void	setArgMapping(RemoteHTTPTransformer.ArgMapping __value)
void	setHttpIdleTimeoutMs(int httpIdleTimeoutMs) Cached HTTP connection idle timeout.
void	setRemoteUrl(java.lang.String remoteUrl) Remote URL
void	setTimeoutMs(int timeoutMs) Remote processor timeout, in milliseconds. This is the timeout.
java.lang.String	toString() String representation of this RemoteHTTPTransformer.
RemoteHTTPTransformer	withAcceptCondition(AcceptCondition acceptCondition)
RemoteHTTPTransformer	withArgMapping(java.util.Collection<RemoteHTTPTransformerRemoteArgMapping> __values)
RemoteHTTPTransformer	withArgMapping(RemoteHTTPTransformer.ArgMapping __value)
RemoteHTTPTransformer	withArgMapping(RemoteHTTPTransformerRemoteArgMapping... __values)
RemoteHTTPTransformer	withDataModelClass(java.lang.String dataModelClass)
RemoteHTTPTransformer	withDataModelProperty(java.lang.String dataModelProperty)
RemoteHTTPTransformer	withDataModelState(java.lang.String dataModelState)
RemoteHTTPTransformer	withDisabled(boolean disabled)
RemoteHTTPTransformer	withDisabled(java.lang.Boolean disabled)
RemoteHTTPTransformer	withFromDataModel(DocumentProcessor fromDataModel)
RemoteHTTPTransformer	withHttpIdleTimeoutMs(int httpIdleTimeoutMs)
RemoteHTTPTransformer	withHttpIdleTimeoutMs(java.lang.Integer httpIdleTimeoutMs)
RemoteHTTPTransformer	withName(java.lang.String name)
RemoteHTTPTransformer	withRemoteUrl(java.lang.String remoteUrl)
RemoteHTTPTransformer	withTimeoutMs(int timeoutMs)
RemoteHTTPTransformer	withTimeoutMs(java.lang.Integer timeoutMs)
void	writeTo(java.io.OutputStream os) Write this RemoteHTTPTransformer as an XML fragment

Methods inherited from class com.exalead.indexing.analysis.v10.DocumentProcessor

getAcceptCondition, getDataModelClass, getDataModelProperty, getDataModelState, getFromDataModel, getName, isDisabled, setAcceptCondition, setDataModelClass, setDataModelProperty, setDataModelState, setDisabled, setFromDataModel, setName

Methods inherited from class java.lang.Object

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

Field Detail

remoteUrl

public java.lang.String remoteUrl

timeoutMs

public int timeoutMs

httpIdleTimeoutMs

public int httpIdleTimeoutMs

argMapping

protected RemoteHTTPTransformer.ArgMapping argMapping

Constructor Detail

RemoteHTTPTransformer

public RemoteHTTPTransformer()

RemoteHTTPTransformer

public RemoteHTTPTransformer(RemoteHTTPTransformer o)

Copy constructor

Method Detail

withAcceptCondition

public RemoteHTTPTransformer withAcceptCondition(AcceptCondition acceptCondition)

Overrides:

withAcceptCondition in class DocumentProcessor

withName

public RemoteHTTPTransformer withName(java.lang.String name)

Overrides:

withName in class DocumentProcessor

withDataModelState

public RemoteHTTPTransformer withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class DocumentProcessor

withFromDataModel

public RemoteHTTPTransformer withFromDataModel(DocumentProcessor fromDataModel)

withDataModelClass

public RemoteHTTPTransformer withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class DocumentProcessor

withDataModelProperty

public RemoteHTTPTransformer withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class DocumentProcessor

withDisabled

public RemoteHTTPTransformer withDisabled(boolean disabled)

Overrides:

withDisabled in class DocumentProcessor

withDisabled

public RemoteHTTPTransformer withDisabled(java.lang.Boolean disabled)

Overrides:

withDisabled in class DocumentProcessor

setRemoteUrl

public void setRemoteUrl(java.lang.String remoteUrl)

Remote URL

getRemoteUrl

public java.lang.String getRemoteUrl()

Remote URL

withRemoteUrl

public RemoteHTTPTransformer withRemoteUrl(java.lang.String remoteUrl)

setTimeoutMs

public void setTimeoutMs(int timeoutMs)

Remote processor timeout, in milliseconds.
This is the timeout.

getTimeoutMs

public int getTimeoutMs()

Remote processor timeout, in milliseconds.
This is the timeout.

withTimeoutMs

public RemoteHTTPTransformer withTimeoutMs(int timeoutMs)

withTimeoutMs

public RemoteHTTPTransformer withTimeoutMs(java.lang.Integer timeoutMs)

setHttpIdleTimeoutMs

public void setHttpIdleTimeoutMs(int httpIdleTimeoutMs)

Cached HTTP connection idle timeout. This is an advanced setting.
For efficiency, the RemoteHTTPTransformer maintains a pool of opened connections to the remote HTTP service.
This defines the timeout for connections which are no longer used.
Default is 10.000.

getHttpIdleTimeoutMs

public int getHttpIdleTimeoutMs()

Cached HTTP connection idle timeout. This is an advanced setting.
For efficiency, the RemoteHTTPTransformer maintains a pool of opened connections to the remote HTTP service.
This defines the timeout for connections which are no longer used.
Default is 10.000.

withHttpIdleTimeoutMs

public RemoteHTTPTransformer withHttpIdleTimeoutMs(int httpIdleTimeoutMs)

withHttpIdleTimeoutMs

public RemoteHTTPTransformer withHttpIdleTimeoutMs(java.lang.Integer httpIdleTimeoutMs)

getArgMapping

public RemoteHTTPTransformer.ArgMapping getArgMapping()

setArgMapping

public void setArgMapping(RemoteHTTPTransformer.ArgMapping __value)

withArgMapping

public RemoteHTTPTransformer withArgMapping(RemoteHTTPTransformerRemoteArgMapping... __values)

withArgMapping

public RemoteHTTPTransformer withArgMapping(java.util.Collection<RemoteHTTPTransformerRemoteArgMapping> __values)

withArgMapping

public RemoteHTTPTransformer withArgMapping(RemoteHTTPTransformer.ArgMapping __value)

makeCopy

public RemoteHTTPTransformer makeCopy()

Creates and returns a deep copy of this RemoteHTTPTransformer.

Overrides:

makeCopy in class DocumentProcessor

readFrom

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

Read this RemoteHTTPTransformer 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 RemoteHTTPTransformer as an XML fragment

Overrides:

writeTo in class DocumentProcessor

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this RemoteHTTPTransformer.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this RemoteHTTPTransformer.

Overrides:

toString in class DocumentProcessor

check

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

Checks this RemoteHTTPTransformer.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class DocumentProcessor

Throws:

com.exalead.util.TypedException

accept

public <T> T accept(DocumentProcessor.Transformer<T> transformer,
                    T[] t)
             throws com.exalead.util.TypedException

Specified by:

accept in class DocumentProcessor

Throws:

com.exalead.util.TypedException