catalog-be/src/main/java/org/openecomp/sdc/be/components/distribution/engine/IArtifactInfo.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * SDC
   4  * ================================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.openecomp.sdc.be.components.distribution.engine;
  22
  23 import org.openecomp.sdc.common.api.ArtifactTypeEnum;
  24
  25 public interface IArtifactInfo {
  26
  27     /** Artifact File name */
  28     String getArtifactName();
  29
  30     /**
  31      * Artifact Type.<br>
  32      * Following are valid values : HEAT , DG_XML. <br>
  33      * List of values will be extended in post-1510 releases.
  34      */
  35     ArtifactTypeEnum getArtifactType();
  36
  37     /**
  38      * Relative artifact's URL. Should be used in REST GET API to download the artifact's payload.<br>
  39      * The full artifact URL will be in the following format :<br>
  40      * https://{serverBaseURL}/{resourcePath}<br>
  41      * serverBaseURL - Hostname ( ASDC LB FQDN) + optional port <br>
  42      * resourcePath - "artifactURL" <br>
  43      * Ex : https://asdc.sdc.com/v1/catalog/services/srv1/2.0/resources/aaa/1.0/artifacts/aaa.yml
  44      */
  45     String getArtifactURL();
  46
  47     /**
  48      * Base-64 encoded MD5 checksum of the artifact's payload.<br>
  49      * Should be used for data integrity validation when an artifact's payload is downloaded.<br>
  50      */
  51     String getArtifactChecksum();
  52
  53     /**
  54      * Installation timeout. Used by the orchestrator.
  55      */
  56     Integer getArtifactTimeout();
  57
  58     /**
  59      * Artifact description
  60      */
  61     String getArtifactDescription();
  62
  63 }