Class ModuleEssentialData

java.lang.Object
org.junit.rules.ExternalResource
de.hybris.platform.integrationservices.util.impex.ModuleEssentialData
All Implemented Interfaces:
org.junit.rules.TestRule
Direct Known Subclasses:
InboundServicesEssentialData, IntegrationServicesEssentialData, Odata2ServicesEssentialData, Odata2WebServicesEssentialData, OutboundServicesEssentialData, OutboundSyncEssentialData, WebhookServicesEssentialData

public abstract class ModuleEssentialData extends org.junit.rules.ExternalResource
All essential data present in a module
  • Constructor Details

  • Method Details

    • enableDependencies

      protected void enableDependencies()
      Adds other module essential data, this module depends on.
    • getDependencies

      @Nonnull protected abstract List<ModuleEssentialData> getDependencies()
      Retrieves other modules this essential data module depends on.
      Returns:
      a list of other modules this essential data depends on or an empty list, if this module does not depend on other modules.
    • getAllIntegrationObjectCodes

      public Set<String> getAllIntegrationObjectCodes()
      Retrieves integration objects loaded by this module essential data. If dependencies are loaded, integration objects from them also.
      Returns:
      codes of all integration objects
    • getAllIntegrationObjectItemCodes

      public Set<String> getAllIntegrationObjectItemCodes()
      Retrieves integration object items loaded by this module essential data. If dependencies are loaded, integration object items from them also.
      Returns:
      codes of all integration object items
    • before

      protected void before()
      Overrides:
      before in class org.junit.rules.ExternalResource
    • after

      protected void after()
      Overrides:
      after in class org.junit.rules.ExternalResource
    • load

      public void load()
      Loads all essential data in this module.
    • registerIntegrationObjects

      protected static Set<String> registerIntegrationObjects(Collection<String> registry, String... ioCodes)
      Registers Integration Object codes with the given registry
      Parameters:
      registry - Registry to add the integration object codes
      ioCodes - Integration Object codes
      Returns:
      Set of Integration Object codes
    • cleanup

      public void cleanup()
      Deletes all essential data present in this module from the system.
    • deleteInboundChannelConfigurations

      protected static void deleteInboundChannelConfigurations(Collection<String> ioCodes)
      Deletes all inbound channel configurations associated with the specified integration objects.
      Parameters:
      ioCodes - codes of integration objects, for which inbound channel configuration should be deleted.
    • deleteIntegrationObjects

      protected static void deleteIntegrationObjects(Collection<String> ioCodes)
      Deletes the specified integration objects.
      Parameters:
      ioCodes - code of the integration objects to be deleted.
    • clearAccessRightsForTypes

      protected static void clearAccessRightsForTypes(Collection<String> typeCodes)
      Removes all access right permisions granted to the specified types.
      Parameters:
      typeCodes - a collection of {code ComposedType} codes, for which permissions need to be cleared.
    • toString

      public String toString()
      Overrides:
      toString in class Object