Package de.gematik

Class BaseMojo

  • All Implemented Interfaces:
    org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
    Direct Known Subclasses:
    CheckMojo, CombineMojo, PrepareItemsMojo
    public abstract class BaseMojo
extends org.apache.maven.plugin.AbstractMojo

    • Field Detail

      • GENERATED_COMBINE_ITEMS_DIR

        public static final String GENERATED_COMBINE_ITEMS_DIR
        Path to the directory where the combined items get stored

      • apiErrors

        protected final List<String> apiErrors

    • Constructor Detail

      • BaseMojo

        public BaseMojo()

    • Method Detail

      • getApiErrors

        public List<String> getApiErrors()

      • getCombineItemsFile

        public String getCombineItemsFile()
        Path to file that contains the values to combine

      • getTruststore

        public String getTruststore()
        Path to truststore

      • getTruststorePw

        public String getTruststorePw()
        Path to truststore

      • getClientCertStore

        public String getClientCertStore()
        Path to truststore

      • getClientCertStorePw

        public String getClientCertStorePw()
        Path to truststore

      • getProxyHost

        public String getProxyHost()
        Host to use for proxy

      • getProxyPort

        public Integer getProxyPort()
        Port to use for proxy

      • isSkip

        public boolean isSkip()
        Parameter to decide if plugin should be executed. All executions are skipped

      • isBreakOnFailedRequest

        public boolean isBreakOnFailedRequest()
        Decide if run should break on one or more failed requests. If set to false, will generate a combine_items.json file with responding APIs only (if any).

      • isBreakOnContextError

        public boolean isBreakOnContextError()
        Decide if the build should break if at least one manual set Tag/Property does not match the found value on info endpoint.

      • getAcceptedResponseFamilies

        public String getAcceptedResponseFamilies()
        Decide which response-families are valid for each request and should be parsed. (CSV separated) Is List of: INFO -> 100-199 SUCCESS -> 200-299 REDIRECTION -> 300-399 CLIENT_ERROR -> 400 - 499 SERVER_ERROR -> 500 - 599 ALL -> All requests are valid Default Success

      • getAllowedResponseCodes

        public String getAllowedResponseCodes()
        If it's not wanted to work with response-families specific response codes could be named. Overrides acceptedResponseFamilies Codes provided in CSV-format

      • setCombineItemsFile

        public void setCombineItemsFile​(String combineItemsFile)
        Path to file that contains the values to combine

      • setTruststore

        public void setTruststore​(String truststore)
        Path to truststore

      • setTruststorePw

        public void setTruststorePw​(String truststorePw)
        Path to truststore

      • setClientCertStore

        public void setClientCertStore​(String clientCertStore)
        Path to truststore

      • setClientCertStorePw

        public void setClientCertStorePw​(String clientCertStorePw)
        Path to truststore

      • setProxyHost

        public void setProxyHost​(String proxyHost)
        Host to use for proxy

      • setProxyPort

        public void setProxyPort​(Integer proxyPort)
        Port to use for proxy

      • setSkip

        public void setSkip​(boolean skip)
        Parameter to decide if plugin should be executed. All executions are skipped

      • setBreakOnFailedRequest

        public void setBreakOnFailedRequest​(boolean breakOnFailedRequest)
        Decide if run should break on one or more failed requests. If set to false, will generate a combine_items.json file with responding APIs only (if any).

      • setBreakOnContextError

        public void setBreakOnContextError​(boolean breakOnContextError)
        Decide if the build should break if at least one manual set Tag/Property does not match the found value on info endpoint.

      • setAcceptedResponseFamilies

        public void setAcceptedResponseFamilies​(String acceptedResponseFamilies)
        Decide which response-families are valid for each request and should be parsed. (CSV separated) Is List of: INFO -> 100-199 SUCCESS -> 200-299 REDIRECTION -> 300-399 CLIENT_ERROR -> 400 - 499 SERVER_ERROR -> 500 - 599 ALL -> All requests are valid Default Success

      • setAllowedResponseCodes

        public void setAllowedResponseCodes​(String allowedResponseCodes)
        If it's not wanted to work with response-families specific response codes could be named. Overrides acceptedResponseFamilies Codes provided in CSV-format