| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
BreadcrumbServiceExtensionHandler.modifyBreadcrumbList(String url,
Map<String,String[]> queryParams,
ExtensionResultHolder<List<BreadcrumbDTO>> holder) |
| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
SystemPropertyServiceExtensionHandler.resolveProperty(String propertyName,
ExtensionResultHolder resultHolder)
Provides an opportunity for modules to resolve a system property.
|
ExtensionResultStatusType |
AbstractSystemPropertyServiceExtensionHandler.resolveProperty(String propertyName,
ExtensionResultHolder resultHolder) |
| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
AbstractEntityInformationServiceExtensionHandler.findAllCatalogs(ExtensionResultHolder<List<Catalog>> erh) |
ExtensionResultStatusType |
EntityInformationServiceExtensionHandler.findAllCatalogs(ExtensionResultHolder<List<Catalog>> erh)
Handler implementations will set the value of
ExtensionResultHolder to a list of all catalogs,
specifically when running in a Multi-Tenant Broadleaf implementation. |
ExtensionResultStatusType |
EntityInformationServiceExtensionManager.findAllCatalogs(ExtensionResultHolder<List<Catalog>> erh) |
ExtensionResultStatusType |
AbstractEntityInformationServiceExtensionHandler.getBaseProfileIdForSite(Site site,
ExtensionResultHolder<Long> erh) |
ExtensionResultStatusType |
EntityInformationServiceExtensionHandler.getBaseProfileIdForSite(Site site,
ExtensionResultHolder<Long> erh)
Handler implementations will populate the
ExtensionResultHolder with a valid
base profile id if one exists for the site |
ExtensionResultStatusType |
EntityInformationServiceExtensionManager.getBaseProfileIdForSite(Site site,
ExtensionResultHolder<Long> erh) |
ExtensionResultStatusType |
AbstractEntityInformationServiceExtensionHandler.getChildSiteIdsForProfile(Site profile,
ExtensionResultHolder<Set<Long>> erh) |
ExtensionResultStatusType |
EntityInformationServiceExtensionHandler.getChildSiteIdsForProfile(Site profile,
ExtensionResultHolder<Set<Long>> erh)
Handler implementations will populate the
ExtensionResultHolder with a valid
child site ids whose base profile is the given profile |
ExtensionResultStatusType |
EntityInformationServiceExtensionManager.getChildSiteIdsForProfile(Site profile,
ExtensionResultHolder<Set<Long>> erh) |
ExtensionResultStatusType |
AbstractEntityInformationServiceExtensionHandler.getDefaultCatalogIdForSite(Site site,
ExtensionResultHolder<Long> erh) |
ExtensionResultStatusType |
EntityInformationServiceExtensionHandler.getDefaultCatalogIdForSite(Site site,
ExtensionResultHolder<Long> erh)
Handler implementations will populate the
ExtensionResultHolder with a valid default catalog id for the site |
ExtensionResultStatusType |
EntityInformationServiceExtensionManager.getDefaultCatalogIdForSite(Site site,
ExtensionResultHolder<Long> erh) |
ExtensionResultStatusType |
AbstractEntityInformationServiceExtensionHandler.getOkayToUseSiteDiscriminator(Object o,
ExtensionResultHolder<Boolean> erh) |
ExtensionResultStatusType |
EntityInformationServiceExtensionHandler.getOkayToUseSiteDiscriminator(Object o,
ExtensionResultHolder<Boolean> erh)
Handler implementations will set the value of
ExtensionResultHolder to true if the
passed in object supports site discriminator usage. |
ExtensionResultStatusType |
EntityInformationServiceExtensionManager.getOkayToUseSiteDiscriminator(Object o,
ExtensionResultHolder<Boolean> erh) |
ExtensionResultStatusType |
AbstractEntityInformationServiceExtensionHandler.getParentSiteForProfile(Site profile,
ExtensionResultHolder<Site> erh) |
ExtensionResultStatusType |
EntityInformationServiceExtensionHandler.getParentSiteForProfile(Site profile,
ExtensionResultHolder<Site> erh)
Handler implementations will popoulate the
ExtensionResultHolder with a valid
parent site if one exists for the profile |
ExtensionResultStatusType |
EntityInformationServiceExtensionManager.getParentSiteForProfile(Site profile,
ExtensionResultHolder<Site> erh) |
ExtensionResultStatusType |
AbstractEntityInformationServiceExtensionHandler.updateEntityInformationDto(EntityInformationDto dto,
Object entityInstance) |
ExtensionResultStatusType |
EntityInformationServiceExtensionHandler.updateEntityInformationDto(EntityInformationDto dto,
Object entityInstance)
Handler implementations will override or populate the values on the passed in dto.
|
ExtensionResultStatusType |
EntityInformationServiceExtensionManager.updateEntityInformationDto(EntityInformationDto dto,
Object entityInstance) |
| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
TemplateOnlyQueryExtensionHandler.breakdown(Class<?> type)
Perform any breakdown operations.
|
ExtensionResultStatusType |
TemplateOnlyQueryExtensionManager.breakdown(Class<?> type) |
ExtensionResultStatusType |
SparselyPopulatedQueryExtensionHandler.breakdown(Class<?> type,
ResultType resultType)
Perform any breakdown operations.
|
ExtensionResultStatusType |
QueryExtensionHandler.breakdown(Class<?> type,
String[] config)
Perform any breakdown operations.
|
ExtensionResultStatusType |
SparselyPopulatedQueryExtensionHandler.buildStatus(Class<?> type,
List queryResults,
ExtensionResultHolder<List<StandardCacheItem>> response)
Convert the list of query results into a list that denotes not only the query results, but also whether or not each member
represents a deleted/archived item, or an active/normal item.
|
ExtensionResultStatusType |
TemplateOnlyQueryExtensionHandler.buildStatus(Object entity,
ExtensionResultHolder<ItemStatus> response) |
ExtensionResultStatusType |
TemplateOnlyQueryExtensionManager.buildStatus(Object entity,
ExtensionResultHolder<ItemStatus> response) |
ExtensionResultStatusType |
ExtensionManagerOperation.execute(ExtensionHandler handler,
Object... params)
Call a method on the handler using some params.
|
protected ExtensionResultStatusType |
ExtensionManager.execute(ExtensionManagerOperation operation,
Object... params)
Provides a mechanism for executing multiple extension handler touchpoints without utilizing reflection.
|
ExtensionResultStatusType |
TemplateOnlyQueryExtensionHandler.filterResults(Class<?> type,
Object testObject,
List results)
Deprecated.
It's difficult to determine this efficiently at runtime. The current implementation will no longer check the use case described above.
|
ExtensionResultStatusType |
TemplateOnlyQueryExtensionManager.filterResults(Class<?> type,
Object testObject,
List results) |
ExtensionResultStatusType |
SparselyPopulatedQueryExtensionHandler.getCacheKey(Object testObject,
String qualifier,
ResultType resultType,
ExtensionResultHolder<String> response)
Build the cache key to be used for either the STANDARD or TEMPLATE style cache, driven by the resultType.
|
ExtensionResultStatusType |
SparselyPopulatedQueryExtensionHandler.getCacheKey(String qualifier,
ResultType resultType,
ExtensionResultHolder<String> response)
Build the cache key to be used for either the STANDARD or TEMPLATE style cache, driven by the resultType.
|
ExtensionResultStatusType |
SparselyPopulatedQueryExtensionHandler.getCacheKeyListForTemplateSite(String qualifier,
ExtensionResultHolder<List<String>> response)
Build a list of cache keys that are related to a TEMPLATE template site
|
ExtensionResultStatusType |
SparselyPopulatedQueryExtensionHandler.getNormalizedId(Object testObject,
ExtensionResultHolder<Long> response)
Get a common id for an object that is consistent for a standard site (whether or not the test object is overridden in the standard site)
|
ExtensionResultStatusType |
SparselyPopulatedQueryExtensionHandler.getResultType(Object testObject,
ExtensionResultHolder<ResultType> response)
By examining the multitenant information related to a test object, return whether the object is related to a standard
site, or a template profile or catalog, if applicable.
|
ExtensionResultStatusType |
TemplateOnlyQueryExtensionHandler.isValidState(ExtensionResultHolder<Boolean> response)
Determine if the current thread is in a valid state for sparse cache handling
|
ExtensionResultStatusType |
SparselyPopulatedQueryExtensionHandler.isValidState(ExtensionResultHolder<Boolean> response)
Determine if the current thread is in a valid state for sparse cache handling
|
ExtensionResultStatusType |
TemplateOnlyQueryExtensionManager.isValidState(ExtensionResultHolder<Boolean> response) |
ExtensionResultStatusType |
TemplateOnlyQueryExtensionHandler.refineOrder(Class<?> type,
javax.persistence.criteria.CriteriaBuilder builder,
javax.persistence.criteria.CriteriaQuery criteria,
javax.persistence.criteria.Root root,
List<javax.persistence.criteria.Order> sorts)
Add sorting to the fetch query
|
ExtensionResultStatusType |
TemplateOnlyQueryExtensionManager.refineOrder(Class<?> type,
javax.persistence.criteria.CriteriaBuilder builder,
javax.persistence.criteria.CriteriaQuery criteria,
javax.persistence.criteria.Root root,
List<javax.persistence.criteria.Order> sorts) |
ExtensionResultStatusType |
SparselyPopulatedQueryExtensionHandler.refineOrder(Class<?> type,
ResultType resultType,
javax.persistence.criteria.CriteriaBuilder builder,
javax.persistence.criteria.CriteriaQuery criteria,
javax.persistence.criteria.Root root,
List<javax.persistence.criteria.Order> sorts)
Add sorting to the fetch query
|
ExtensionResultStatusType |
QueryExtensionHandler.refineOrder(Class<?> type,
String[] config,
javax.persistence.criteria.CriteriaBuilder builder,
javax.persistence.criteria.CriteriaQuery criteria,
javax.persistence.criteria.Root root,
List<javax.persistence.criteria.Order> sorts)
Add sorting to the fetch query
|
ExtensionResultStatusType |
TemplateOnlyQueryExtensionHandler.refineParameterRetrieve(Class<?> type,
Object testObject,
javax.persistence.criteria.CriteriaBuilder builder,
javax.persistence.criteria.CriteriaQuery criteria,
javax.persistence.criteria.Root root,
List<javax.persistence.criteria.Predicate> restrictions)
Add additional restrictions to the fetch query.
|
ExtensionResultStatusType |
TemplateOnlyQueryExtensionManager.refineParameterRetrieve(Class<?> type,
Object testObject,
javax.persistence.criteria.CriteriaBuilder builder,
javax.persistence.criteria.CriteriaQuery criteria,
javax.persistence.criteria.Root root,
List<javax.persistence.criteria.Predicate> restrictions) |
ExtensionResultStatusType |
SparselyPopulatedQueryExtensionHandler.refineParameterRetrieve(Class<?> type,
ResultType resultType,
javax.persistence.criteria.CriteriaBuilder builder,
javax.persistence.criteria.CriteriaQuery criteria,
javax.persistence.criteria.Root root,
List<javax.persistence.criteria.Predicate> restrictions)
Add additional restrictions to the fetch query.
|
ExtensionResultStatusType |
TemplateOnlyQueryExtensionHandler.refineQuery(Class<?> type,
Object testObject,
javax.persistence.TypedQuery query)
Finish the query - possibly setting parameters
|
ExtensionResultStatusType |
TemplateOnlyQueryExtensionManager.refineQuery(Class<?> type,
Object testObject,
javax.persistence.TypedQuery query) |
ExtensionResultStatusType |
SparselyPopulatedQueryExtensionHandler.refineQuery(Class<?> type,
ResultType resultType,
javax.persistence.TypedQuery query)
Finish the query - possibly setting parameters
|
ExtensionResultStatusType |
SparselyPopulatedQueryExtensionHandler.refineResults(Class<?> type,
ResultType resultType,
List queryResults,
ExtensionResultHolder<List> response)
Filter the results from the database in Java
|
ExtensionResultStatusType |
QueryExtensionHandler.refineResults(Class<?> type,
String[] config,
List queryResults,
ExtensionResultHolder<List> response)
Filter the results from the database in Java
|
ExtensionResultStatusType |
SparselyPopulatedQueryExtensionHandler.refineRetrieve(Class<?> type,
ResultType resultType,
javax.persistence.criteria.CriteriaBuilder builder,
javax.persistence.criteria.CriteriaQuery criteria,
javax.persistence.criteria.Root root,
List<javax.persistence.criteria.Predicate> restrictions)
Add additional restrictions to the fetch query
|
ExtensionResultStatusType |
QueryExtensionHandler.refineRetrieve(Class<?> type,
String[] config,
javax.persistence.criteria.CriteriaBuilder builder,
javax.persistence.criteria.CriteriaQuery criteria,
javax.persistence.criteria.Root root,
List<javax.persistence.criteria.Predicate> restrictions)
Add additional restrictions to the fetch query
|
ExtensionResultStatusType |
TemplateOnlyQueryExtensionHandler.setup(Class<?> type)
Perform any setup operations.
|
ExtensionResultStatusType |
TemplateOnlyQueryExtensionManager.setup(Class<?> type) |
ExtensionResultStatusType |
SparselyPopulatedQueryExtensionHandler.setup(Class<?> type,
ResultType resultType)
Perform any setup operations.
|
ExtensionResultStatusType |
QueryExtensionHandler.setup(Class<?> type,
String[] config)
Perform any setup operations.
|
static ExtensionResultStatusType |
ExtensionResultStatusType.valueOf(String name)
Returns the enum constant of this type with the specified name.
|
static ExtensionResultStatusType[] |
ExtensionResultStatusType.values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
ExtensionManager.shouldContinue(ExtensionResultStatusType result,
ExtensionHandler handler,
Method method,
Object[] args)
Utility method that is useful for determining whether or not an ExtensionManager implementation
should continue after processing a ExtensionHandler call.
|
| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
BroadleafStaticAssetExtensionHandler.modifyDuplicateAssetURL(StringBuilder urlBuilder)
Provide an extension point to modify the url for a StaticAsset in the case
where multiple assets have the same url.
|
ExtensionResultStatusType |
BroadleafFileServiceExtensionHandler.processPathForSite(String prefix,
String resourceName,
ExtensionResultHolder<String> holder) |
ExtensionResultStatusType |
BroadleafStaticAssetExtensionHandler.removeShareOptionsForMTStandardSite(org.springframework.ui.Model model,
Site currentSite) |
ExtensionResultStatusType |
BroadleafFileServiceExtensionHandler.retrieveAllParentSitesIds(Site site,
ExtensionResultHolder<List<String>> holder) |
| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
TranslationDaoExtensionHandler.overrideRequestedId(ExtensionResultHolder erh,
javax.persistence.EntityManager em,
Class<?> clazz,
Long entityId)
If there is a different id that should be used for a translation lookup instead of the given entityId,
the handler should place the result in the
ExtensionResultHolder argument. |
| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
EntityDuplicatorExtensionHandler.setupDuplicate(Object entity,
ExtensionResultHolder<MultiTenantCopyContext> resultHolder)
Perform any required context and state setup before commencing with the duplication
|
ExtensionResultStatusType |
EntityDuplicatorExtensionManager.setupDuplicate(Object entity,
ExtensionResultHolder<MultiTenantCopyContext> resultHolder) |
ExtensionResultStatusType |
EntityDuplicatorExtensionHandler.tearDownDuplicate()
Tear down any expired context and state used during the duplication
|
ExtensionResultStatusType |
EntityDuplicatorExtensionManager.tearDownDuplicate() |
ExtensionResultStatusType |
EntityDuplicatorExtensionHandler.validateDuplicate(Object entity,
ExtensionResultHolder<Boolean> resultHolder)
Confirm whether or not duplication operation is allowed
|
ExtensionResultStatusType |
EntityDuplicatorExtensionManager.validateDuplicate(Object entity,
ExtensionResultHolder<Boolean> resultHolder) |
| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
SiteServiceExtensionHandler.contributeNonPersitentSiteProperties(Site from,
Site to)
Invoked via
SiteServiceImpl.getNonPersistentSite(Site) after the initial framework clone. |
ExtensionResultStatusType |
AbstractSiteServiceExtensionHandler.contributeNonPersitentSiteProperties(Site from,
Site to) |
| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
TemplateOverrideExtensionHandler.getOverrideTemplate(ExtensionResultHolder<String> erh,
Object object) |
ExtensionResultStatusType |
AbstractTemplateOverrideExtensionHandler.getOverrideTemplate(ExtensionResultHolder<String> erh,
Object object) |
| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
AbstractBroadleafMergeResourceExtensionHandler.resolveMessageSource(String code,
Locale locale,
ExtensionResultHolder<String> result) |
ExtensionResultStatusType |
BroadleafMergeResourceExtensionHandler.resolveMessageSource(String code,
Locale locale,
ExtensionResultHolder<String> result) |
| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
AbstractBroadleafTemplateResolverExtensionHandler.appendCacheKey(ExtensionResultHolder<String> erh,
String originalViewName,
boolean isAjaxRequest) |
ExtensionResultStatusType |
BroadleafTemplateViewResolverExtensionHandler.appendCacheKey(ExtensionResultHolder<String> erh,
String originalViewName,
boolean isAjaxRequest)
Allows an extension handler to alter the cache key for the view.
|
ExtensionResultStatusType |
AbstractBroadleafTemplateResolverExtensionHandler.overrideView(ExtensionResultHolder<String> erh,
String originalViewName,
boolean isAjaxRequest) |
ExtensionResultStatusType |
BroadleafTemplateViewResolverExtensionHandler.overrideView(ExtensionResultHolder<String> erh,
String originalViewName,
boolean isAjaxRequest)
Allows an extension handler to override the view name.
|
ExtensionResultStatusType |
AbstractBroadleafTemplateResolverExtensionHandler.provideTemplateWrapper(ExtensionResultHolder<String> erh,
String originalViewName,
boolean isAjaxRequest) |
ExtensionResultStatusType |
BroadleafTemplateViewResolverExtensionHandler.provideTemplateWrapper(ExtensionResultHolder<String> erh,
String originalViewName,
boolean isAjaxRequest)
Allows an extension handler to provide a wrapper for the template.
|
| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
AbstractBLCICacheExtensionHandler.getCache(Object key,
ExtensionResultHolder<Object> erh,
org.broadleafcommerce.presentation.cache.BroadleafTemplateCacheContext blciCache) |
ExtensionResultStatusType |
BLCICacheExtensionHandler.getCache(Object key,
ExtensionResultHolder<Object> erh,
org.broadleafcommerce.presentation.cache.BroadleafTemplateCacheContext blciCache) |
ExtensionResultStatusType |
AbstractBLCICacheExtensionHandler.putCache(Object key,
Object value,
org.broadleafcommerce.presentation.cache.BroadleafTemplateCacheContext blciCache) |
ExtensionResultStatusType |
BLCICacheExtensionHandler.putCache(Object key,
Object value,
org.broadleafcommerce.presentation.cache.BroadleafTemplateCacheContext blciCache) |
| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
PaymentGatewayFieldExtensionHandler.mapFieldName(String fieldNameKey,
Map<String,String> fieldNameMap) |
ExtensionResultStatusType |
AbstractPaymentGatewayFieldExtensionHandler.mapFieldName(String fieldNameKey,
Map<String,String> fieldNameMap) |
| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
TRCreditCardExtensionHandler.createTransparentRedirectForm(Map<String,Map<String,String>> formParameters,
PaymentRequestDTO requestDTO,
Map<String,String> configurationSettings)
The implementing modules should take into consideration the passed in configuration settings map
and call their implementing TransparentRedirectService to generate either an Authorize
or Authorize and Capture Form.
|
ExtensionResultStatusType |
AbstractTRCreditCardExtensionHandler.createTransparentRedirectForm(Map<String,Map<String,String>> formParameters,
PaymentRequestDTO requestDTO,
Map<String,String> configurationSettings) |
ExtensionResultStatusType |
AbstractCreditCardTypesExtensionHandler.populateCreditCardMap(Map<String,String> creditCardTypes) |
ExtensionResultStatusType |
CreditCardTypesExtensionHandler.populateCreditCardMap(Map<String,String> creditCardTypes)
The registered Extension Handler will populate any specific Payment Gateway
codes required for Credit Card Types.
|
ExtensionResultStatusType |
TRCreditCardExtensionHandler.setFormActionKey(StringBuilder key) |
ExtensionResultStatusType |
AbstractTRCreditCardExtensionHandler.setFormActionKey(StringBuilder key) |
ExtensionResultStatusType |
TRCreditCardExtensionHandler.setFormHiddenParamsKey(StringBuilder key) |
ExtensionResultStatusType |
AbstractTRCreditCardExtensionHandler.setFormHiddenParamsKey(StringBuilder key) |
| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
ResourceRequestExtensionHandler.getModifiedResource(String path,
ExtensionResultHolder erh)
Populates the RESOURCE_ATTR field in the ExtensionResultHolder map with an instance of
Resource if the value of the modified resource. |
ExtensionResultStatusType |
AbstractResourceRequestExtensionHandler.getModifiedResource(String path,
ExtensionResultHolder erh) |
ExtensionResultStatusType |
ResourceRequestExtensionHandler.getOverrideResource(String path,
ExtensionResultHolder erh)
Populates the RESOURCE_ATTR field in the ExtensionResultHolder map with an instance of
Resource if there is an override resource available for the current path. |
ExtensionResultStatusType |
AbstractResourceRequestExtensionHandler.getOverrideResource(String path,
ExtensionResultHolder erh) |
| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
AbstractDatabaseResourceResolverExtensionHandler.resolveResource(ExtensionResultHolder erh,
String resourceName) |
ExtensionResultStatusType |
DatabaseResourceResolverExtensionHandler.resolveResource(ExtensionResultHolder erh,
String resourceName)
If this method returns any of the handled conditions in
ExtensionResultStatusType,
the value keyed by DatabaseResourceResolverExtensionHandler.IS_KEY in the
ExtensionResultHolder's context map will be an InputStream of the resolved resource's
contents. |
Copyright © 2020. All rights reserved.