Package de.hybris.platform.jalo.extension

Class ExtensionManager

java.lang.Object

de.hybris.platform.jalo.Manager

de.hybris.platform.jalo.extension.ExtensionManager

All Implemented Interfaces:

ItemLifecycleListener, java.io.Serializable

public class ExtensionManager
extends Manager

The manager for handling hybris Platform extensions.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	ExtensionManager.ExtensionManagerSerializableDTO

Nested classes/interfaces inherited from class de.hybris.platform.jalo.Manager

Manager.GenericManagerSingletonCreator, Manager.ManagerSingletonCreator

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	BEAN_NAME

Constructor Summary

Constructors

Constructor	Description
ExtensionManager()

Method Summary

Modifier and Type	Method	Description
protected void	checkBeforeItemRemoval(SessionContext ctx, Item item)	Delegates call to Manager.checkBeforeItemRemoval(SessionContext, Item) to all extensions .
Extension	getExtension(java.lang.String extName)	Finds an extension by its name.
java.util.Collection	getExtensionNames()	The list of all installed extensions Note This method will not check, if the extensions are properly installed, thus using getExtension(String) with on of the returned Extension names can throw an Exception.
java.util.List<? extends Extension>	getExtensions()	Return all extensions.
static ExtensionManager	getInstance()	returns an instance of the ExtensionManager
java.lang.Class	getRemoteManagerClass()
boolean	isExtensionInstalled(java.lang.String name)	Checks whether a given extension is installed in the system.
protected java.util.List<? extends Extension>	loadAllExtensions()
protected void	notifyItemRemoval(SessionContext ctx, Item item)	Delegates call to Manager.notifyItemRemoval(SessionContext, Item) to all extensions.
void	notifyOnFirstSessionCreation()	Calls for each extension the Extension.onFirstSessionCreation() once at startup.
java.lang.Object	writeReplace()

Methods inherited from class de.hybris.platform.jalo.Manager

afterItemCreation, beforeItemCreation, destroy, extractNonRequiredRemoteFromItem, extractRequiredRemoteFromItem, getAllValuesSessionContext, getAttribute, getAttributeMap, getFirstItemByAttribute, getFirstItemByAttribute, getRemote, getSession, getSingletonManagerInstance, getTenant, getTransientObject, getTransientObjectMap, init, setAttribute, setTenant, setTransientObject, wrap

Methods inherited from class java.lang.Object

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

Field Detail

BEAN_NAME

public static final java.lang.String BEAN_NAME

See Also:

Constant Field Values

Constructor Detail

ExtensionManager

public ExtensionManager()

Method Detail

getRemoteManagerClass

public java.lang.Class getRemoteManagerClass()

Overrides:

getRemoteManagerClass in class Manager

getInstance

public static ExtensionManager getInstance()

returns an instance of the ExtensionManager

Returns:

instance of this manager

checkBeforeItemRemoval

protected void checkBeforeItemRemoval(SessionContext ctx,
                                      Item item)
                               throws ConsistencyCheckException

Delegates call to Manager.checkBeforeItemRemoval(SessionContext, Item) to all extensions .

Overrides:

checkBeforeItemRemoval in class Manager

Parameters:

ctx - the current session context

item - the item which should be removed

Throws:

ConsistencyCheckException - thrown to abort removal due to consistency errors

Since:

2.10

notifyItemRemoval

protected void notifyItemRemoval(SessionContext ctx,
                                 Item item)

Delegates call to Manager.notifyItemRemoval(SessionContext, Item) to all extensions.

Overrides:

notifyItemRemoval in class Manager

Parameters:

ctx - the currency session context

item - the item which is going to be removed

Since:

2.10

getExtension

public Extension getExtension(java.lang.String extName)
                       throws ExtensionNotFoundException

Finds an extension by its name.
Sample:

   Search search = (Search)ExtensionManager.getInstance().getExtension("search");
   SearchResult res = search.searchProducts( ... );
 

Parameters:

extName - the name of the extension, must not be null

Returns:

The Extension object. null is never returned by this method.

Throws:

ExtensionNotFoundException - if the extension cannot be found.

getExtensionNames

public java.util.Collection getExtensionNames()

The list of all installed extensions
Note This method will not check, if the extensions are properly installed, thus using getExtension(String) with on of the returned Extension names can throw an Exception.

Returns:

a Collection of Strings with all extensionnames.

getExtensions

public java.util.List<? extends Extension> getExtensions()

Return all extensions.

If one or more extensions which are configured but not properly installed (e.g. missing jar file), this method will not throw an exception. it simply removes the extension from the result.
You can be sure that you can use all extensions you get from this method.

Returns:

a Collection of Extension objects.

loadAllExtensions

protected java.util.List<? extends Extension> loadAllExtensions()

isExtensionInstalled

public boolean isExtensionInstalled(java.lang.String name)

Checks whether a given extension is installed in the system.

Parameters:

name - - the name of the extension

Returns:

true, if the extension is installed, false otherwise

Since:

2.3

notifyOnFirstSessionCreation

public void notifyOnFirstSessionCreation()

Calls for each extension the Extension.onFirstSessionCreation() once at startup.

writeReplace

public java.lang.Object writeReplace()
                              throws java.io.ObjectStreamException

Specified by:

writeReplace in class Manager

Throws:

java.io.ObjectStreamException