io.gravitee.rest.api.service.SubscriptionService Maven / Gradle / Ivy

Go to download

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

Gravitee IO Manager Service

There is a newer version: 3.10.0

Show newest version

/**
 * Copyright (C) 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.rest.api.service;

import io.gravitee.common.data.domain.Page;
import io.gravitee.rest.api.model.*;
import io.gravitee.rest.api.model.common.Pageable;
import io.gravitee.rest.api.model.pagedresult.Metadata;
import io.gravitee.rest.api.model.subscription.SubscriptionQuery;
import java.util.Collection;
import java.util.List;
import java.util.Map;

/**
 * @author David BRASSELY (david.brassely at graviteesource.com)
 * @author GraviteeSource Team
 */
public interface SubscriptionService {
    /**
     * Get a subscription from its ID.
     * @param subscription
     * @return
     */
    SubscriptionEntity findById(String subscription);

    Collection findByApplicationAndPlan(String application, String plan);

    Collection findByApi(String api);

    Collection findByPlan(String plan);

    SubscriptionEntity create(NewSubscriptionEntity newSubscriptionEntity);

    SubscriptionEntity create(NewSubscriptionEntity newSubscriptionEntity, String customApiKey);

    SubscriptionEntity update(UpdateSubscriptionEntity subscription);

    SubscriptionEntity update(UpdateSubscriptionEntity subscription, String clientId);

    SubscriptionEntity process(ProcessSubscriptionEntity processSubscription, String userId);

    SubscriptionEntity pause(String subscription);

    SubscriptionEntity resume(String subscription);

    SubscriptionEntity close(String subscription);

    void delete(String subscription);

    Collection search(SubscriptionQuery query);

    Page search(SubscriptionQuery query, Pageable pageable);

    Metadata getMetadata(List subscriptions);
    SubscriptionEntity transfer(TransferSubscriptionEntity transferSubscription, String userId);
    String exportAsCsv(Collection subscriptions, Map> metadata);
}