org.zalando.stups.clients.kio.KioOperations Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kio-client-java-api Show documentation

There is a newer version: 1.0.0

/**
 * Copyright (C) 2015 Zalando SE (http://tech.zalando.com)
 *
 * 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 org.zalando.stups.clients.kio;

import java.util.List;

public interface KioOperations {

    /**
     * Returns a list of registered applications in Kio.
     *
     * @return  {@link ApplicationBase} subset of {@link Application}.
     */
    List listApplications();

    /**
     * Returns an application for the given applicationId.
     *
     * @param   applicationId
     *
     * @return  {@link Application}
     */
    Application getApplicationById(String applicationId);

    /**
     * Creates or updates an application.
     *
     * @param  request
     * @param  id
     */
    void createOrUpdateApplication(CreateOrUpdateApplicationRequest request, String applicationId);

    /**
     * Returns a list of all approval-names for the specified applicationId.
     *
     * @return
     */
    List getApplicationApprovals(String applicationId);

    List getApplicationVersions(String applicationId);

    Version getApplicationVersion(String applicationId, String versionId);

    void createOrUpdateVersion(CreateOrUpdateVersionRequest request, String applicationId, String versionId);

    List getApplicationApprovals(String applicationId, String versionId);

    void approveApplicationVersion(ApprovalBase request, String applicationId, String versionId);

}