Package com.hybris.backoffice.config.impl

Interface BackofficeConfigurationMediaHelper

All Known Implementing Classes:
DefaultBackofficeConfigurationMediaHelper
public interface BackofficeConfigurationMediaHelper
Allows basic operations on Backoffice configuration media

  • Method Details

    • findOrCreateWidgetsConfigMedia

      MediaModel findOrCreateWidgetsConfigMedia(String mediaCode, String mediaMime, Consumer<MediaModel> newMediaInitializer)
      Searches for Backoffice configuration media and creates one in case media is not found.
      Parameters:
      mediaCode - code of MediaModel to be searched for
      mediaMime - mime type used when new MediaModel is created
      newMediaInitializer - initializer callback to call for new media created by this method
      Returns:
      MediaModel corresponding with given mediaCode

    • findOrCreateWidgetsConfigMedia

      MediaModel findOrCreateWidgetsConfigMedia(String mediaCode, String mediaMime)
      Searches for Backoffice configuration media and creates one in case media is not found.
      Parameters:
      mediaCode - code of MediaModel to be searched for
      mediaMime - mime type used when new MediaModel is created
      Returns:
      MediaModel corresponding with given mediaCode

    • findWidgetsConfigMedia

      MediaModel findWidgetsConfigMedia(String mediaCode)
      Searches for Backoffice configuration media and removes all configurations if given mediaCode
      is ambiguous.
      Parameters:
      mediaCode - code of MediaModel to be searched for
      Returns:
      MediaModel corresponding with given mediaCode

    • createWidgetsConfigMedia

      MediaModel createWidgetsConfigMedia(String mediaCode, String mediaMime)
      Creates Backoffice configuration media and in case media cannot be created
      returns existing media with given code
      Parameters:
      mediaCode - code of MediaModel to be created
      mediaMime - mime type used when new MediaModel is created
      Returns:
      MediaModel corresponding with given mediaCode

    • getSecureFolder

      MediaFolderModel getSecureFolder()
      The method tries to load the Media Folder of 'backofficeconfiguration' qualifier. If the folder is found it is returned. Otherwise the method tries to create it and return. In case of a race condition, where two subsequent saves happen and the method fails to save the folder, it re-tries the fetch and return before it finally fails.
      Returns:
      the standard secure media folder for backoffice configurations
      See Also: