org.mule.sdk.api.client

Interface OperationParameterizer

@MinMuleVersion(value="4.5")
 @NoImplement
public interface OperationParameterizer

Parameterizes an operation execution performed through the ExtensionsClient

Since:

1.0

Method Summary

Modifier and Type	Method and Description
OperationParameterizer	inTheContextOf(org.mule.runtime.api.event.Event event) Specifies an event to which this operation is relative to.
OperationParameterizer	reconnectingForever(int frequency) Specifies that in the case of a ConnectionException, the connection is to be re-established and the operation indefinitely until successful
OperationParameterizer	withConfigRef(String configurationName)
OperationParameterizer	withDefaultRepeatableIterables() Specifies that the operation is to used whatever repeatable iterables strategy is default for the current execution context.
OperationParameterizer	withDefaultRepeatableStreaming() Specifies that the operation is to used whatever repeatable streaming strategy is default for the current execution context.
OperationParameterizer	withFileStoreRepeatableIterables(int maxInMemoryInstances) Specifies that the operation is to use file based repeatable streaming
OperationParameterizer	withFileStoreRepeatableStreaming(org.mule.runtime.api.util.DataSize maxInMemorySize) Specifies that the operation is to use file based repeatable streaming
OperationParameterizer	withInMemoryRepeatableIterables(int initialBufferSize, int bufferSizeIncrement, int maxBufferSize) Specifies that the operation is to use in-memory repeatable iterables
OperationParameterizer	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
OperationParameterizer	withParameter(String parameterName, Object value) Sets a parameter with a given value, automatically determining the group the parameter belongs to.
OperationParameterizer	withParameter(String parameterGroup, String parameterName, Object value) Sets a parameter with a given value.
OperationParameterizer	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.

Method Detail

withConfigRef

OperationParameterizer withConfigRef(String configurationName)

withParameter

OperationParameterizer withParameter(String parameterName,
                                     Object value)

Sets a parameter with a given value, automatically determining the group the parameter belongs to.

Parameters:

parameterName - the name of the parameter within the paramGroupName group to set.

value - the value of the parameter to set

Returns:

this instance

withParameter

OperationParameterizer withParameter(String parameterGroup,
                                     String parameterName,
                                     Object value)

Sets a parameter with a given value.

Parameters:

parameterGroup - the name of the group containing the parameter to set.

parameterName - the name of the parameter within the paramGroupName group to set.

value - the value of the parameter to set

Returns:

this instance

withSimpleReconnection

OperationParameterizer 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

OperationParameterizer 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

OperationParameterizer 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

OperationParameterizer 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

OperationParameterizer 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

OperationParameterizer 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

OperationParameterizer 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

OperationParameterizer 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

inTheContextOf

OperationParameterizer inTheContextOf(org.mule.runtime.api.event.Event event)

Specifies an event to which this operation is relative to. This means that parameters assigned with expression values, or managed streams returned will be associated to this event. If not specified, a temporary event will be generated for the execution and discarded immediately after.

Parameters:

event - an Event

Returns:

this instance