io.cloudsoft.tosca.a4c.brooklyn.ToscaFacade Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of brooklyn-tosca-transformer Show documentation

TOSCA support for Brooklyn plans leveraging Alien4Cloud

The newest version!

package io.cloudsoft.tosca.a4c.brooklyn;

import java.nio.file.Path;
import java.util.Map;

import org.apache.brooklyn.camp.brooklyn.spi.dsl.BrooklynDslDeferredSupplier;
import org.apache.brooklyn.config.ConfigKey;

import com.google.common.base.Optional;

/**
 * A facade to the tosca model
 * @param  The type of ToscaApplication used
 */
public interface ToscaFacade {

    Map getPropertiesAndTypeValuesByRelationshipId(String nodeId, A toscaApplication, String relationshipId, String computeName);

    /**
     * @param nodeId the node id
     * @param toscaApplication the tosca application
     * @param artifactId
     * @return the Path to the artifact with the given id
     */
    Optional getArtifactPath(String nodeId, A toscaApplication, String artifactId);

    /**
     * @param nodeId the node id
     * @param toscaApplication the tosca application
     * @return the artifact ids for the given node
     */
    Iterable getArtifacts(String nodeId, A toscaApplication);

    /**
     * @param archiveName the name of the archive
     * @param archiveVersion the version of the archive
     * @return the Path of the CSAR archive
     */
    Optional getCsarPath(String archiveName, String archiveVersion);

    /**
     * @param opKey the key of the operation
     * @return The Brooklyn ConfigKey corresponding to the lifecycle operation
     */
    ConfigKey getLifeCycle(String opKey);

    /**
     * @param nodeId the node id
     * @param toscaApplication the tosca application
     * @return The id of the parent node
     */
    String getParentId(String nodeId, A toscaApplication);

    /**
     * @param nodeId the node id
     * @param toscaApplication the tosca application
     * @return The Map of resolved attributes
     */
    Map getResolvedAttributes(String nodeId, A toscaApplication);

    /**
     * @param opKey the key name of the operation
     * @param nodeId the node id
     * @param toscaApplication the tosca application
     * @param computeName the name of the compute node
     * @param expandedFolder the name of the expanded folder
     * @return The script associated with the operation.  This optional script may be in the form
     * of a String if all input values have been resolved, otherwise a  {@link
     * BrooklynDslDeferredSupplier}
     */
    Optional