de.hybris.platform.jalo.extension

Class Extension

java.lang.Object

de.hybris.platform.jalo.Manager

de.hybris.platform.jalo.extension.Extension

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AbstractPriceFactory, DeliveryModeManager, GeneratedAcceleratorcmshmcManager, GeneratedAcceleratorCmsManager, GeneratedAcceleratorserviceshmcManager, GeneratedAcceleratorServicesManager, GeneratedAcceleratorstorefrontcommonsManager, GeneratedAcceleratorwebservicesaddonManager, GeneratedAccountsummaryaddonManager, GeneratedAdmincockpitManager, GeneratedAlipaymentbackofficeManager, GeneratedAmazoncloudManager, GeneratedApparelstoreManager, GeneratedASQManager, GeneratedAssistedservicecustomerinterestsaddonManager, GeneratedAssistedservicecustomerinterestsfacadesManager, GeneratedAssistedservicefacadesManager, GeneratedAssistedserviceservicesManager, GeneratedAssistedservicestorefrontManager, GeneratedAssistedserviceyprofileaddonManager, GeneratedAssistedserviceyprofilefacadesManager, GeneratedAzurecloudManager, GeneratedB2bacceleratoraddonManager, GeneratedB2bacceleratorserviceshmcManager, GeneratedB2BAcceleratorServicesManager, GeneratedB2bAdminCockpitManager, GeneratedB2bapprovalprocessfacadesManager, GeneratedB2bapprovalprocesshmcManager, GeneratedB2BApprovalprocessManager, GeneratedB2bbtgaddonManager, GeneratedB2bcommercebackofficeManager, GeneratedB2bcommercefacadesManager, GeneratedB2bcommercehmcManager, GeneratedB2BCommerceManager, GeneratedB2boccaddonManager, GeneratedB2bpunchoutaddonManager, GeneratedB2bpunchoutManager, GeneratedB2bsappricingManager, GeneratedB2bsapproductavailabilityManager, GeneratedB2cbtgaddonManager, GeneratedB2ctelcocheckoutaddonManager, GeneratedB2ctelcocockpitsManager, GeneratedB2ctelcofacadesManager, GeneratedB2ctelcoservicesManager, GeneratedB2ctelcostorefrontManager, GeneratedB2ctelcostoreManager, GeneratedBackofficeManager, GeneratedBasecommercebackofficeManager, GeneratedBasecommercehmcManager, GeneratedBasecommerceManager, GeneratedBmecathmcManager, GeneratedBMECatManager, GeneratedBtgcockpitManager, GeneratedBtghmcManager, GeneratedBtgManager, GeneratedC4ccustomerManager, GeneratedCaptchaaddonManager, GeneratedCatalogManager, GeneratedChinaacceleratorbackofficeManager, GeneratedChineseaddressaddonManager, GeneratedChineseaddressbackofficeManager, GeneratedChineseaddressfacadesManager, GeneratedChineseaddressservicesManager, GeneratedChinesecommerceorgaddressaddonManager, GeneratedChineselogisticaddonManager, GeneratedChineselogisticbackofficeManager, GeneratedChineselogisticfacadesManager, GeneratedChineselogisticservicesManager, GeneratedChinesepaymentaddonManager, GeneratedChinesepaymentfacadesManager, GeneratedChinesepaymentservicesManager, GeneratedChineseproductsharingaddonManager, GeneratedChineseprofileaddonManager, GeneratedChineseprofilefacadesManager, GeneratedChineseprofileservicesManager, GeneratedChinesepspalipaymockaddonManager, GeneratedChinesepspalipaysbackofficeManager, GeneratedChinesepspalipayservicesManager, GeneratedChinesepspwechatpaymentaddonManager, GeneratedChinesepspwechatpaysbackofficeManager, GeneratedChinesepspwechatpayservicesManager, GeneratedChinesestoreaddonManager, GeneratedChinesetaxinvoiceaddonManager, GeneratedChinesetaxinvoicebackofficeManager, GeneratedChinesetaxinvoicefacadesManager, GeneratedChinesetaxinvoiceservicesManager, GeneratedCisclienttestManager, GeneratedCispaymenthmcManager, GeneratedCispaymentManager, GeneratedCissampledataManager, GeneratedCissubscriptionManager, GeneratedCistaxhmcManager, GeneratedClassificationsystemsManager, GeneratedCms2hmcManager, GeneratedCms2LibManager, GeneratedCms2Manager, GeneratedCmscockpitManager, GeneratedCmsfacadesManager, GeneratedCmsSmarteditManager, GeneratedCmssmarteditwebservicesManager, GeneratedCmswebservicesManager, GeneratedCockpitManager, GeneratedCommentsManager, GeneratedCommerceorgaddonManager, GeneratedCommerceorgsamplesaddonManager, GeneratedCommercesearchbackofficeManager, GeneratedCommercesearchhmcManager, GeneratedCommercesearchManager, GeneratedCommercesearchsamplesaddonManager, GeneratedCommerceservicesbackofficeManager, GeneratedCommerceserviceshmcManager, GeneratedCommerceServicesManager, GeneratedCommercewebservicescommonsManager, GeneratedCommonsManager, GeneratedConfigurablebundlefacadesManager, GeneratedConfigurableBundleServicesManager, GeneratedConsignmenttrackingaddonManager, GeneratedConsignmenttrackingbackofficeManager, GeneratedConsignmenttrackingfacadesManager, GeneratedConsignmenttrackingmockaddonManager, GeneratedConsignmenttrackingservicesManager, GeneratedCorepluscommonsManager, GeneratedCronJobManager, GeneratedCscockpitManager, GeneratedCustomerinterestsaddonManager, GeneratedCustomerinterestsfacadesManager, GeneratedCustomerinterestsservicesManager, GeneratedCustomerreviewhmcManager, GeneratedCustomerReviewManager, GeneratedCustomersupportbackofficeManager, GeneratedCustomerticketingaddonManager, GeneratedCustomerticketingc4cb2bintegrationManager, GeneratedCustomerticketingc4cintegrationManager, GeneratedCustomerticketingfacadesManager, GeneratedDatahubbackofficeManager, GeneratedDeltadetectionManager, GeneratedDynamicwebservicesManager, GeneratedElectronicsstoreManager, GeneratedEmbeddedserverManager, GeneratedEmsclientManager, GeneratedEmsuiManager, GeneratedEntitlementfacadesManager, GeneratedEntitlementservicesManager, GeneratedEntitlementstorefrontManager, GeneratedEventtrackingmodelManager, GeneratedEventtrackingpublisherManager, GeneratedEventtrackingservicesManager, GeneratedEventtrackingwsaddonManager, GeneratedFinancialacceleratorstorefrontManager, GeneratedFinancialcheckoutManager, GeneratedFinancialcockpitsManager, GeneratedFinancialfacadesManager, GeneratedFinancialservicesManager, GeneratedFinancialStoreManager, GeneratedFractussyncaddonManager, GeneratedFractussyncconfigurationtriggerManager, GeneratedFractussyncservicesManager, GeneratedGeneratedSmarteditwebservicesManager, GeneratedGridfsstorageManager, GeneratedGroovynatureManager, GeneratedHacManager, GeneratedHMCManager, GeneratedHybrisanalyticsaddonManager, GeneratedHybrisDataSupplierHMCManager, GeneratedHybrisDataSupplierManager, GeneratedHybrisrootcauseanalysisManager, GeneratedHybristransportandchangeManager, GeneratedImpExManager, GeneratedImportcockpithmcManager, GeneratedImportCockpitManager, GeneratedInstoreManager, GeneratedLDAPManager, GeneratedLiveeditaddonManager, GeneratedLucenesearchbackofficeManager, GeneratedLucenesearchManager, GeneratedMccManager, GeneratedMediaconversionbackofficeManager, GeneratedMediaConversionManager, GeneratedMediawebManager, GeneratedMobileManager, GeneratedMobileoptionalshmcManager, GeneratedMobileoptionalsManager, GeneratedMobileserviceshmcManager, GeneratedNotificationaddonManager, GeneratedNotificationfacadesManager, GeneratedNotificationservicesManager, GeneratedNpmancillaryManager, GeneratedNpmtestancillaryManager, GeneratedOAuth2Manager, GeneratedOciManager, GeneratedOndemandcommonhmcManager, GeneratedOndemandsampledataManager, GeneratedOrdercalculationManager, GeneratedOrdermanagementaddonManager, GeneratedOrdermanagementfacadeManager, GeneratedOrdermanagementwebservicesManager, GeneratedOrderselfserviceaddonManager, GeneratedPaymentManager, GeneratedPermissionswebservicesManager, GeneratedPersonalizationcmsbackofficeManager, GeneratedPersonalizationcmsManager, GeneratedPersonalizationcmswebManager, GeneratedPersonalizationfacadesManager, GeneratedPersonalizationintegrationManager, GeneratedPersonalizationpromotionsbackofficeManager, GeneratedPersonalizationpromotionsManager, GeneratedPersonalizationpromotionswebManager, GeneratedPersonalizationsampledataaddonManager, GeneratedPersonalizationservicesbackofficeManager, GeneratedPersonalizationservicesManager, GeneratedPersonalizationsmarteditManager, GeneratedPersonalizationwebservicesManager, GeneratedPersonalizationyprofileManager, GeneratedPlatformbackofficeManager, GeneratedPlatformhmcManager, GeneratedPowertoolsStoreManager, GeneratedPreviewpersonalizationwebManager, GeneratedPreviewwebservicesManager, GeneratedPrintcockpithmcManager, GeneratedPrintCockpitManager, GeneratedPrinthmcManager, GeneratedPrintManager, GeneratedPrintsampledataManager, GeneratedPrivacyoverlayeraddonManager, GeneratedPromotionEngineSamplesAddonManager, GeneratedPromotionsbackofficeManager, GeneratedPromotionshmcManager, GeneratedPromotionsManager, GeneratedRecentViewedItemsAddonManager, GeneratedRecentViewedItemsServicesManager, GeneratedReportcockpitManager, GeneratedSamlsinglesignonManager, GeneratedSapadtrecob2bManager, GeneratedSapadtrecohmcManager, GeneratedSAPADTRecoManager, GeneratedSapcarcommercefacadesManager, GeneratedSapcarintegrationaddonManager, GeneratedSapcarintegrationhmcManager, GeneratedSapcarintegrationManager, GeneratedSapcommonbolManager, GeneratedSapcoreaddonManager, GeneratedSapcorebolManager, GeneratedSapcoreconfigurationbackofficeManager, GeneratedSapcoreconfigurationhmcManager, GeneratedSapcoreconfigurationManager, GeneratedSapcorejcoManager, GeneratedSapcorejcorecManager, GeneratedSapcoreManager, GeneratedSapcoreodataManager, GeneratedSapcoretestManager, GeneratedSapcreditcheckbackofficeManager, GeneratedSapcreditcheckhmcManager, GeneratedSapcreditcheckManager, GeneratedSapcustomerb2bbackofficeManager, GeneratedSapcustomerb2bManager, GeneratedSapcustomerb2cManager, GeneratedSapinvoiceaddonManager, GeneratedSapinvoicebolManager, GeneratedSapinvoicefacadesManager, GeneratedSapinvoiceservicesManager, GeneratedSapmodelbackofficeManager, GeneratedSapmodelhmcManager, GeneratedSapmodelManager, GeneratedSaporderexchangeb2bManager, GeneratedSaporderexchangebackofficeManager, GeneratedSaporderexchangehmcManager, GeneratedSaporderexchangeManager, GeneratedSaporderexchangeomsb2bManager, GeneratedSaporderexchangeomsManager, GeneratedSapordermgmtb2bfacadesManager, GeneratedSapordermgmtb2bservicesManager, GeneratedSapordermgmtbackofficeManager, GeneratedSapordermgmtbolManager, GeneratedSapordermgmtcfgfacadesManager, GeneratedSapordermgmthmcManager, GeneratedSapordermgmtservicesManager, GeneratedSappostransactionaddonManager, GeneratedSappricingbackofficeManager, GeneratedSappricingbolManager, GeneratedSappricinghmcManager, GeneratedSappricingManager, GeneratedSappricingproductcarouseladdonManager, GeneratedSapprodrecoaddonManager, GeneratedSapprodrecobufferManager, GeneratedSapprodrecocommonManager, GeneratedSapprodrecohmcManager, GeneratedSapproductavailabilitybackofficeManager, GeneratedSapproductavailabilityhmcManager, GeneratedSapproductavailabilityManager, GeneratedSapproductconfigb2bManager, GeneratedSapproductconfigb2bservicesManager, GeneratedSapproductconfigbackofficeManager, GeneratedSapproductconfigfacadesManager, GeneratedSapproductconfighmcManager, GeneratedSapproductconfigmodelManager, GeneratedSapproductconfigrulesbackofficeManager, GeneratedSapproductconfigrulesManager, GeneratedSapproductconfigruntimeinterfaceManager, GeneratedSapproductconfigruntimesscManager, GeneratedSapproductconfigservicesManager, GeneratedSapproducthmcManager, GeneratedSapproductrecommendationManager, GeneratedSapymktsyncManager, GeneratedSavedorderformsManager, GeneratedSavedorderformsoccaddonManager, GeneratedScalanatureManager, GeneratedScriptingManager, GeneratedSecureportaladdonManager, GeneratedServicelayerManager, GeneratedSmarteditaddonManager, GeneratedSmarteditManager, GeneratedSolrfacetsearchbackofficeManager, GeneratedSolrfacetsearchhmcManager, GeneratedSolrfacetsearchManager, GeneratedSolrserverManager, GeneratedStandardPaymentModeManager, GeneratedStocknotificationaddonManager, GeneratedStocknotificationfacadesManager, GeneratedStocknotificationservicesManager, GeneratedSubscriptionbackofficeManager, GeneratedSubscriptionserviceshmcManager, GeneratedSubscriptionservicesManager, GeneratedSubscriptionstorefrontManager, GeneratedTextfieldconfiguratortemplateaddonManager, GeneratedTextfieldconfiguratortemplatebackofficeManager, GeneratedTextfieldconfiguratortemplatefacadesManager, GeneratedTextfieldconfiguratortemplateservicesManager, GeneratedTicketsystembackofficeManager, GeneratedTicketsystemhmcManager, GeneratedTicketsystemManager, GeneratedTimedaccesspromotionsbackofficeManager, GeneratedTimedaccesspromotionsfacadesManager, GeneratedTimedaccesspromotionsserviceshmcManager, GeneratedTimedaccesspromotionsservicesManager, GeneratedTimedaccesspromotionsstorefrontManager, GeneratedTomcatembeddedserverManager, GeneratedValidationManager, GeneratedVerticalnavigationaddonManager, GeneratedVjdbcManager, GeneratedVoucherbackofficeManager, GeneratedVoucherhmcManager, GeneratedVoucherManager, GeneratedWarehousingfacadeManager, GeneratedWarehousingManager, GeneratedWarehousingwebservicesManager, GeneratedWebservicescommonsManager, GeneratedWishlist2Manager, GeneratedWorkflowManager, GeneratedXyformsbackofficeManager, GeneratedXyformscockpitsManager, GeneratedXyformsfacadesManager, GeneratedXyformssamplesManager, GeneratedXyformsservicesManager, GeneratedXyformsstorefrontcommonsManager, GeneratedXyformswebManager, GeneratedY2ysyncbackofficeManager, GeneratedY2ysyncdemoelectronicsManager, GeneratedY2ysyncManager, GeneratedYaasconfigurationbackofficeManager, GeneratedYaasconfigurationManager, GeneratedYaasConnectManager, GeneratedYaasyprofileconnectManager, GeneratedYAcceleratorCoreManager, GeneratedYAcceleratorFractusFulfilmentProcessManager, GeneratedYAcceleratorOrderManagementManager, GeneratedYAddonManager, GeneratedYBackofficeManager, GeneratedYCmsSmartEditManager, GeneratedYcockpitManager, GeneratedYcommercewebserviceshmcManager, GeneratedYcommercewebservicestestManager, GeneratedYEmptyManager, GeneratedYGroovyManager, GeneratedYhacextManager, GeneratedYOccAddonManager, GeneratedYprofilecommonsManager, GeneratedYprofileeventadapterManager, GeneratedYprofileeventtrackingwsManager, GeneratedYprofileprocessadapterManager, GeneratedYsapomsfulfillmentManager, GeneratedYsaporderfulfillmentManager, GeneratedYsapordermgmtb2baddonManager, GeneratedYsapproductconfigaddonManager, GeneratedYScalaManager, GeneratedYSmarteditModuleManager, GeneratedYWebServicesManager, GeneratedZoneDeliveryModeManager, GenericManager, PaymentModeManager

public abstract class Extension
extends Manager

The base class for all extensions.

Generally each hybris extension has to be a subclass of this one and must provide a proper ExtensionInfo object.

There might be extensions which are not visible on jalo layer, so they don't need such an object.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Extension.RestrictedLanguagesProvider Implement this interface at your Manager class to restrict the access for an item for specific languages.
static interface	Extension.RightsProvider Implement this interface at your Manager class to restrict the modifying access to a specific attribute for a specific item.

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

Manager.GenericManagerSingletonCreator, Manager.ManagerSingletonCreator

Constructor Summary

Constructors

Constructor and Description
Extension()

Method Summary

Modifier and Type	Method and Description
protected void	checkBeforeItemRemoval(SessionContext ctx, Item item) TODO improve API doc Override this method to implement pre-removal consistency checks.
void	createEssentialData(Map<String,String> params, JspContext jspc)
void	createProjectData(Map<String,String> params, JspContext jspc)
void	createSampleData(Map<String,String> params, JspContext jspc)
String	getCreatorDescription() Part of DataCreator interface.
String	getCreatorName() The name of the creator will be shown to the user during data creation.
String	getCreatorParameterDefault(String param) Override this method to provide default value for the given creator parameter.
Collection<String>	getCreatorParameterNames() Override this method to provide parameters for the system creator.
List<String>	getCreatorParameterPossibleValues(String param) Override this method to provide a list of all possible values for the given creator parameter.
Map<String,Item.AttributeMode>	getDefaultAttributeModes(Class<? extends Item> itemClass)
abstract String	getName()
ExtensionEJB	getRemote()
boolean	isCreatorDisabled() Part of DataCreator interface.
void	notifyInitializationEnd(Map<String,String> params, JspContext ctx)
void	notifyInitializationStart(Map<String,String> params, JspContext ctx)
protected void	notifyItemRemoval(SessionContext ctx, Item item) TODO improve API doc Is called just before a item is being removed.
void	onFirstSessionCreation() Is called on first session creation (while startup) exactly one time.
Object	writeReplace()

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

afterItemCreation, beforeItemCreation, destroy, getAllValuesSessionContext, getAttribute, getAttributeMap, getFirstItemByAttribute, getFirstItemByAttribute, getRemoteManagerClass, getSession, getSingletonManagerInstance, getTenant, getTransientObject, getTransientObjectMap, init, setAttribute, setTenant, setTransientObject, unwrap, unwrap, wrap

Methods inherited from class java.lang.Object

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

Constructor Detail

Extension

public Extension()

Method Detail

onFirstSessionCreation

public void onFirstSessionCreation()

Is called on first session creation (while startup) exactly one time. Put here code which has to be called within startup process.

checkBeforeItemRemoval

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

Description copied from class: Manager

TODO improve API doc Override this method to implement pre-removal consistency checks. This method is called upon each Manager and allows aborting removal by throwing a ConsistencyCheckException. If no manager did so each one is notified by calling Manager.notifyItemRemoval(SessionContext, Item).

This method does nothing and may be overridden.

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)

Description copied from class: Manager

TODO improve API doc Is called just before a item is being removed. No exception should be thrown here. Use Manager.checkBeforeItemRemoval(SessionContext, Item) instead.

This method does nothing and may be overridden.

Overrides:

notifyItemRemoval in class Manager

Parameters:

ctx - the currency session context

item - the item which is going to be removed

Since:

2.10

createEssentialData

public void createEssentialData(Map<String,String> params,
                                JspContext jspc)
                         throws Exception

Throws:

Exception

createProjectData

public void createProjectData(Map<String,String> params,
                              JspContext jspc)
                       throws Exception

Throws:

Exception

createSampleData

public final void createSampleData(Map<String,String> params,
                                   JspContext jspc)
                            throws Exception

Throws:

Exception

notifyInitializationEnd

public void notifyInitializationEnd(Map<String,String> params,
                                    JspContext ctx)
                             throws Exception

Throws:

Exception

notifyInitializationStart

public void notifyInitializationStart(Map<String,String> params,
                                      JspContext ctx)
                               throws Exception

Throws:

Exception

Since:

3.1-u6

getCreatorParameterNames

public Collection<String> getCreatorParameterNames()

Override this method to provide parameters for the system creator.

Returns:

parameter names for the creator

getCreatorParameterDefault

public String getCreatorParameterDefault(String param)

Override this method to provide default value for the given creator parameter.

Parameters:

param - the name of the parameter

Returns:

default value for the given creator parameter; use null when the parameter should have no default value

getCreatorParameterPossibleValues

public List<String> getCreatorParameterPossibleValues(String param)

Override this method to provide a list of all possible values for the given creator parameter. If not null the list of these values will be shown to the user of system creator and no other values will be possible to set.

Parameters:

param - the name of the parameter

Returns:

list of all possible values for the given creator parameter; use null when this parameter should have no restriction of possible values

getCreatorName

public String getCreatorName()

The name of the creator will be shown to the user during data creation. Returns name of the extension.

Returns:

name of the creator; in the default case it is the extension name

getCreatorDescription

public String getCreatorDescription()

Part of DataCreator interface. The description of the creator will be shown to the user during data creation.

Returns:

description of this creator

isCreatorDisabled

public boolean isCreatorDisabled()

Part of DataCreator interface. This default implementation returns false

Returns:

false

getName

public abstract String getName()

getRemote

public ExtensionEJB getRemote()

Overrides:

getRemote in class Manager

getDefaultAttributeModes

public Map<String,Item.AttributeMode> getDefaultAttributeModes(Class<? extends Item> itemClass)

writeReplace

public Object writeReplace()
                    throws ObjectStreamException

Specified by:

writeReplace in class Manager

Throws:

ObjectStreamException