de.codecentric.limiter.api

Class RatelimiterOperations

java.lang.Object

de.codecentric.limiter.api.RatelimiterOperations

All Implemented Interfaces:

org.mule.runtime.api.lifecycle.Startable, org.mule.runtime.api.lifecycle.Stoppable

public class RatelimiterOperations
extends Object
implements org.mule.runtime.api.lifecycle.Startable, org.mule.runtime.api.lifecycle.Stoppable

This class is a container for operations, every public method in this class will be taken as an extension operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	RatelimiterOperations.RetryAfterRunner Schedulable execution to run the first and followup calls.

Field Summary

Fields inherited from interface org.mule.runtime.api.lifecycle.Startable

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.lifecycle.Stoppable

PHASE_NAME

Constructor Summary

Constructors

Constructor and Description
RatelimiterOperations()

Method Summary

Modifier and Type	Method and Description
void	fixedDelay(long delay, TimeUnit unit, org.mule.runtime.extension.api.runtime.process.CompletionCallback<Void,Void> callback)
void	handleRetryAfter(org.mule.runtime.extension.api.runtime.route.Chain operations, org.mule.runtime.extension.api.runtime.process.CompletionCallback<Object,Object> callback, String id, int numberOfRetries, int waitStatusCode, org.mule.runtime.extension.api.runtime.parameter.Literal<String> waitTimeExpression, org.mule.runtime.extension.api.runtime.parameter.Literal<String> joinWaitTimeExpression)
void	limitRate(RatelimiterConfiguration configuration, org.mule.runtime.extension.api.runtime.process.CompletionCallback<Void,Void> callback) Delay the flow if called too fast.
org.mule.runtime.extension.api.runtime.operation.Result<Object,Object>	setAttributes(Object payload, Object attributes)
void	start()
void	stop()

Methods inherited from class java.lang.Object

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

Constructor Detail

RatelimiterOperations

public RatelimiterOperations()

Method Detail

start

public void start()

Specified by:

start in interface org.mule.runtime.api.lifecycle.Startable

stop

public void stop()

Specified by:

stop in interface org.mule.runtime.api.lifecycle.Stoppable

limitRate

@Throws(value=BufferErrorProvider.class)
public void limitRate(@Config
                                                                RatelimiterConfiguration configuration,
                                                                org.mule.runtime.extension.api.runtime.process.CompletionCallback<Void,Void> callback)

Delay the flow if called too fast.

fixedDelay

public void fixedDelay(long delay,
                       TimeUnit unit,
                       org.mule.runtime.extension.api.runtime.process.CompletionCallback<Void,Void> callback)

setAttributes

@OutputResolver(output=SetAttributesOutputResolver.class)
public org.mule.runtime.extension.api.runtime.operation.Result<Object,Object> setAttributes(@Optional(defaultValue="#[payload]")
                                                                                                                                                       Object payload,
                                                                                                                                                       @Expression(value=REQUIRED)
                                                                                                                                                       Object attributes)

handleRetryAfter

@Alias(value="handle-429")
 @Throws(value=Handle429ErrorProvider.class)
 @MediaType(value="*/*")
public void handleRetryAfter(org.mule.runtime.extension.api.runtime.route.Chain operations,
                                                                                                                                 org.mule.runtime.extension.api.runtime.process.CompletionCallback<Object,Object> callback,
                                                                                                                                 @Summary(value="Resource ID")
                                                                                                                                 String id,
                                                                                                                                 @Summary(value="How often shall the operation be retried when the first try failed?") @Optional(defaultValue="5")
                                                                                                                                 int numberOfRetries,
                                                                                                                                 @Summary(value="Status code for wait") @Optional(defaultValue="429")
                                                                                                                                 int waitStatusCode,
                                                                                                                                 @Summary(value="A DataWeave expression to compute the time to wait (in milliseconds).The following values are available: headers: The HTTP response headers as mapretryIndex: Which retry attemt is this (first retry: 1). ") @Optional(defaultValue="#[(headers.\"retry-after\" default \"0\" as Number + random() * 100) * 1000]")
                                                                                                                                 org.mule.runtime.extension.api.runtime.parameter.Literal<String> waitTimeExpression,
                                                                                                                                 @Summary(value="Additional wait time when joining an already active wait (in milliseconds).") @Optional(defaultValue="#[100 + random() * 1000]")
                                                                                                                                 org.mule.runtime.extension.api.runtime.parameter.Literal<String> joinWaitTimeExpression)