Package com.hybris.cockpitng.modules

Interface LibraryHandler<INFO>

Type Parameters:

INFO - type of element that describes a module after preparation and allow its proper intialization

All Superinterfaces:

LibraryFetcher

All Known Implementing Classes:

CockpitRemoteLibraryHandler

public interface LibraryHandler<INFO>
extends LibraryFetcher

Used by AbstractCockpitModuleConnector to get the cockpit module libraries.

Method Summary

Modifier and Type	Method	Description
void	afterDeploy(CockpitModuleInfo moduleInfo, java.lang.String libDir)	Deprecated, for removal: This API element is subject to removal in a future version. since 1808, use LibraryFetcher.fetchLibrary(ModuleInfo, File) instead
void	afterDeployReverseOrder(CockpitModuleInfo moduleInfo, java.lang.String libDir)	Deprecated, for removal: This API element is subject to removal in a future version. since 1808, use LibraryFetcher.fetchLibrary(ModuleInfo, File) instead
default boolean	canFetchLibrary(ModuleInfo moduleInfo)	Deprecated, for removal: This API element is subject to removal in a future version. since 1808, use LibraryFetcher.canFetchLibrary(ModuleInfo) instead
void	fetchLibrary(CockpitModuleInfo moduleInfo, java.io.File archiveFile)	Deprecated, for removal: This API element is subject to removal in a future version. since 1808, use LibraryFetcher.fetchLibrary(ModuleInfo, File) instead
default void	initialize(ModuleInfo moduleInfo, INFO info)	Initializes a module with provided info object.
default INFO	prepare(ModuleInfo moduleInfo)	Prepares an info object for specified module.

Methods inherited from interface com.hybris.cockpitng.core.modules.LibraryFetcher

fetchLibrary

Method Detail

canFetchLibrary

@Deprecated(since="1808",
            forRemoval=true)
default boolean canFetchLibrary(ModuleInfo moduleInfo)

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

since 1808, use LibraryFetcher.canFetchLibrary(ModuleInfo) instead

Description copied from interface: LibraryFetcher

Checks if specified module can be fetched by this fetcher.

There are some modules that are i.e. injected directly into classpath and does not need any additional fetching. Such modules should still be handled by system, yet not fetched (as they are in fact already fetched). For such situations fetcher should return false.

Specified by:

canFetchLibrary in interface LibraryFetcher

Parameters:

moduleInfo - module to be fetched

Returns:

true if module is not yet fetched and requires fetching

fetchLibrary

@Deprecated(since="1808",
            forRemoval=true)
void fetchLibrary(CockpitModuleInfo moduleInfo,
                  java.io.File archiveFile)
           throws CockpitModuleDeploymentException

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

since 1808, use LibraryFetcher.fetchLibrary(ModuleInfo, File) instead

Throws:

CockpitModuleDeploymentException

afterDeploy

@Deprecated(since="1808",
            forRemoval=true)
void afterDeploy(CockpitModuleInfo moduleInfo,
                 java.lang.String libDir)

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

since 1808, use LibraryFetcher.fetchLibrary(ModuleInfo, File) instead

Called after all cockpit modules have been deployed, in module order, i.e. first module first.

afterDeployReverseOrder

@Deprecated(since="1808",
            forRemoval=true)
void afterDeployReverseOrder(CockpitModuleInfo moduleInfo,
                             java.lang.String libDir)

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

since 1808, use LibraryFetcher.fetchLibrary(ModuleInfo, File) instead

Called after all cockpit modules have been deployed and after afterDeploy(CockpitModuleInfo, String) of all modules, in reverse module order, i.e. last module first.

prepare

default INFO prepare(ModuleInfo moduleInfo)

Prepares an info object for specified module.

Method is called for each module loaded in order of modules loading.

Parameters:

moduleInfo - information about loaded module

See Also:

initialize(ModuleInfo, Object)

initialize

default void initialize(ModuleInfo moduleInfo,
                        INFO info)

Initializes a module with provided info object.

Method is called for each module loaded in reversed order of modules loading.

Parameters:

moduleInfo - information about loaded module

info - info object prepared in prepare(ModuleInfo) method