com.hybris.cockpitng.modules.impl

Class CockpitRemoteLibraryHandler

java.lang.Object

com.hybris.cockpitng.modules.impl.CockpitRemoteLibraryHandler

All Implemented Interfaces:

LibraryFetcher, LibraryHandler<Object>

public class CockpitRemoteLibraryHandler
extends Object
implements LibraryHandler<Object>, LibraryFetcher

LibraryHandler capable of downloading cockpit modules as jarfiles from an url.

Constructor Summary

Constructors

Constructor and Description
CockpitRemoteLibraryHandler()

Method Summary

Modifier and Type	Method and Description
void	afterDeploy(CockpitModuleInfo moduleInfo, String libdir) Called after all cockpit modules have been deployed, in module order, i.e.
void	afterDeployReverseOrder(CockpitModuleInfo moduleInfo, String libDir) Called after all cockpit modules have been deployed and after LibraryHandler.afterDeploy(CockpitModuleInfo, String) of all modules, in reverse module order, i.e.
boolean	canFetchLibrary(ModuleInfo moduleInfo) Checks if specified module can be fetched by this fetcher.
void	fetchLibrary(CockpitModuleInfo moduleInfo, File archiveFile)
void	fetchLibrary(ModuleInfo moduleInfo, File file) Fetches provided module into specified archive.
void	initialize(ModuleInfo moduleInfo, Object o) Initializes a module with provided info object.
Object	prepare(ModuleInfo moduleInfo) Prepares an info object for specified module.

Methods inherited from class java.lang.Object

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

Constructor Detail

CockpitRemoteLibraryHandler

public CockpitRemoteLibraryHandler()

Method Detail

canFetchLibrary

public boolean canFetchLibrary(ModuleInfo moduleInfo)

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

Specified by:

canFetchLibrary in interface LibraryHandler<Object>

Parameters:

moduleInfo - module to be fetched

Returns:

true if module is not yet fetched and requires fetching

fetchLibrary

public void fetchLibrary(ModuleInfo moduleInfo,
                         File file)
                  throws CockpitModuleDeploymentException

Description copied from interface: LibraryFetcher

Fetches provided module into specified archive.

Specified by:

fetchLibrary in interface LibraryFetcher

Parameters:

moduleInfo - module information

file - destination file

Throws:

CockpitModuleDeploymentException

fetchLibrary

public void fetchLibrary(CockpitModuleInfo moduleInfo,
                         File archiveFile)
                  throws CockpitModuleDeploymentException

Specified by:

fetchLibrary in interface LibraryHandler<Object>

Throws:

CockpitModuleDeploymentException

afterDeploy

public void afterDeploy(CockpitModuleInfo moduleInfo,
                        String libdir)

Description copied from interface: LibraryHandler

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

Specified by:

afterDeploy in interface LibraryHandler<Object>

afterDeployReverseOrder

public void afterDeployReverseOrder(CockpitModuleInfo moduleInfo,
                                    String libDir)

Description copied from interface: LibraryHandler

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

Specified by:

afterDeployReverseOrder in interface LibraryHandler<Object>

prepare

public Object prepare(ModuleInfo moduleInfo)

Description copied from interface: LibraryHandler

Prepares an info object for specified module.

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

Specified by:

prepare in interface LibraryHandler<Object>

Parameters:

moduleInfo - information about loaded module

See Also:

LibraryHandler.initialize(ModuleInfo, Object)

initialize

public void initialize(ModuleInfo moduleInfo,
                       Object o)

Description copied from interface: LibraryHandler

Initializes a module with provided info object.

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

Specified by:

initialize in interface LibraryHandler<Object>

Parameters:

moduleInfo - information about loaded module

o - info object prepared in LibraryHandler.prepare(ModuleInfo) method