RateLimitingConfig.java

/*
 * Copyright 2014 JBoss Inc
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.apiman.gateway.engine.policies.config;

import io.apiman.gateway.engine.policies.config.rates.RateLimitingGranularity;
import io.apiman.gateway.engine.policies.config.rates.RateLimitingPeriod;

/**
 * Configuration object for the rate limiting policy.
 *
 * @author eric.wittmann@redhat.com
 */
public class RateLimitingConfig {

    private long limit;
    private RateLimitingGranularity granularity;
    private RateLimitingPeriod period;
    private String userHeader;
    private String headerRemaining;
    private String headerLimit;
    private String headerReset;

    /**
     * Constructor.
     */
    public RateLimitingConfig() {
    }

    /**
     * @return the granularity
     */
    public RateLimitingGranularity getGranularity() {
        return granularity;
    }

    /**
     * @param granularity the granularity to set
     */
    public void setGranularity(RateLimitingGranularity granularity) {
        this.granularity = granularity;
    }

    /**
     * @return the period
     */
    public RateLimitingPeriod getPeriod() {
        return period;
    }

    /**
     * @param period the period to set
     */
    public void setPeriod(RateLimitingPeriod period) {
        this.period = period;
    }

    /**
     * @return the userHeader
     */
    public String getUserHeader() {
        return userHeader;
    }

    /**
     * @param userHeader the userHeader to set
     */
    public void setUserHeader(String userHeader) {
        this.userHeader = userHeader;
    }

    /**
     * @return the limit
     */
    public long getLimit() {
        return limit;
    }

    /**
     * @param limit the limit to set
     */
    public void setLimit(long limit) {
        this.limit = limit;
    }

    /**
     * @return the headerRemaining
     */
    public String getHeaderRemaining() {
        return headerRemaining;
    }

    /**
     * @param headerRemaining the headerRemaining to set
     */
    public void setHeaderRemaining(String headerRemaining) {
        this.headerRemaining = headerRemaining;
    }

    /**
     * @return the headerLimit
     */
    public String getHeaderLimit() {
        return headerLimit;
    }

    /**
     * @param headerLimit the headerLimit to set
     */
    public void setHeaderLimit(String headerLimit) {
        this.headerLimit = headerLimit;
    }

    /**
     * @return the headerReset
     */
    public String getHeaderReset() {
        return headerReset;
    }

    /**
     * @param headerReset the headerReset to set
     */
    public void setHeaderReset(String headerReset) {
        this.headerReset = headerReset;
    }

}