Package de.hybris.platform.jalo.extension

Class Extension

java.lang.Object
de.hybris.platform.jalo.Manager
de.hybris.platform.jalo.extension.Extension
All Implemented Interfaces:
ItemLifecycleListener, Serializable
Direct Known Subclasses:
AbstractPriceFactory, AdminapiManager, B2bpunchoutoccManager, B2bpunchoutocctestsManager, B2bwebservicescommonsManager, ChinesecommercewebservicescommonsManager, ChinesepaymentmockManager, CustomerticketingoccManager, CustomerticketingocctestsManager, DeliveryModeManager, GeneratedAcceleratorbackofficeManager, GeneratedAcceleratorCmsManager, GeneratedAcceleratoroccManager, GeneratedAcceleratorServicesManager, GeneratedAcceleratorstorefrontcommonsManager, GeneratedAcceleratorwebservicesaddonManager, GeneratedAccountsummaryaddonManager, GeneratedAdmincockpitManager, GeneratedAmazoncloudManager, GeneratedApiregistryservicesManager, GeneratedApparelstoreManager, GeneratedASQManager, GeneratedAssistedservicecustomerinterestsaddonManager, GeneratedAssistedservicecustomerinterestsfacadesManager, GeneratedAssistedservicefacadesManager, GeneratedAssistedservicepromotionaddonManager, GeneratedAssistedservicepromotionfacadesManager, GeneratedAssistedserviceservicesManager, GeneratedAssistedservicestorefrontManager, GeneratedAssistedservicewebservicesManager, GeneratedAssistedserviceyprofileaddonManager, GeneratedAssistedserviceyprofilefacadesManager, GeneratedAuditreportservicesManager, GeneratedAzurecloudManager, GeneratedAzureDtuManager, GeneratedB2bacceleratoraddonManager, GeneratedB2BAcceleratorServicesManager, GeneratedB2bapprovalprocessfacadesManager, GeneratedB2BApprovalprocessManager, GeneratedB2bcommercebackofficeManager, GeneratedB2bcommercefacadesManager, GeneratedB2BCommerceManager, GeneratedB2boccaddonManager, GeneratedB2boccManager, GeneratedB2bocctestsManager, GeneratedB2bordermanagementfacadesManager, GeneratedB2bordermanagementwebservicesManager, GeneratedB2bpunchoutaddonManager, GeneratedB2bpunchoutbackofficeManager, GeneratedB2bpunchoutManager, GeneratedBackofficeManager, GeneratedBackofficesearchservicesManager, GeneratedBackofficesolrsearchManager, GeneratedBasecommercebackofficeManager, GeneratedBasecommerceManager, GeneratedCaptchaaddonManager, GeneratedCatalogManager, GeneratedChineseaddressaddonManager, GeneratedChineseaddressbackofficeManager, GeneratedChineseaddressfacadesManager, GeneratedChineseaddressoccaddonManager, GeneratedChineseaddressoccManager, GeneratedChineseaddressservicesManager, GeneratedChinesecommerceorgaddressaddonManager, GeneratedChinesecommerceorgaddressfacadesManager, GeneratedChineselogisticaddonManager, GeneratedChineselogisticbackofficeManager, GeneratedChineselogisticfacadesManager, GeneratedChineselogisticoccaddonManager, GeneratedChineselogisticoccManager, GeneratedChineselogisticservicesManager, GeneratedChinesepaymentaddonManager, GeneratedChinesepaymentfacadesManager, GeneratedChinesepaymentoccaddonManager, GeneratedChinesepaymentoccManager, GeneratedChinesepaymentservicesManager, GeneratedChineseproductsharingaddonManager, GeneratedChineseprofileaddonManager, GeneratedChineseprofilefacadesManager, GeneratedChineseprofileoccaddonManager, GeneratedChineseprofileoccManager, GeneratedChineseprofileservicesManager, GeneratedChinesepspalipaysamplesaddonManager, GeneratedChinesepspalipaysbackofficeManager, GeneratedChinesepspalipayservicesManager, GeneratedChinesepspwechatpaymentaddonManager, GeneratedChinesepspwechatpaysamplesaddonManager, GeneratedChinesepspwechatpaysbackofficeManager, GeneratedChinesepspwechatpayservicesManager, GeneratedChinesestoreaddonManager, GeneratedChinesestoreservicesManager, GeneratedChinesetaxinvoiceaddonManager, GeneratedChinesetaxinvoicebackofficeManager, GeneratedChinesetaxinvoicefacadesManager, GeneratedChinesetaxinvoiceoccaddonManager, GeneratedChinesetaxinvoiceoccManager, GeneratedChinesetaxinvoiceservicesManager, GeneratedCissubscriptionManager, GeneratedClassificationgroupsservicesManager, GeneratedCms2LibManager, GeneratedCms2Manager, GeneratedCmsbackofficeManager, GeneratedCmscockpitManager, GeneratedCmsfacadesManager, GeneratedCmsoccaddonManager, GeneratedCmsoccManager, GeneratedCmsSmarteditManager, GeneratedCmssmarteditwebservicesManager, GeneratedCmswebservicesManager, GeneratedCockpitManager, GeneratedCommentsManager, GeneratedCommerceorgaddonManager, GeneratedCommerceorgsamplesaddonManager, GeneratedCommerceservicesbackofficeManager, GeneratedCommerceServicesManager, GeneratedCommercewebservicescommonsManager, GeneratedCommonsManager, GeneratedConfigurablebundleaddonManager, GeneratedConfigurablebundlefacadesManager, GeneratedConfigurableBundleServicesManager, GeneratedConsignmenttrackingaddonManager, GeneratedConsignmenttrackingbackofficeManager, GeneratedConsignmenttrackingfacadesManager, GeneratedConsignmenttrackingmockManager, GeneratedConsignmenttrackingoccaddonManager, GeneratedConsignmenttrackingoccManager, GeneratedConsignmenttrackingservicesManager, GeneratedCronJobManager, GeneratedCustomercouponaddonManager, GeneratedCustomercouponbackofficeManager, GeneratedCustomercouponfacadesManager, GeneratedCustomercouponoccaddonManager, GeneratedCustomercouponoccManager, GeneratedCustomercouponsamplesaddonManager, GeneratedCustomercouponservicesManager, GeneratedCustomerinterestsaddonManager, GeneratedCustomerinterestsfacadesManager, GeneratedCustomerinterestsoccaddonManager, GeneratedCustomerinterestsoccManager, GeneratedCustomerinterestsservicesManager, GeneratedCustomerReviewManager, GeneratedDeltadetectionManager, GeneratedElectronicsstoreManager, GeneratedEmbeddedserverManager, GeneratedEntitlementbackofficeManager, GeneratedEntitlementfacadesManager, GeneratedEntitlementservicesManager, GeneratedEventtrackingmodelManager, GeneratedEventtrackingpublisherManager, GeneratedEventtrackingservicesManager, GeneratedEventtrackingwsaddonManager, GeneratedGeneratedSmarteditwebservicesManager, GeneratedGridfsstorageManager, GeneratedGroovynatureManager, GeneratedHybrisanalyticsaddonManager, GeneratedHybrisdatasupplierbackofficeManager, GeneratedHybrisDataSupplierManager, GeneratedHybrisrootcauseanalysisManager, GeneratedHybristransportandchangeManager, GeneratedImpExManager, GeneratedIntegrationbackofficeManager, GeneratedIntegrationbackofficetestManager, GeneratedIntegrationmonitoringbackofficeManager, GeneratedKymaintegrationservicesManager, GeneratedLDAPManager, GeneratedMarketplacebackofficeManager, GeneratedMarketplacebackofficesamplesaddonManager, GeneratedMarketplacefacadesManager, GeneratedMarketplaceoccaddonManager, GeneratedMarketplaceoccManager, GeneratedMarketplacepromotionenginesamplesaddonManager, GeneratedMarketplaceservicesManager, GeneratedMarketplacestoreManager, GeneratedMediaconversionbackofficeManager, GeneratedMediaConversionManager, GeneratedMediawebManager, GeneratedMerchandisingaddonManager, GeneratedMerchandisingcmswebservicesManager, GeneratedMerchandisingservicesManager, GeneratedMerchandisingsmarteditManager, GeneratedMerchandisingstorefrontsampledataaddonManager, GeneratedMessagecentercsfacadesManager, GeneratedMessagecentercsoccaddonManager, GeneratedMessagecentercsoccManager, GeneratedMessagecentercsservicesManager, GeneratedMulticountrysampledataaddonManager, GeneratedNotificationaddonManager, GeneratedNotificationfacadesManager, GeneratedNotificationoccaddonManager, GeneratedNotificationoccManager, GeneratedNotificationservicesManager, GeneratedNpmancillaryManager, GeneratedOrbeonwebManager, GeneratedOrdermanagementaddonManager, GeneratedOrdermanagementfacadesManager, GeneratedOrdermanagementwebservicesManager, GeneratedOrderselfserviceaddonManager, GeneratedOutboundsyncbackofficeManager, GeneratedPatchesbackofficeManager, GeneratedPatchesDemoManager, GeneratedPatchesManager, GeneratedPaymentManager, GeneratedPcmbackofficeManager, GeneratedPcmbackofficesamplesaddonManager, GeneratedPermissionsfacadesManager, GeneratedPermissionswebservicesManager, GeneratedPersonalizationaddonManager, GeneratedPersonalizationcmsbackofficeManager, GeneratedPersonalizationcmsManager, GeneratedPersonalizationcmswebManager, GeneratedPersonalizationfacadesManager, GeneratedPersonalizationintegrationbackofficeManager, GeneratedPersonalizationintegrationManager, GeneratedPersonalizationpromotionsbackofficeManager, GeneratedPersonalizationpromotionsManager, GeneratedPersonalizationpromotionssampledataaddonManager, GeneratedPersonalizationpromotionssmarteditManager, GeneratedPersonalizationpromotionswebManager, GeneratedPersonalizationsampledataaddonManager, GeneratedPersonalizationservicesbackofficeManager, GeneratedPersonalizationservicesManager, GeneratedPersonalizationsmarteditManager, GeneratedPersonalizationwebservicesManager, GeneratedPersonalizationyprofileManager, GeneratedPersonalizationyprofilesampledataaddonManager, GeneratedPlatformbackofficeManager, GeneratedPowertoolsStoreManager, GeneratedPreviewpersonalizationwebManager, GeneratedPreviewwebservicesManager, GeneratedProfileservicesManager, GeneratedProfiletagaddonManager, GeneratedPromotionsbackofficeManager, GeneratedPromotionsManager, GeneratedRuleengineservicesManager, GeneratedSamlsinglesignonManager, GeneratedSamlssobackofficeManager, GeneratedSapproductconfigb2baddonManager, GeneratedSapproductconfigb2bservicesManager, GeneratedSapproductconfigfacadesManager, GeneratedSapproductconfigrulesbackofficeManager, GeneratedSapproductconfigrulesManager, GeneratedSapproductconfigruntimeinterfaceManager, GeneratedSapproductconfigruntimemockManager, GeneratedSapproductconfigservicesManager, GeneratedSapproductconfigtestdataoccManager, GeneratedSavedorderformsManager, GeneratedSavedorderformsoccaddonManager, GeneratedSavedorderformsoccManager, GeneratedScriptingManager, GeneratedSelectivecartaddonManager, GeneratedSelectivecartfacadesManager, GeneratedSelectivecartservicesManager, GeneratedSelectivecartsplitlistaddonManager, GeneratedServicelayerManager, GeneratedSmarteditaddonManager, GeneratedSmarteditManager, GeneratedSolrfacetsearchManager, GeneratedStandardPaymentModeManager, GeneratedStocknotificationaddonManager, GeneratedStocknotificationfacadesManager, GeneratedStocknotificationservicesManager, GeneratedSubscriptionbackofficeManager, GeneratedSubscriptionbundlebackofficeManager, GeneratedSubscriptionbundlecockpitsManager, GeneratedSubscriptionbundlefacadesManager, GeneratedSubscriptionbundleservicesManager, GeneratedSubscriptionservicesManager, GeneratedTextfieldconfiguratortemplateaddonManager, GeneratedTextfieldconfiguratortemplatebackofficeManager, GeneratedTextfieldconfiguratortemplateoccaddonManager, GeneratedTextfieldconfiguratortemplateocctestManager, GeneratedTicketsystembackofficeManager, GeneratedTicketsystemManager, GeneratedTimedaccesspromotionengineaddonManager, GeneratedTimedaccesspromotionenginebackofficeManager, GeneratedTimedaccesspromotionenginefacadesManager, GeneratedTimedaccesspromotionengineoccaddonManager, GeneratedTimedaccesspromotionengineoccManager, GeneratedTimedaccesspromotionenginesamplesaddonManager, GeneratedTimedaccesspromotionengineservicesManager, GeneratedTomcatembeddedserverManager, GeneratedValidationManager, GeneratedVerticalnavigationaddonManager, GeneratedVoucherbackofficeManager, GeneratedVoucherManager, GeneratedWarehousingfacadesManager, GeneratedWarehousingManager, GeneratedWarehousingwebservicesManager, GeneratedWebhookbackofficeManager, GeneratedWebservicescommonsManager, GeneratedWishlist2Manager, GeneratedWorkflowManager, GeneratedXyformsbackofficeManager, GeneratedXyformsfacadesManager, GeneratedXyformssamplesManager, GeneratedXyformsservicesManager, GeneratedXyformsstorefrontcommonsManager, GeneratedXyformswebManager, GeneratedY2ysyncbackofficeManager, GeneratedY2ysyncManager, GeneratedYaasyprofileconnectManager, GeneratedYacceleratorbackofficeManager, GeneratedYAcceleratorCoreManager, GeneratedYAcceleratorFulfilmentProcessManager, GeneratedYacceleratormarketplaceintegrationManager, GeneratedYAcceleratorOrderManagementManager, GeneratedYAddonManager, GeneratedYBackofficeManager, GeneratedYcommercewebservicestestManager, GeneratedYcommercewebservicestestsManager, GeneratedYOccAddonManager, GeneratedYsapproductconfigaddonManager, GeneratedYSmarteditModuleManager, GeneratedYWebServicesManager, GeneratedZoneDeliveryModeManager, GenericManager, HacManager, OAuth2Manager, OutboundsyncManager, PaymentModeManager, SapproductconfigoccManager, SmartedittoolsManager, TextfieldconfiguratortemplatefacadesManager, TextfieldconfiguratortemplateoccManager, TextfieldconfiguratortemplateocctestsManager, TextfieldconfiguratortemplateservicesManager, WebhookservicesManager, YDocumentCartManager, YEmptyManager, YHacExtManager, YOccManager, YOccTestsManager, YVoidManager
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:

  • Constructor Details

    • Extension

      public Extension()

  • Method Details

    • 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

    • checkBeforeInitialization

      public void checkBeforeInitialization(JspContext ctx, boolean forceInit) throws Exception
      Override this method to add custom checks that should be executed before system initialization or update. The check should throw exception in case the initialization/update should not be performed
      Throws:
      Exception

    • 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