io.gravitee.gateway.api.service.Subscription Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gravitee-gateway-api Show documentation

There is a newer version: 3.9.0-alpha.26

/*
 * Copyright © 2015 The Gravitee team (http://gravitee.io)
 *
 * 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.gravitee.gateway.api.service;

import java.util.Date;
import java.util.Map;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;
import lombok.ToString;

@Builder
@NoArgsConstructor
@AllArgsConstructor
@Getter
@Setter
@ToString
@EqualsAndHashCode
public class Subscription {

    private String id;

    private String api;

    private String plan;

    private String application;

    private String clientId;

    private String clientCertificate;

    private String status;

    @Builder.Default
    private ConsumerStatus consumerStatus = ConsumerStatus.STARTED;

    private Date startingAt;

    private Date endingAt;

    private SubscriptionConfiguration configuration;

    private Map metadata;

    @Builder.Default
    private Type type = Type.STANDARD;

    @EqualsAndHashCode.Exclude
    private boolean forceDispatch;

    private String environmentId;

    public boolean isTimeValid(long requestTimestamp) {
        Date requestDate = new Date(requestTimestamp);
        return (endingAt == null || endingAt.after(requestDate)) && (startingAt == null || startingAt.before(requestDate));
    }

    public enum Type {
        STANDARD,
        PUSH,
    }

    public enum ConsumerStatus {
        STOPPED,
        STARTED,
        FAILURE,
    }
}