Package com.helger.peppol.sml

Interface ISMLInfo

All Superinterfaces:
com.helger.base.name.IHasDisplayName, com.helger.base.id.IHasID<String>, com.helger.base.type.IHasObjectType, com.helger.base.type.ITypedObject<String>, Serializable
All Known Implementing Classes:
ESML, SMLInfo
@MustImplementEqualsAndHashcode public interface ISMLInfo extends com.helger.base.type.ITypedObject<String>, com.helger.base.name.IHasDisplayName, Serializable
Specifies the different properties an SML implementation uses. A set of predefined SML information can be found at ESML whereas a generic implementation can be found at SMLInfo.
Author:
Philip Helger

  • Method Details

    • getDisplayName

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

    • getDNSZone

      @Nonempty @NonNull @Nonempty String getDNSZone()
      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

    • getPublisherDNSZone

      @Nonempty @Deprecated(forRemoval=true, since="12.1.1") default @NonNull @Nonempty String getPublisherDNSZone()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Since the DNS entries were removed
      Returns:
      The DNS sub zone name that is used for SMP publishers. This is done by prepending CSMLDefault.DNS_PUBLISHER_SUBZONE to the DNS zone name - never starts with a dot! May not be null. This is only needed when the Peppol way of registration is used.
      See Also:

    • getManagementServiceURL

      @Nonempty @NonNull @Nonempty String getManagementServiceURL()
      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.

    • getURLSuffixManageSMP

      @NonNull String getURLSuffixManageSMP()
      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.
      Since:
      12.1.0

    • getManageServiceMetaDataEndpointAddress

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

    • getURLSuffixManageParticipant

      @NonNull String getURLSuffixManageParticipant()
      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.
      Since:
      12.1.0

    • getManageParticipantIdentifierEndpointAddress

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

    • isClientCertificateRequired

      boolean isClientCertificateRequired()
      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.