io.gravitee.management.service.ApiService Maven / Gradle / Ivy

Go to download

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

Gravitee IO Manager Service

There is a newer version: 1.30.31

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.management.service;

import io.gravitee.management.model.*;

import java.util.Set;

/**
 * @author David BRASSELY (david.brassely at graviteesource.com)
 * @author GraviteeSource Team
 */
public interface ApiService {

    ApiEntity findById(String apiId);

    Set findAll();

    Set findByUser(String username);

    Set findByGroup(String groupId);

    Set findByVisibility(Visibility visibility);

    ApiEntity create(NewApiEntity api, String username);

    ApiEntity update(String apiId, UpdateApiEntity api);

    void delete(String apiId);

    void start(String apiId, String username);

    void stop(String apiId, String username);

    /**
     * Check if the API is "out of sync" or not. In this case, user is able to deploy it.
     * API is in "out of sync" state if:
     * - API definition has been updated and is different from the currently deployed API
     * - A plan has been updated for the API
     *
     * @param apiId
     * @return
     */
    boolean isSynchronized(String apiId);
    
    ApiEntity deploy(String apiId, String username, EventType eventType);
    
    ApiEntity rollback(String apiId, UpdateApiEntity api);

    String exportAsJson(String apiId, MembershipType membershipType);

    ApiEntity createOrUpdateWithDefinition(ApiEntity apiEntity, String apiDefinition, String username);

    ImageEntity getPicture(String apiId);

    void deleteViewFromAPIs(String viewId);
}