Package com.helger.peppol.sml

Enum ESML

java.lang.Object
java.lang.Enum<ESML>
com.helger.peppol.sml.ESML
All Implemented Interfaces:
com.helger.commons.id.IHasID<String>, com.helger.commons.name.IHasDisplayName, com.helger.commons.type.IHasObjectType, com.helger.commons.type.ITypedObject<String>, ISMLInfo, Serializable, Comparable<ESML>, java.lang.constant.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
  • 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

      public static final ESML DIGIT_PRODUCTION
      DIGIT production URL - valid from June 9th, 2015

    • DIGIT_TEST

      public static final ESML DIGIT_TEST
      DIGIT test URL - valid from June 9th, 2015

    • 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 type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static ESML valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name
      NullPointerException - if the argument is null

    • getObjectType

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

    • getID

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

    • getDisplayName

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

    • getDNSZone

      @Nonnull @Nonempty public 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

    • getManagementServiceURL

      @Nonnull @Nonempty public 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.

    • getManageServiceMetaDataEndpointAddress

      @Nonnull public 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() + "/" + CSMLDefault.MANAGEMENT_SERVICE_METADATA

    • getManageParticipantIdentifierEndpointAddress

      @Nonnull public 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() + "/" + CSMLDefault.MANAGEMENT_SERVICE_PARTICIPANTIDENTIFIER

    • 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

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

    • getFromIDOrDefault

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