Package com.helger.peppol.sml

Enum Class ESML

java.lang.Object
java.lang.Enum<ESML>
com.helger.peppol.sml.ESML
All Implemented Interfaces:
com.helger.base.id.IHasID<String>, com.helger.base.name.IHasDisplayName, com.helger.base.type.IHasObjectType, com.helger.base.type.ITypedObject<String>, ISMLInfo, Serializable, Comparable<ESML>, Constable
public enum ESML extends Enum<ESML> implements ISMLInfo
Simple enumeration for differentiating the different available SMLs.
  • DIGIT_PRODUCTION - DIGIT production URL - valid from June 9th, 2015
  • DIGIT_TEST - DIGIT test URL - valid from June 9th, 2015
  • PEPPOL_PRODUCTION - valid from March 1st, 2026
  • PEPPOL_TEST - valid from March 1st, 2026
  • DEVELOPMENT_LOCAL - used for development environment assuming the management application is running on localhost in the ROOT context!
Author:
Philip Helger

  • Enum Constant Details

    • DIGIT_PRODUCTION

      @Deprecated(forRemoval=true, since="12.4.0") public static final ESML DIGIT_PRODUCTION
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use PEPPOL_PRODUCTION instead
      DIGIT production URL - valid from June 9th, 2015

    • DIGIT_TEST

      @Deprecated(forRemoval=true, since="12.4.0") public static final ESML DIGIT_TEST
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use PEPPOL_TEST instead
      DIGIT test URL - valid from June 9th, 2015.

    • PEPPOL_PRODUCTION

      public static final ESML PEPPOL_PRODUCTION
      Peppol production URL - valid from March 19th, 2026

    • PEPPOL_TEST

      public static final ESML PEPPOL_TEST
      Peppol test URL - valid from March 19th, 2026

    • DEVELOPMENT_LOCAL

      public static final ESML DEVELOPMENT_LOCAL
      http://localhost:8080

  • Method Details

    • values

      public static ESML[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static ESML valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getProxy

      public @NonNull ISMLInfo getProxy()

    • getObjectType

      public @NonNull com.helger.base.type.ObjectType getObjectType()
      Specified by:
      getObjectType in interface com.helger.base.type.IHasObjectType

    • getID

      @Nonempty public @NonNull @Nonempty String getID()
      Specified by:
      getID in interface com.helger.base.id.IHasID<String>

    • getDisplayName

      @Nonempty public @NonNull @Nonempty String getDisplayName()
      Specified by:
      getDisplayName in interface com.helger.base.name.IHasDisplayName
      Specified by:
      getDisplayName in interface ISMLInfo
      Returns:
      The "shorthand" display name like "SML" or "SMK".

    • getDNSZone

      @Nonempty public @NonNull @Nonempty String getDNSZone()
      Specified by:
      getDNSZone in interface ISMLInfo
      Returns:
      The DNS zone on which this SML is operating. Never null. It must be ensured that the value consists only of lower case characters!
      Example: sml.peppolcentral.org

    • getURLSuffixManageSMP

      public @NonNull String getURLSuffixManageSMP()
      Specified by:
      getURLSuffixManageSMP in interface ISMLInfo
      Returns:
      The relative sub path for managing the service metadata on the SML server. If not empty, it must start with a slash ('/'). May not be null but maybe empty.

    • getManagementServiceURL

      @Nonempty public @NonNull @Nonempty String getManagementServiceURL()
      Specified by:
      getManagementServiceURL in interface ISMLInfo
      Returns:
      The service URL where the management application is running on including the host name. Never null. The difference to the host name is the eventually present context path. This path may never end with a slash.

    • getURLSuffixManageParticipant

      public @NonNull String getURLSuffixManageParticipant()
      Specified by:
      getURLSuffixManageParticipant in interface ISMLInfo
      Returns:
      The relative sub path for managing the participants on the SML server. If not empty, it must start with a slash ('/'). May not be null but maybe empty.

    • getManageServiceMetaDataEndpointAddress

      public @NonNull URL getManageServiceMetaDataEndpointAddress()
      Specified by:
      getManageServiceMetaDataEndpointAddress in interface ISMLInfo
      Returns:
      The service endpoint URL to manage SMP meta data. Never null. This is usually the URL corresponding to ISMLInfo.getManagementServiceURL() + ISMLInfo.getURLSuffixManageSMP()

    • getManageParticipantIdentifierEndpointAddress

      public @NonNull URL getManageParticipantIdentifierEndpointAddress()
      Specified by:
      getManageParticipantIdentifierEndpointAddress in interface ISMLInfo
      Returns:
      The service endpoint URL to manage participant identifiers. Never null. This is usually the URL corresponding to ISMLInfo.getManagementServiceURL() + ISMLInfo.getURLSuffixManageParticipant()

    • isClientCertificateRequired

      public boolean isClientCertificateRequired()
      Specified by:
      isClientCertificateRequired in interface ISMLInfo
      Returns:
      true if this SML requires a client certificate for access, false otherwise. Both PEPPOL production SML and SMK require a client certificate. Only a locally running SML software may not require a client certificate.

    • getFromIDOrNull

      public static @Nullable ESML getFromIDOrNull(@Nullable String sID)

    • getFromIDOrDefault

      public static @Nullable ESML getFromIDOrDefault(@Nullable String sID, @Nullable ESML eDefault)