Module org.mule.runtime.extensions.api

Package org.mule.runtime.extension.api.client.params

Interface ComponentParameterizer<T extends ComponentParameterizer>

All Superinterfaces:

Parameterizer<T>

All Known Subinterfaces:

OperationParameterizer, SourceParameterizer

@Experimental
@MinMuleVersion("4.5.0")
public interface ComponentParameterizer<T extends ComponentParameterizer>
extends Parameterizer<T>

Parameterizes a component executed or created through the ExtensionsClient

NOTE: Experimental feature. Backwards compatibility not guaranteed.

Since:

1.5.0

Method Summary

Modifier and Type	Method	Description
T	reconnectingForever(int frequency)	Specifies that in the case of a ConnectionException, the connection is to be re-established and the operation indefinitely until successful
T	withConfigRef(String configurationName)	Specifies the name of a config element this component refers to
T	withDefaultRepeatableIterables()	Specifies that the operation is to used whatever repeatable iterables strategy is default for the current execution context.
T	withDefaultRepeatableStreaming()	Specifies that the operation is to used whatever repeatable streaming strategy is default for the current execution context.
T	withFileStoreRepeatableIterables(int maxInMemoryInstances)	Specifies that the operation is to use file based repeatable streaming
T	withFileStoreRepeatableStreaming(org.mule.runtime.api.util.DataSize maxInMemorySize)	Specifies that the operation is to use file based repeatable streaming
T	withInMemoryRepeatableIterables(int initialBufferSize, int bufferSizeIncrement, int maxBufferSize)	Specifies that the operation is to use in-memory repeatable iterables
T	withInMemoryRepeatableStreaming(org.mule.runtime.api.util.DataSize initialBufferSize, org.mule.runtime.api.util.DataSize bufferSizeIncrement, org.mule.runtime.api.util.DataSize maxBufferSize)	Specifies that the operation is to use in-memory repeatable streaming
T	withSimpleReconnection(int frequency, int maxAttempts)	Specifies that in the case of a ConnectionException, the connection is to be re-established and the operation retried up to maxAttempts times, with an interval of frequency milliseconds.

Methods inherited from interface org.mule.runtime.extension.api.client.params.Parameterizer

withParameter, withParameter

Method Details

withConfigRef

T withConfigRef(String configurationName)

Specifies the name of a config element this component refers to

Parameters:

configurationName - a configuration name

Returns:

this instance

withSimpleReconnection

T withSimpleReconnection(int frequency,
 int maxAttempts)

Specifies that in the case of a ConnectionException, the connection is to be re-established and the operation retried up to maxAttempts times, with an interval of frequency milliseconds.

If no reconnection strategy is specified (either through this or similar methods), then no reconnection is attempted at all.

Parameters:

frequency - the attempts interval in milliseconds

maxAttempts - the max number of attempts to be performed.

Returns:

this instance

reconnectingForever

T reconnectingForever(int frequency)

Specifies that in the case of a ConnectionException, the connection is to be re-established and the operation indefinitely until successful

If no reconnection strategy is specified (either through this or similar methods), then no reconnection is attempted at all.

Parameters:

frequency - the attempts interval in milliseconds

Returns:

this instance

withDefaultRepeatableStreaming

T withDefaultRepeatableStreaming()

Specifies that the operation is to used whatever repeatable streaming strategy is default for the current execution context.

If this concept does not apply to the executed operation (either because it uses iterables instead of streams or because it doesn't stream at all), then calling this method has no effect.

If no repeatable streaming strategy is specified (either through this or similar methods), then streaming results will not be made repeatable

Returns:

this instance

withInMemoryRepeatableStreaming

T withInMemoryRepeatableStreaming(org.mule.runtime.api.util.DataSize initialBufferSize,
 org.mule.runtime.api.util.DataSize bufferSizeIncrement,
 org.mule.runtime.api.util.DataSize maxBufferSize)

Specifies that the operation is to use in-memory repeatable streaming

If this concept does not apply to the executed operation (either because it uses iterables instead of streams or because it doesn't stream at all), then calling this method has no effect.

If no repeatable streaming strategy is specified (either through this or similar methods), then streaming results will not be made repeatable

Parameters:

initialBufferSize - the buffer's initial size. Must be greater than zero bytes.

bufferSizeIncrement - the size that the buffer should gain each time it is expanded. A value of zero bytes means no expansion. Cannot be negative byte size.

maxBufferSize - the maximum amount of space that the buffer can grow to. Use null for unbounded buffers

Returns:

this instance

withFileStoreRepeatableStreaming

T withFileStoreRepeatableStreaming(org.mule.runtime.api.util.DataSize maxInMemorySize)

Specifies that the operation is to use file based repeatable streaming

If this concept does not apply to the executed operation (either because it uses iterables instead of streams or because it doesn't stream at all), then calling this method has no effect.

If no repeatable streaming strategy is specified (either through this or similar methods), then streaming results will not be made repeatable

Parameters:

maxInMemorySize - the maximum amount of data to be held in memory before information is rolled over to disk

Returns:

this instance

withDefaultRepeatableIterables

T withDefaultRepeatableIterables()

Specifies that the operation is to used whatever repeatable iterables strategy is default for the current execution context.

If this concept does not apply to the executed operation (either because it uses bytes streaming instead of iterables or because it doesn't stream at all), then calling this method has no effect.

If no repeatable streaming strategy is specified (either through this or similar methods), then streaming results will not be made repeatable

Returns:

this instance

withInMemoryRepeatableIterables

T withInMemoryRepeatableIterables(int initialBufferSize,
 int bufferSizeIncrement,
 int maxBufferSize)

Specifies that the operation is to use in-memory repeatable iterables

If this concept does not apply to the executed operation (either because it uses bytes streams instead of iterables or because it doesn't stream at all), then calling this method has no effect.

If no repeatable streaming strategy is specified (either through this or similar methods), then streaming results will not be made repeatable

Parameters:

initialBufferSize - the buffer's initial size. Must be greater than zero

bufferSizeIncrement - the size that the buffer should gain each time it is expanded. A value of zero means no expansion. Cannot be lower than zero.

maxBufferSize - the maximum amount of space that the buffer can grow to. Use null for unbounded buffers

Returns:

this instance

withFileStoreRepeatableIterables

T withFileStoreRepeatableIterables(int maxInMemoryInstances)

Specifies that the operation is to use file based repeatable streaming

If this concept does not apply to the executed operation (either because it uses bytes streams instead of iterables or because it doesn't stream at all), then calling this method has no effect.

If no repeatable streaming strategy is specified (either through this or similar methods), then streaming results will not be made repeatable

Parameters:

maxInMemoryInstances - maxInMemoryInstances the maximum amount of space that the buffer can grow to. Use null for unbounded buffers

Returns:

this instance