Package com.hybris.cockpitng.core.impl

Class DefaultCockpitComponentDefinitionService

java.lang.Object

com.hybris.cockpitng.core.impl.DefaultCockpitComponentDefinitionService

All Implemented Interfaces:

CockpitComponentDefinitionService, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

Direct Known Subclasses:

CockpitModuleComponentDefinitionService

public class DefaultCockpitComponentDefinitionService
extends java.lang.Object
implements CockpitComponentDefinitionService, org.springframework.context.ApplicationContextAware

This implementation of the CockpitComponentDefinitionService has a list of CockpitComponentLoaders to load widget definitions using them. It provides all WidgetDefinitions from all CockpitComponentLoader s it holds.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DEFAULT_VIEW_ZUL
static java.lang.String	NO_VIEW_ZUL
static java.lang.String	PROPERTY_WIDGET_LIBRARY_BLACKLIST

Constructor Summary

Constructors

Constructor	Description
DefaultCockpitComponentDefinitionService()

Method Summary

Modifier and Type	Method	Description
protected void	beforeCreateDefinition(CockpitComponentInfo info)	Override to do manipulations to component info before creation of definition
protected boolean	checkIfEmpty(WidgetDefinition target, java.util.function.Function<WidgetDefinition,?> override)
void	clearDefinitions()	Clears components definitions.
<T> T	createAutowiredComponent(AbstractCockpitComponentDefinition root, java.lang.String className, org.springframework.context.ApplicationContext context)	Creates autowired component
<T> T	createAutowiredComponent(AbstractCockpitComponentDefinition root, java.lang.String className, org.springframework.context.ApplicationContext context, boolean cachedInstance)	Creates autowired component
protected <T> T	createClassInstance(org.springframework.context.ApplicationContext context, java.lang.Class clazz)
protected java.util.Collection<java.lang.String>	fetchWidgetBlacklist()
protected void	fillInheritedDefinition(WidgetDefinition definition, WidgetDefinition extension, java.util.function.Predicate<java.util.function.Function<WidgetDefinition,?>> overrideCheck)
protected void	fillInheritedFields(WidgetDefinition definition)
protected TypedSettingsMap	fillInheritedSettings(WidgetDefinition override, WidgetDefinition base)
java.util.List<AbstractCockpitComponentDefinition>	getAllComponentDefinitions()	Provides all component definitions available in the system.
protected CockpitApplicationContext	getApplicationContext()
org.springframework.context.ApplicationContext	getApplicationContext(AbstractCockpitComponentDefinition definition)
java.lang.ClassLoader	getClassLoader(AbstractCockpitComponentDefinition definition)	Deprecated, for removal: This API element is subject to removal in a future version. since 1808, please use CockpitApplicationContext.getClassLoader()
CockpitProperties	getCockpitProperties()
AbstractCockpitComponentDefinition	getComponentDefinitionForCode(java.lang.String code)	Looks for a component definition with the given Editor code (example: 'com.hybris.cockpitng.editor.defaulttext')
<T extends AbstractCockpitComponentDefinition> T	getComponentDefinitionForCode(java.lang.String code, java.lang.Class<T> componentType)	Looks for a component definition with the given code.
<T extends AbstractCockpitComponentDefinition> java.util.List<T>	getComponentDefinitionsByClass(java.lang.Class<T> componentType)	Provides all component definitions of given type.
java.util.List<CockpitComponentLoader>	getDefinitionLoaders()
java.util.Collection<AbstractCockpitComponentDefinition>	getExtensionsDefinitions()	Get components definitions for extensions.
protected java.util.Optional<CockpitComponentDefinitionFactory>	getFactoryForInfo(CockpitComponentInfo info)
java.util.Map<java.lang.String,WidgetDefinition>	getStubWidgetDefinitions()	Returns all stub widget definitions that were registered for 'non-widget' aware components
protected <T> void	inheritFieldValue(WidgetDefinition definition, WidgetDefinition extension, java.util.function.Predicate<java.util.function.Function<WidgetDefinition,?>> overrideCheck, java.util.function.Function<WidgetDefinition,T> getter, java.util.function.Consumer<T> setter)
protected boolean	isBlacklisted(AbstractCockpitComponentDefinition definition, java.util.Collection<java.lang.String> blacklist)
protected boolean	isDuplicate(AbstractCockpitComponentDefinition definition)
protected java.util.Optional<AbstractCockpitComponentDefinition>	loadDefinitionForComponentInfo(CockpitComponentInfo info, java.util.Collection<java.lang.String> widgetBlacklist)
protected void	loadDefinitions()
protected java.util.Set<CockpitComponentInfo>	loadInfos(CockpitComponentLoader loader)
protected void	processComponentInfo(CockpitComponentInfo info, java.util.Collection<java.lang.String> widgetBlacklist, java.util.function.Predicate<AbstractCockpitComponentDefinition> definitionTest)
protected void	processExtensions()
protected void	processInheritanceHierarchy()
protected void	registerWidgetStubDefinitions(AbstractCockpitComponentDefinition definition)
void	reloadDefinitions()	Reloads all component definitions.
void	setApplicationContext(org.springframework.context.ApplicationContext ctx)
void	setCockpitProperties(CockpitProperties cockpitProperties)
void	setDefinitionFactories(java.util.Map<java.lang.String,CockpitComponentDefinitionFactory> factories)
void	setDefinitionLoaders(java.util.List<CockpitComponentLoader> definitionLoaders)
void	setToResetAfterReload(java.util.List<Resettable> toResetAfterReload)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_VIEW_ZUL

public static final java.lang.String DEFAULT_VIEW_ZUL

See Also:

Constant Field Values

NO_VIEW_ZUL

public static final java.lang.String NO_VIEW_ZUL

See Also:

Constant Field Values

PROPERTY_WIDGET_LIBRARY_BLACKLIST

public static final java.lang.String PROPERTY_WIDGET_LIBRARY_BLACKLIST

See Also:

Constant Field Values

Constructor Detail

DefaultCockpitComponentDefinitionService

public DefaultCockpitComponentDefinitionService()

Method Detail

getStubWidgetDefinitions

public java.util.Map<java.lang.String,WidgetDefinition> getStubWidgetDefinitions()

Description copied from interface: CockpitComponentDefinitionService

Returns all stub widget definitions that were registered for 'non-widget' aware components

Specified by:

getStubWidgetDefinitions in interface CockpitComponentDefinitionService

Returns:

all stub widget definitions

createAutowiredComponent

public <T> T createAutowiredComponent(AbstractCockpitComponentDefinition root,
                                      java.lang.String className,
                                      org.springframework.context.ApplicationContext context)
                               throws java.lang.ReflectiveOperationException

Description copied from interface: CockpitComponentDefinitionService

Creates autowired component

Specified by:

createAutowiredComponent in interface CockpitComponentDefinitionService

Type Parameters:

T - type of created component

Parameters:

root - component definition

className - class of the component to be created

context - Spring application context from which the dependencies should be wired; if null the dependencies are not wired only the instance is created

Returns:

component with wired dependencies

Throws:

java.lang.ReflectiveOperationException - when it is impossible to create instance of class of given name

createAutowiredComponent

public <T> T createAutowiredComponent(AbstractCockpitComponentDefinition root,
                                      java.lang.String className,
                                      org.springframework.context.ApplicationContext context,
                                      boolean cachedInstance)
                               throws java.lang.ReflectiveOperationException

Description copied from interface: CockpitComponentDefinitionService

Creates autowired component

Specified by:

createAutowiredComponent in interface CockpitComponentDefinitionService

Type Parameters:

T - type of created component

Parameters:

root - component definition

className - class of the component to be created

context - Spring application context from which the dependencies should be wired; if null the dependencies are not wired only the instance is created

cachedInstance - if true the created object will be cached; for stateful objects the parameter should be false

Returns:

component with wired dependencies

Throws:

java.lang.ReflectiveOperationException - when it is impossible to create instance of class of given name

createClassInstance

protected <T> T createClassInstance(org.springframework.context.ApplicationContext context,
                                    java.lang.Class clazz)
                             throws java.lang.InstantiationException,
                                    java.lang.IllegalAccessException

Throws:

java.lang.InstantiationException

java.lang.IllegalAccessException

getAllComponentDefinitions

public java.util.List<AbstractCockpitComponentDefinition> getAllComponentDefinitions()

Description copied from interface: CockpitComponentDefinitionService

Provides all component definitions available in the system.

Specified by:

getAllComponentDefinitions in interface CockpitComponentDefinitionService

Returns:

all component definitions available in the system

getComponentDefinitionsByClass

public <T extends AbstractCockpitComponentDefinition> java.util.List<T> getComponentDefinitionsByClass(java.lang.Class<T> componentType)

Description copied from interface: CockpitComponentDefinitionService

Provides all component definitions of given type.

Specified by:

getComponentDefinitionsByClass in interface CockpitComponentDefinitionService

Parameters:

componentType - class of component

Returns:

all component definitions available in the system

getComponentDefinitionForCode

public AbstractCockpitComponentDefinition getComponentDefinitionForCode(java.lang.String code)

Description copied from interface: CockpitComponentDefinitionService

Looks for a component definition with the given Editor code (example: 'com.hybris.cockpitng.editor.defaulttext')

Specified by:

getComponentDefinitionForCode in interface CockpitComponentDefinitionService

Parameters:

code - the code of the component definition to be found

Returns:

the component definition with the given code

getComponentDefinitionForCode

public <T extends AbstractCockpitComponentDefinition> T getComponentDefinitionForCode(java.lang.String code,
                                                                                      java.lang.Class<T> componentType)

Description copied from interface: CockpitComponentDefinitionService

Looks for a component definition with the given code.

Specified by:

getComponentDefinitionForCode in interface CockpitComponentDefinitionService

Parameters:

code - the code of the component definition to be found

componentType - the expected class of the definition

Returns:

the component definition with the given code

getExtensionsDefinitions

public java.util.Collection<AbstractCockpitComponentDefinition> getExtensionsDefinitions()

Description copied from interface: CockpitComponentDefinitionService

Get components definitions for extensions.

Specified by:

getExtensionsDefinitions in interface CockpitComponentDefinitionService

setDefinitionFactories

public void setDefinitionFactories(java.util.Map<java.lang.String,CockpitComponentDefinitionFactory> factories)

reloadDefinitions

public void reloadDefinitions()

Description copied from interface: CockpitComponentDefinitionService

Reloads all component definitions.

Specified by:

reloadDefinitions in interface CockpitComponentDefinitionService

loadDefinitions

protected void loadDefinitions()

processComponentInfo

protected void processComponentInfo(CockpitComponentInfo info,
                                    java.util.Collection<java.lang.String> widgetBlacklist,
                                    java.util.function.Predicate<AbstractCockpitComponentDefinition> definitionTest)

loadDefinitionForComponentInfo

protected java.util.Optional<AbstractCockpitComponentDefinition> loadDefinitionForComponentInfo(CockpitComponentInfo info,
                                                                                                java.util.Collection<java.lang.String> widgetBlacklist)

isBlacklisted

protected boolean isBlacklisted(AbstractCockpitComponentDefinition definition,
                                java.util.Collection<java.lang.String> blacklist)

fetchWidgetBlacklist

protected java.util.Collection<java.lang.String> fetchWidgetBlacklist()

isDuplicate

protected boolean isDuplicate(AbstractCockpitComponentDefinition definition)

clearDefinitions

public void clearDefinitions()

Description copied from interface: CockpitComponentDefinitionService

Clears components definitions.

Specified by:

clearDefinitions in interface CockpitComponentDefinitionService

registerWidgetStubDefinitions

protected void registerWidgetStubDefinitions(AbstractCockpitComponentDefinition definition)

beforeCreateDefinition

protected void beforeCreateDefinition(CockpitComponentInfo info)

Override to do manipulations to component info before creation of definition

Parameters:

info -

loadInfos

protected java.util.Set<CockpitComponentInfo> loadInfos(CockpitComponentLoader loader)

processInheritanceHierarchy

protected void processInheritanceHierarchy()

fillInheritedFields

protected void fillInheritedFields(WidgetDefinition definition)

processExtensions

protected void processExtensions()

fillInheritedDefinition

protected void fillInheritedDefinition(WidgetDefinition definition,
                                       WidgetDefinition extension,
                                       java.util.function.Predicate<java.util.function.Function<WidgetDefinition,?>> overrideCheck)

fillInheritedSettings

protected TypedSettingsMap fillInheritedSettings(WidgetDefinition override,
                                                 WidgetDefinition base)

inheritFieldValue

protected <T> void inheritFieldValue(WidgetDefinition definition,
                                     WidgetDefinition extension,
                                     java.util.function.Predicate<java.util.function.Function<WidgetDefinition,?>> overrideCheck,
                                     java.util.function.Function<WidgetDefinition,T> getter,
                                     java.util.function.Consumer<T> setter)

checkIfEmpty

protected boolean checkIfEmpty(WidgetDefinition target,
                               java.util.function.Function<WidgetDefinition,?> override)

getFactoryForInfo

protected java.util.Optional<CockpitComponentDefinitionFactory> getFactoryForInfo(CockpitComponentInfo info)

getClassLoader

@Deprecated(since="1808",
            forRemoval=true)
public java.lang.ClassLoader getClassLoader(AbstractCockpitComponentDefinition definition)

Deprecated, for removal: This API element is subject to removal in a future version.

since 1808, please use CockpitApplicationContext.getClassLoader()

Specified by:

getClassLoader in interface CockpitComponentDefinitionService

See Also:

CockpitApplicationContext.getCockpitApplicationContext(ApplicationContext)

getDefinitionLoaders

public java.util.List<CockpitComponentLoader> getDefinitionLoaders()

Returns:

the definitionLoaders

setDefinitionLoaders

public void setDefinitionLoaders(java.util.List<CockpitComponentLoader> definitionLoaders)

getApplicationContext

public org.springframework.context.ApplicationContext getApplicationContext(AbstractCockpitComponentDefinition definition)

Specified by:

getApplicationContext in interface CockpitComponentDefinitionService

See Also:

CockpitApplicationContext.getCockpitApplicationContext(ApplicationContext)

getApplicationContext

protected CockpitApplicationContext getApplicationContext()

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext ctx)

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

getCockpitProperties

public CockpitProperties getCockpitProperties()

setCockpitProperties

public void setCockpitProperties(CockpitProperties cockpitProperties)

setToResetAfterReload

public void setToResetAfterReload(java.util.List<Resettable> toResetAfterReload)