Package com.hybris.backoffice.config.impl

Class BackofficeCockpitConfigurationService

java.lang.Object
com.hybris.cockpitng.core.config.impl.DefaultCockpitConfigurationService
com.hybris.cockpitng.modules.config.impl.ModuleAwareCockpitConfigurationService
com.hybris.backoffice.config.impl.BackofficeCockpitConfigurationService
All Implemented Interfaces:
com.hybris.cockpitng.core.config.CockpitConfigurationService, com.hybris.cockpitng.core.util.Resettable, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware
Direct Known Subclasses:
TestingBackofficeCockpitConfigurationService
public class BackofficeCockpitConfigurationService extends com.hybris.cockpitng.modules.config.impl.ModuleAwareCockpitConfigurationService
Backoffice extension of the ModuleAwareCockpitConfigurationService. The implementation uses MediaModel to persist the xml content.

  • Nested Class Summary

    Nested classes/interfaces inherited from class com.hybris.cockpitng.core.config.impl.DefaultCockpitConfigurationService

    com.hybris.cockpitng.core.config.impl.DefaultCockpitConfigurationService.CacheOperation, com.hybris.cockpitng.core.config.impl.DefaultCockpitConfigurationService.CacheOperationWithResult, com.hybris.cockpitng.core.config.impl.DefaultCockpitConfigurationService.LockState

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    COCKPITNG_CONFIG
    Deprecated, for removal: This API element is subject to removal in a future version.
    since 1811, the code will be removed
    static final String
    MIME_TYPE
    Deprecated, for removal: This API element is subject to removal in a future version.
    since 1811, the code will be removed

    Fields inherited from class com.hybris.cockpitng.core.config.impl.DefaultCockpitConfigurationService

    CHARSET_NAME, obligatoryMergeAttributes, PROPERTY_READ_ATTEMPT_TIMEOUT, PROPERTY_WRITE_ATTEMPT_TIMEOUT

  • Constructor Summary

    Constructors
    Constructor
    Description
    BackofficeCockpitConfigurationService()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected MediaModel
    createConfigFile()
    Deprecated, for removal: This API element is subject to removal in a future version.
    since 1811, the code will be removed, use DefaultMediaCockpitConfigurationPersistenceStrategy.getCockpitNGConfig()
    protected BackofficeConfigurationMediaHelper
    getBackofficeConfigurationMediaHelper()
    Deprecated, for removal: This API element is subject to removal in a future version.
    since 1811
    protected MediaModel
    getCockpitNGConfig()
    Deprecated, for removal: This API element is subject to removal in a future version.
    since 1811, the code will be removed
    protected ByteArrayOutputStream
    getConfigFileOutputStream()
    Deprecated, for removal: This API element is subject to removal in a future version.
    since 1811, the code will be removed
    protected long
    getCurrentTimeInMillis()
     
    protected InputStream
    getDefaultCockpitConfigAsStream()
     
    String
    getDefaultConfigFile()
     
    protected InputStream
    getInputStreamForMedia(MediaModel media)
    Deprecated, for removal: This API element is subject to removal in a future version.
    since 1811, the code will be removed
    protected MediaService
    getMediaService()
    Deprecated, for removal: This API element is subject to removal in a future version.
    since 1811
    protected ModelService
    getModelService()
    Deprecated, for removal: This API element is subject to removal in a future version.
    since 1811
    protected SessionService
    getSessionService()
    Deprecated, for removal: This API element is subject to removal in a future version.
    since 1811
    protected TimeService
    getTimeService()
     
    protected TypeService
    getTypeService()
     
    protected UserService
    getUserService()
    Deprecated, for removal: This API element is subject to removal in a future version.
    since 1811
    protected <C> void
    putConfigToCacheImmediately(com.hybris.cockpitng.core.config.ConfigContext context, Class<C> configType, C config)
     
    protected void
    resetToDefaultsInternal()
     
    void
    setBackofficeConfigurationMediaHelper(BackofficeConfigurationMediaHelper backofficeConfigurationMediaHelper)
    Deprecated, for removal: This API element is subject to removal in a future version.
    since 1811
    void
    setDefaultConfigFile(String defaultConfigFile)
     
    void
    setMediaService(MediaService mediaService)
    Deprecated, for removal: This API element is subject to removal in a future version.
    since 1811
    void
    setModelService(ModelService modelService)
    Deprecated, for removal: This API element is subject to removal in a future version.
    since 1811
    void
    setResetTrigger(AbstractBackofficeEventListener<?> callbackTrigger)
     
    void
    setSessionService(SessionService sessionService)
    Deprecated, for removal: This API element is subject to removal in a future version.
    since 1811
    void
    setTimeService(TimeService timeService)
     
    void
    setTypeService(TypeService typeService)
     
    void
    setUserService(UserService userService)
    Deprecated, for removal: This API element is subject to removal in a future version.
    since 1811

    Methods inherited from class com.hybris.cockpitng.modules.config.impl.ModuleAwareCockpitConfigurationService

    getApplicationContext, getCockpitModuleConnector, getLOG, setApplicationContext, setCockpitModuleConnector, setWidgetLibUtils

    Methods inherited from class com.hybris.cockpitng.core.config.impl.DefaultCockpitConfigurationService

    acquireReadLock, acquireWriteLock, adaptConfigAfterLoad, adaptConfigBeforeMerge, assureSecure, buildConfigurationContext, cacheMustBeInvalidated, cacheRootConfiguration, commitRootConfig, convertAttributes, convertConfigToString, createContextSearchTerms, createHighestRelevance, createMergeRelevance, createParentRestriction, createSearchProgress, createSearchRequest, createSearchTerms, createUpdatedSearchTerms, executeReadOperation, executeReadOperation, executeWriteOperation, findContext, findContext, findContextImmediately, getAdapters, getCacheValue, getCockpitProperties, getConfigAsString, getConfigAsStringImmediately, getConfigFileInputStream, getConfigFromCache, getConfigFromCacheImmediately, getConfigTypesAdapters, getConfigurationCache, getContext, getContextImmediately, getContextStrategies, getFallbackStrategies, getImportSupport, getLastModification, getMergeUtils, getNamespaceReplacements, getPersistenceStrategy, getRelevanceZones, getRootConfig, getRootConfigImmediately, getRootDir, getWidgetConfigurationContextDecoratorList, invalidateAttributesCache, invalidateAttributesCacheImmediately, invalidateConfigurationCache, invalidateConfigurationCacheImmediately, invalidateRootConfigurationCache, invalidateRootConfigurationCacheImmediately, isRootConfigurationCacheValid, loadConfiguration, loadConfiguration, loadConfiguration, loadConfigurationImmediately, loadConfigurationImmediately, loadRootConfigImmediately, loadRootConfiguration, loadRootConfiguration, logContextSearchProgress, logContextSearchResults, mergeContexts, onCacheInvalidation, putConfigToCache, releaseReadLock, releaseWriteLock, reset, resetToDefaults, setAdapters, setCockpitConfigValidator, setCockpitProperties, setConfigAsString, setConfigAsStringImmediately, setConfigTypesAdapters, setConfigurationCache, setContext, setContextImmediately, setContextStrategies, setFallbackStrategies, setImportSupport, setJaxbContextFactory, setMergeUtils, setNamespaceReplacements, setObligatoryMergeAttributes, setObligatoryMergeAttributesImmediately, setPersistenceStrategy, setWidgetConfigurationContextDecoratorList, storeConfigElement, storeConfiguration, storeConfigurationImmediately, storeRootConfig, storeRootConfigImmediately, validate, withDelayedWrite

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.hybris.cockpitng.core.config.CockpitConfigurationService

    getChangesAsConfig, getConfigAsString

  • Field Details

  • Constructor Details

    • BackofficeCockpitConfigurationService

      public BackofficeCockpitConfigurationService()

  • Method Details

    • getInputStreamForMedia

      @Deprecated(since="1811", forRemoval=true) protected InputStream getInputStreamForMedia(MediaModel media)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 1811, the code will be removed

    • getConfigFileOutputStream

      @Deprecated(since="1811", forRemoval=true) protected ByteArrayOutputStream getConfigFileOutputStream()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 1811, the code will be removed
      Overrides:
      getConfigFileOutputStream in class com.hybris.cockpitng.core.config.impl.DefaultCockpitConfigurationService

    • getCockpitNGConfig

      @Deprecated(since="1811", forRemoval=true) protected MediaModel getCockpitNGConfig() throws com.hybris.cockpitng.core.config.CockpitConfigurationException
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 1811, the code will be removed
      Get the media by code. If there is no media createConfigFile() will be called.
      Throws:
      com.hybris.cockpitng.core.config.CockpitConfigurationException

    • createConfigFile

      @Deprecated(since="1811", forRemoval=true) protected MediaModel createConfigFile()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 1811, the code will be removed, use DefaultMediaCockpitConfigurationPersistenceStrategy.getCockpitNGConfig()
      New media file will be created. The code will be set to 'cockpitmg-config', catalogversion will be set to 'default-staged', mime-type will be set to 'text/xml' and the data attribute will be set to a null-byte array. Get the media by code. If there is no media createConfigFile() will be called.
      See Also:

    • resetToDefaultsInternal

      protected void resetToDefaultsInternal()
      Overrides:
      resetToDefaultsInternal in class com.hybris.cockpitng.modules.config.impl.ModuleAwareCockpitConfigurationService

    • getDefaultCockpitConfigAsStream

      protected InputStream getDefaultCockpitConfigAsStream()

    • putConfigToCacheImmediately

      protected <C> void putConfigToCacheImmediately(com.hybris.cockpitng.core.config.ConfigContext context, Class<C> configType, C config)
      Overrides:
      putConfigToCacheImmediately in class com.hybris.cockpitng.core.config.impl.DefaultCockpitConfigurationService

    • getCurrentTimeInMillis

      protected long getCurrentTimeInMillis()
      Overrides:
      getCurrentTimeInMillis in class com.hybris.cockpitng.core.config.impl.DefaultCockpitConfigurationService

    • setResetTrigger

      public void setResetTrigger(AbstractBackofficeEventListener<?> callbackTrigger)

    • getMediaService

      @Deprecated(since="1811", forRemoval=true) protected MediaService getMediaService()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 1811

    • setMediaService

      @Deprecated(since="1811", forRemoval=true) public void setMediaService(MediaService mediaService)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 1811

    • getModelService

      @Deprecated(since="1811", forRemoval=true) protected ModelService getModelService()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 1811

    • setModelService

      @Deprecated(since="1811", forRemoval=true) public void setModelService(ModelService modelService)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 1811

    • getTypeService

      protected TypeService getTypeService()

    • setTypeService

      public void setTypeService(TypeService typeService)

    • getSessionService

      @Deprecated(since="1811", forRemoval=true) protected SessionService getSessionService()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 1811

    • setSessionService

      @Deprecated(since="1811", forRemoval=true) public void setSessionService(SessionService sessionService)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 1811

    • getUserService

      @Deprecated(since="1811", forRemoval=true) protected UserService getUserService()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 1811

    • setUserService

      @Deprecated(since="1811", forRemoval=true) public void setUserService(UserService userService)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 1811

    • getTimeService

      protected TimeService getTimeService()

    • setTimeService

      public void setTimeService(TimeService timeService)

    • getBackofficeConfigurationMediaHelper

      @Deprecated(since="1811", forRemoval=true) protected BackofficeConfigurationMediaHelper getBackofficeConfigurationMediaHelper()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 1811

    • setBackofficeConfigurationMediaHelper

      @Deprecated(since="1811", forRemoval=true) public void setBackofficeConfigurationMediaHelper(BackofficeConfigurationMediaHelper backofficeConfigurationMediaHelper)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 1811

    • getDefaultConfigFile

      public String getDefaultConfigFile()

    • setDefaultConfigFile

      public void setDefaultConfigFile(String defaultConfigFile)