org.openstack4j.api.heat.TemplateService Maven / Gradle / Ivy

package org.openstack4j.api.heat;

import java.util.Map;

import org.openstack4j.model.heat.Template;
import org.openstack4j.model.heat.TemplateResponse;

/**
 * This Interface contains a non-exhaustive list of methods for the manipulation of Heat Templates
 * @author Matthias Reisser
 *
 */
public interface TemplateService {

	/**
	 * Validates the template
	 * @param template to validate, passed as a {@link Template}
	 * @return TemplateResponse indicating valid or the error condition if not valid
	 */
	TemplateResponse validateTemplate(Template template);
	
	/**
	 * Validates the template
	 * @param template to validate, passed as {@link String} in JSON Format
	 * @return TemplateResponse indicating valid or the error condition if not valid
	 */
	TemplateResponse validateTemplate(String template);
	
	/**
     * Validates the template
     * 
     * @param templateURL the remote template via URL to validate
     * @return TemplateResponse indicating valid or the error condition if not valid
     */
    TemplateResponse validateTemplateByURL(String templateURL);
    
    /**
     * Retrieves the original template in original String form JSON or YAML
     * @param stackName the stack name
     * @param stackId the stack identifier
     * @return the template
     * @throws ResponseException if an error occurs
     */
    String getTemplateAsString(String stackName, String stackId);
    
    /**
     * Retrieves the original template as Map
     * @param stackName the stack name
     * @param stackId the stack identifier
     * @return the template
     * @throws ResponseException if an error occurs
     */
    Map getTemplateAsMap(String stackName, String stackId);
    
    /**
     * Retrieves the original template as Map when you know only the stack name or stack id
     * @param stackNameOrId the stack name or stackId
     * @return the template
     * @throws ResponseException if an error occurs
     */
    Map getTemplateAsMap(String stackNameOrId);
    
    
	
}