Package com.xebialabs.deployit.plugin.api.udm.base

Class BaseDeployableArtifact

java.lang.Object
com.xebialabs.deployit.plugin.api.udm.base.BaseConfigurationItem
com.xebialabs.deployit.plugin.api.udm.base.BaseDeployable
com.xebialabs.deployit.plugin.api.udm.base.BaseDeployableArtifact
All Implemented Interfaces:
Artifact, SourceArtifact, ConfigurationItem, Deployable, DeployableArtifact, Taggable, Serializable, Comparable<BaseConfigurationItem>
Direct Known Subclasses:
BaseDeployableFileArtifact, BaseDeployableFolderArtifact
@Metadata(virtual=true, description="The supertype of all DeployableArtifacts.") public class BaseDeployableArtifact extends BaseDeployable implements DeployableArtifact
See Also:

  • Field Details

  • Constructor Details

    • BaseDeployableArtifact

      public BaseDeployableArtifact()

  • Method Details

    • getCredentials

      public com.xebialabs.deployit.plugin.credentials.Credentials getCredentials()
      Description copied from interface: SourceArtifact
      Returns the credentials for artifact location.
      Specified by:
      getCredentials in interface SourceArtifact

    • setCredentials

      public void setCredentials(com.xebialabs.deployit.plugin.credentials.Credentials credentials)

    • getProxySettings

      public com.xebialabs.deployit.plugin.proxy.ProxySettings getProxySettings()
      Description copied from interface: SourceArtifact
      Returns the proxy settings for artifact location.
      Specified by:
      getProxySettings in interface SourceArtifact

    • setProxySettings

      public void setProxySettings(com.xebialabs.deployit.plugin.proxy.ProxySettings proxySettings)

    • getFile

      public com.xebialabs.overthere.OverthereFile getFile()
      Specified by:
      getFile in interface Artifact
      Returns:
      A representation of a file that can be access through an Overthere connection.

    • setFile

      public void setFile(com.xebialabs.overthere.OverthereFile file)
      Specified by:
      setFile in interface Artifact
      Parameters:
      file - A representation of a file that can be access through an Overthere connection.

    • isScanPlaceholders

      public boolean isScanPlaceholders()

    • setScanPlaceholders

      public void setScanPlaceholders(boolean scanPlaceholders)

    • isPreScannedPlaceholders

      public boolean isPreScannedPlaceholders()

    • setPreScannedPlaceholders

      public void setPreScannedPlaceholders(boolean preScannedPlaceholders)

    • getPlaceholders

      public Set<String> getPlaceholders()
      Specified by:
      getPlaceholders in interface SourceArtifact

    • setPlaceholders

      public void setPlaceholders(Set<String> placeholders)
      Specified by:
      setPlaceholders in interface SourceArtifact

    • getTextFileNamesRegex

      public String getTextFileNamesRegex()
      Specified by:
      getTextFileNamesRegex in interface SourceArtifact

    • setTextFileNamesRegex

      public void setTextFileNamesRegex(String textFileNamesRegex)

    • getExcludeFileNamesRegex

      public String getExcludeFileNamesRegex()
      Specified by:
      getExcludeFileNamesRegex in interface SourceArtifact
      Returns:
      regex that captures all the files that should not be scanned.

    • getFileEncodings

      public Map<String,String> getFileEncodings()
      Description copied from interface: SourceArtifact
      This will return a map that specifies which files map to which encodings. By default XL Deploy will use UTF-8 for replacing placeholders in files, unless this property contains a regex as key which matches the path of the file within the artifact. If a key matches, XL Deploy will use the attached value in the map as encoding for replacing placeholders in the file.
      Specified by:
      getFileEncodings in interface SourceArtifact
      Returns:
      map that maps a regex to a target encoding for a file.

    • getFileUri

      public String getFileUri()
      Description copied from interface: SourceArtifact
      Returns the artifact location which can be resolved using an artifact resolver.
      Specified by:
      getFileUri in interface SourceArtifact

    • setExcludeFileNamesRegex

      public void setExcludeFileNamesRegex(String excludeFileNamesRegex)

    • getChecksum

      public String getChecksum()
      Description copied from interface: SourceArtifact
      Returns the (calculated or user-defined) checksum of the artifact file.
      Specified by:
      getChecksum in interface SourceArtifact

    • setChecksum

      public void setChecksum(String checksum)

    • getDelimiters

      public String getDelimiters()

    • setDelimiters

      public void setDelimiters(String delimiters)

    • getRescanned

      public boolean getRescanned()

    • setRescanned

      public void setRescanned(boolean rescanned)