Package com.helger.phase4.profile

Interface IAS4ProfileManager

All Superinterfaces:
IAS4ProfileRegistrar
All Known Implementing Classes:
AS4ProfileManager
public interface IAS4ProfileManager extends IAS4ProfileRegistrar
Base interface for an AS4 profile manager.
Since:
0.10.4
Author:
Philip Helger

  • Method Details

    • getAllProfiles

      @Nonnull @ReturnsMutableCopy com.helger.commons.collection.impl.ICommonsList<IAS4Profile> getAllProfiles()
      Returns:
      A non-null but maybe empty list of all contained profiles.

    • getProfileOfID

      @Nullable IAS4Profile getProfileOfID(@Nullable String sID)
      Find an existing profile with a certain ID.
      Parameters:
      sID - The ID to search. May be null.
      Returns:
      null if no such profile exists

    • hasDefaultProfile

      boolean hasDefaultProfile()
      Returns:
      true if an explicit default profile is present, false if not.

    • getDefaultProfileOrNull

      @Nullable IAS4Profile getDefaultProfileOrNull()
      Returns:
      The default profile. If none is set, and exactly one profile is present, it is used. null if no default is present and more than one profile is registered

    • getDefaultProfile

      @Nonnull IAS4Profile getDefaultProfile()
      Returns:
      The default profile. If none is set, and exactly one profile is present, it is used. If no default profile is present and more than one profile is present an Exception is thrown.
      Throws:
      IllegalStateException - If no default is present and more than one profile is registered

    • setDefaultProfileID

      @Nullable default IAS4Profile setDefaultProfileID(@Nullable String sDefaultProfileID)
      Set the default profile to be used.
      Parameters:
      sDefaultProfileID - The ID of the default profile. May be null.
      Returns:
      null if no such profile is registered, the resolve profile otherwise.