Examples with IRateLimiterComponent io.apiman.gateway.engine.components.IRateLimiterComponent used on opensource projects

Example 1 with IRateLimiterComponent

use of io.apiman.gateway.engine.components.IRateLimiterComponent in project apiman by apiman.

the class RateLimitingPolicy method doApply.

/**
 * @see io.apiman.gateway.engine.policies.AbstractMappedPolicy#doApply(io.apiman.gateway.engine.beans.ApiRequest, io.apiman.gateway.engine.policy.IPolicyContext, java.lang.Object, io.apiman.gateway.engine.policy.IPolicyChain)
 */
@Override
protected void doApply(final ApiRequest request, final IPolicyContext context, final RateLimitingConfig config, final IPolicyChain<ApiRequest> chain) {
    String bucketId = bucketId(request, config);
    final RateBucketPeriod period = bucketFactory.getPeriod(config);
    if (bucketId.equals(BucketFactory.NO_USER_AVAILABLE)) {
        IPolicyFailureFactoryComponent failureFactory = context.getComponent(IPolicyFailureFactoryComponent.class);
        // $NON-NLS-1$
        PolicyFailure failure = failureFactory.createFailure(PolicyFailureType.Other, PolicyFailureCodes.NO_USER_FOR_RATE_LIMITING, Messages.i18n.format("RateLimitingPolicy.NoUser"));
        chain.doFailure(failure);
        return;
    }
    if (bucketId.equals(BucketFactory.NO_CLIENT_AVAILABLE)) {
        IPolicyFailureFactoryComponent failureFactory = context.getComponent(IPolicyFailureFactoryComponent.class);
        // $NON-NLS-1$
        PolicyFailure failure = failureFactory.createFailure(PolicyFailureType.Other, PolicyFailureCodes.NO_APP_FOR_RATE_LIMITING, Messages.i18n.format("RateLimitingPolicy.NoApp"));
        chain.doFailure(failure);
        return;
    }
    IRateLimiterComponent rateLimiter = context.getComponent(IRateLimiterComponent.class);
    rateLimiter.accept(bucketId, period, config.getLimit(), 1, new IAsyncResultHandler<RateLimitResponse>() {

        @Override
        public void handle(IAsyncResult<RateLimitResponse> result) {
            if (result.isError()) {
                chain.throwError(result.getError());
            } else {
                RateLimitResponse rtr = result.getResult();
                Map<String, String> responseHeaders = responseHeaders(config, rtr, defaultLimitHeader(), defaultRemainingHeader(), defaultResetHeader());
                if (rtr.isAccepted()) {
                    // $NON-NLS-1$
                    context.setAttribute("rate-limit-response-headers", responseHeaders);
                    chain.doApply(request);
                } else {
                    IPolicyFailureFactoryComponent failureFactory = context.getComponent(IPolicyFailureFactoryComponent.class);
                    PolicyFailure failure = limitExceededFailure(failureFactory);
                    failure.getHeaders().putAll(responseHeaders);
                    chain.doFailure(failure);
                }
            }
        }
    });
}

Example 2 with IRateLimiterComponent

use of io.apiman.gateway.engine.components.IRateLimiterComponent in project apiman by apiman.

the class TransferQuotaPolicy method doApply.

@Override
protected void doApply(final ApiRequest request, final IPolicyContext context, final TransferQuotaConfig config, final IPolicyChain<ApiRequest> chain) {
    // *************************************************************
    // Step 1:  check to see if we're already in violation of this
    // policy.  If so, fail fast.
    // *************************************************************
    // $NON-NLS-1$
    String bucketId = bucketId(request, config);
    final RateBucketPeriod period = bucketFactory.getPeriod(config);
    if (bucketId.equals(BucketFactory.NO_USER_AVAILABLE)) {
        IPolicyFailureFactoryComponent failureFactory = context.getComponent(IPolicyFailureFactoryComponent.class);
        // $NON-NLS-1$
        PolicyFailure failure = failureFactory.createFailure(PolicyFailureType.Other, PolicyFailureCodes.NO_USER_FOR_RATE_LIMITING, Messages.i18n.format("TransferQuotaPolicy.NoUser"));
        chain.doFailure(failure);
        return;
    }
    if (bucketId.equals(BucketFactory.NO_CLIENT_AVAILABLE)) {
        IPolicyFailureFactoryComponent failureFactory = context.getComponent(IPolicyFailureFactoryComponent.class);
        // $NON-NLS-1$
        PolicyFailure failure = failureFactory.createFailure(PolicyFailureType.Other, PolicyFailureCodes.NO_APP_FOR_RATE_LIMITING, Messages.i18n.format("TransferQuotaPolicy.NoApp"));
        chain.doFailure(failure);
        return;
    }
    context.setAttribute(BUCKET_ID_ATTR, bucketId);
    context.setAttribute(PERIOD_ATTR, period);
    IRateLimiterComponent rateLimiter = context.getComponent(IRateLimiterComponent.class);
    rateLimiter.accept(bucketId, period, config.getLimit(), 0, new IAsyncResultHandler<RateLimitResponse>() {

        @Override
        public void handle(IAsyncResult<RateLimitResponse> result) {
            if (result.isError()) {
                chain.throwError(result.getError());
            } else {
                RateLimitResponse rtr = result.getResult();
                context.setAttribute(RATE_LIMIT_RESPONSE_ATTR, rtr);
                if (!rtr.isAccepted()) {
                    doQuotaExceededFailure(context, config, chain, rtr);
                } else {
                    chain.doApply(request);
                }
            }
        }
    });
}

Example 3 with IRateLimiterComponent

use of io.apiman.gateway.engine.components.IRateLimiterComponent in project apiman by apiman.

the class RateLimitingPolicy method probe.

@Override
public void probe(RateLimitingProbeConfig probeRequest, RateLimitingConfig policyConfig, ProbeContext probeContext, IPolicyContext context, IAsyncResultHandler<IPolicyProbeResponse> resultHandler) {
    String bucketId = bucketFactory.bucketId(probeRequest, probeContext, policyConfig);
    IRateLimiterComponent rateLimiter = context.getComponent(IRateLimiterComponent.class);
    // Ask for rate limit, but don't actually decrement the counter.
    rateLimiter.accept(bucketId, bucketFactory.getPeriod(policyConfig), policyConfig.getLimit(), 0, rateLimResult -> {
        RateLimitResponse remaining = rateLimResult.getResult();
        var probeResult = new RateLimitingProbeResponse().setStatus(remaining).setConfig(policyConfig);
        resultHandler.handle(AsyncResultImpl.create(probeResult));
    });
}

Example 4 with IRateLimiterComponent

use of io.apiman.gateway.engine.components.IRateLimiterComponent in project apiman by apiman.

the class TransferQuotaPolicy method doFinalApply.

/**
 * Called when everything is done (the last byte is written).  This is used to
 * record the # of bytes downloaded.
 */
protected void doFinalApply(IPolicyContext context, TransferQuotaConfig config, long downloadedBytes) {
    if (config.getDirection() == TransferDirectionType.download || config.getDirection() == TransferDirectionType.both) {
        final String bucketId = context.getAttribute(BUCKET_ID_ATTR, (String) null);
        final RateBucketPeriod period = context.getAttribute(PERIOD_ATTR, (RateBucketPeriod) null);
        IRateLimiterComponent rateLimiter = context.getComponent(IRateLimiterComponent.class);
        rateLimiter.accept(bucketId, period, config.getLimit(), downloadedBytes, new IAsyncResultHandler<RateLimitResponse>() {

            @Override
            public void handle(IAsyncResult<RateLimitResponse> result) {
            // No need to handle the response - it's too late to do anything meaningful with the result.
            // TODO log any error that might have ocurred
            }
        });
    }
}

Example 5 with IRateLimiterComponent

use of io.apiman.gateway.engine.components.IRateLimiterComponent in project apiman by apiman.

the class TransferQuotaPolicy method probe.

@Override
public void probe(RateLimitingProbeConfig probeRequest, TransferQuotaConfig policyConfig, ProbeContext probeContext, IPolicyContext context, IAsyncResultHandler<IPolicyProbeResponse> resultHandler) {
    String bucketId = bucketId(probeRequest, probeContext, policyConfig);
    IRateLimiterComponent rateLimiter = context.getComponent(IRateLimiterComponent.class);
    // Ask for rate limit, but don't actually decrement the counter.
    rateLimiter.accept(bucketId, bucketFactory.getPeriod(policyConfig), policyConfig.getLimit(), 0, rateLimResult -> {
        RateLimitResponse remaining = rateLimResult.getResult();
        var probeResult = new TransferQuotaProbeResponse().setStatus(remaining).setConfig(policyConfig);
        resultHandler.handle(AsyncResultImpl.create(probeResult));
    });
}