org.xlcloud.openstack.api.HeatClient Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openstack-heat-sdk Show documentation
The newest version!
/*
 * Copyright 2012 AMG.lab, a Bull Group Company
 * 
 * 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.xlcloud.openstack.api;

import org.xlcloud.openstack.model.exceptions.OpenStackException;
import org.xlcloud.openstack.model.heat.HeatStack;
import org.xlcloud.openstack.model.heat.StackData;
import org.xlcloud.openstack.model.heat.StackResources;

import com.sun.jersey.api.client.UniformInterfaceException;

/**
 * This interface provides a concise way to manipulate stacks, actually support create, delete and get details operations
 * 
 * @author Ksiazczyk Grzegorz, AMG.net
 * @author Konrad Król, AMG.net
 */
public interface HeatClient {

    /**
     * Create new stack in Heat
     * @param stack
     */
    public void createStack(HeatStack stack);
    
    /**
     * Updates an existing stack in Heat
     * @param stackName
     *  - name of the existing stack
     * @param stackId
     *  - id of the existing stack
     * @param stack
     *  - stack containing new template
     */
    public void updateStack(String stackName, String stackId, HeatStack stack);

    /**
     * Get details of existing stack with given name
     * @param stackName
     * @return stack details 
     */
    public StackData getStackDetails(String stackName);
    
    /**
     * Get details of stack resources
     * @param stackName
     * @return
     */
    public StackResources getStackResources(String stackId);

    /**
     * Delete existing stack
     * @param stackNameOrId
     */
    public void deleteStack(String stackNameOrId);
    
    /**
     * It validates template by calling heat validate method.
     * @param template template formatted as a JSON String.
     * @throws OpenStackException when heat returned error response
     * @throws UniformInterfaceException when unexpected response occured (non-parseable)
     */
    public void validateTemplate(String template) throws UniformInterfaceException, OpenStackException;
    
    /**
     * 
     * Suspends stack Heat
     * @param stackName
     * @param stackId
     */
    public void suspendStack(String stackName);
     
    /**
     * 
     * Resumes stack Heat
     * @param stackName
     * @param stackId
     */
    public void resumeStack(String stackName);
}