Package com.broadleafcommerce.advancedcms.admin.web.controller

Class AdminContentTargeterController

java.lang.Object
org.broadleafcommerce.common.web.controller.BroadleafAbstractController
org.broadleafcommerce.openadmin.web.controller.AdminAbstractController
org.broadleafcommerce.openadmin.web.controller.entity.AdminBasicEntityController
com.broadleafcommerce.advancedcms.admin.web.controller.AdminContentTargeterController
@RequestMapping("/content-targeter") public class AdminContentTargeterController extends org.broadleafcommerce.openadmin.web.controller.entity.AdminBasicEntityController
Provides additional endpoints for retrieving dynamic data to be used in conjunction with the content targeting actions.
Author:
Andre Azzolini (apazzolini)

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected org.broadleafcommerce.cms.admin.server.handler.DynamicFieldPersistenceHandlerHelper
    fieldHelper
     
    protected org.broadleafcommerce.cms.page.service.PageService
    pageService
     
    static final String
    SECTION_KEY
     

    Fields inherited from class org.broadleafcommerce.openadmin.web.controller.entity.AdminBasicEntityController

    adminUserDao, adornedTargetAutoPopulateExtensionManager, ALTERNATE_ID_PROPERTY, CURRENT_FOLDER_ID, CUSTOM_CRITERIA, duplicator, dynamicEntityDao, genericEntityService, IS_SELECTIZE_REQUEST, LOG, multipleCatalogExtensionManager, rowLevelSecurityService, sandBoxHelper

    Fields inherited from class org.broadleafcommerce.openadmin.web.controller.AdminAbstractController

    adminNavigationService, adminRemoteSecurityService, CURRENT_ADMIN_MODULE_ATTRIBUTE_NAME, CURRENT_ADMIN_SECTION_ATTRIBUTE_NAME, customCriteriaService, DEFAULT_CONTAINER_VIEW, entityConfiguration, entityFormValidator, eps, extensionManager, FILTER_VALUE_SEPARATOR, FILTER_VALUE_SEPARATOR_REGEX, filterProductTypeExtensionManager, formService, MODAL_CONTAINER_VIEW, service, validationService

  • Constructor Summary

    Constructors
    Constructor
    Description
    AdminContentTargeterController()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    addCollectionItem(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, org.springframework.ui.Model model, Map<String,String> pathVars, String id, String collectionField, org.broadleafcommerce.openadmin.web.form.entity.EntityForm entityForm, org.springframework.validation.BindingResult result)
     
    protected Collection<org.broadleafcommerce.cms.field.domain.FieldDefinition>
    extractFieldDefinitions(Map<String,com.broadleafcommerce.theme.domain.page.PageTypeFieldDefinitionXref> xrefMap)
     
    protected Collection<org.broadleafcommerce.cms.field.domain.FieldDefinition>
    extractPagefields(org.broadleafcommerce.cms.page.domain.Page page)
     
    Map<String,Object>
    getAvailablePageFieldKeys(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, org.springframework.ui.Model model, Map<String,String> pathVars, Long pageId)
     
    String
    getDynamicPageField(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, org.springframework.ui.Model model, Map<String,String> pathVars, Long pageId, String fieldKey)
     
    protected org.broadleafcommerce.openadmin.web.form.entity.Field
    getFieldForFieldDefinition(org.broadleafcommerce.cms.field.domain.FieldDefinition definition)
    Returns a Field that represents the given parameter, assuming that the given FieldDefinition is a dynamic field for the Page class.
    protected String
    getSectionKey(Map<String,String> pathVars)
     
    protected void
    modifyEntityForm(org.broadleafcommerce.openadmin.web.form.entity.EntityForm entityForm, Map<String,String> pathVars)
     
    String
    showUpdateCollectionItem(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, org.springframework.ui.Model model, Map<String,String> pathVars, String id, String collectionField, String collectionItemId)
     
    String
    updateCollectionItem(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, org.springframework.ui.Model model, Map<String,String> pathVars, String id, String collectionField, String collectionItemId, org.broadleafcommerce.openadmin.web.form.entity.EntityForm entityForm, org.springframework.validation.BindingResult result)
     

    Methods inherited from class org.broadleafcommerce.openadmin.web.controller.entity.AdminBasicEntityController

    addAddActionIfAllowed, addAuditableDisplayField, addAuditableDisplayFields, addCollectionItem, addEmptyCollectionItem, addEntity, addSelectizeCollectionItem, buildAddCollectionItemModel, buildAuditableDisplayField, buildDirtyList, buildSelectizeCustomCriteria, declareShouldIgnoreAdditionStatusFilter, determineEntityType, duplicateEntity, getCollectionFieldRecords, getCollectionValueDetails, getCurrentFolderId, getCurrentTabName, getCustomCriteria, getErrorDuplicatingResponse, getModalForBlankEntityType, getSelectizeCollectionOptions, getViewSubRecords, initBinder, isAddActionAllowed, isNotReadOnly, modifyEntityForm, postAddSubCollectionEntityHook, postUpdateSubCollectionEntityHook, reinitializeEntityForm, removeCollectionItem, removeCollectionItem, removeEntity, resolveAppropriateEntityView, saveEntity, saveEntityJson, setTypedEntityModelAttributes, setupViewEntityListBasicModel, showAddCollectionItem, showUpdateCollectionItem, showViewCollectionItem, showViewCollectionItem, showViewUpdateCollection, showViewUpdateCollection, showViewUpdateCollection, showViewUpdateCollection, updateCollectionItem, updateCollectionItemSequence, updateCollectionItemSequence, viewAddEntityForm, viewCollectionItemDetails, viewCollectionItemTab, viewEntityForm, viewEntityList, viewEntityListSelectize, viewEntityTab, viewReadOnlyCollectionItemTab

    Methods inherited from class org.broadleafcommerce.openadmin.web.controller.AdminAbstractController

    attachSectionSpecificInfo, attachSectionSpecificInfo, createSectionCrumb, declareForceUseAdditionStatusFilter, extractDynamicFormFields, getAddEntityTypes, getClassNameForSection, getCollectionListGrid, getCollectionListGrid, getCriteria, getDefaultEntityType, getDynamicFieldTemplateForm, getDynamicForm, getEntityForm, getEntityForm, getEntityForm, getFirstId, getLastId, getLowerCount, getMaxIndex, getMaxResults, getPageSize, getPersistencePackageRequest, getSectionCrumbs, getSectionCustomCriteria, getSectionPersistencePackageRequest, getSectionPersistencePackageRequest, getSectionPersistencePackageRequest, getSectionPersistencePackageRequest, getSortDirections, getSortPropertyNames, getStartIndex, getUpperCount, modifyAddEntityForm, modifyCriteria, populateJsonValidationErrors, setModelAttributes, setSpecializedNameForFields, translateErrorMessage

    Methods inherited from class org.broadleafcommerce.common.web.controller.BroadleafAbstractController

    addDeepLink, getContextPath, isAjaxRequest, jsonResponse

    Methods inherited from class java.lang.Object

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

  • Field Details

    • SECTION_KEY

      public static final String SECTION_KEY
      See Also:

    • pageService

      protected org.broadleafcommerce.cms.page.service.PageService pageService

    • fieldHelper

      protected org.broadleafcommerce.cms.admin.server.handler.DynamicFieldPersistenceHandlerHelper fieldHelper

  • Constructor Details

    • AdminContentTargeterController

      public AdminContentTargeterController()

  • Method Details

    • getSectionKey

      protected String getSectionKey(Map<String,String> pathVars)
      Overrides:
      getSectionKey in class org.broadleafcommerce.openadmin.web.controller.AdminAbstractController

    • getFieldForFieldDefinition

      protected org.broadleafcommerce.openadmin.web.form.entity.Field getFieldForFieldDefinition(org.broadleafcommerce.cms.field.domain.FieldDefinition definition)
      Returns a Field that represents the given parameter, assuming that the given FieldDefinition is a dynamic field for the Page class.
      Parameters:
      definition -
      Returns:
      the Field for the given FieldDefinition

    • modifyEntityForm

      protected void modifyEntityForm(org.broadleafcommerce.openadmin.web.form.entity.EntityForm entityForm, Map<String,String> pathVars) throws Exception
      Overrides:
      modifyEntityForm in class org.broadleafcommerce.openadmin.web.controller.AdminAbstractController
      Throws:
      Exception

    • showUpdateCollectionItem

      @RequestMapping(value="/{id}/{collectionField:[^0-9].*}/{collectionItemId}", method=GET) public String showUpdateCollectionItem(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, org.springframework.ui.Model model, @PathVariable Map<String,String> pathVars, @PathVariable("id") String id, @PathVariable("collectionField") String collectionField, @PathVariable("collectionItemId") String collectionItemId) throws Exception
      Overrides:
      showUpdateCollectionItem in class org.broadleafcommerce.openadmin.web.controller.entity.AdminBasicEntityController
      Throws:
      Exception

    • updateCollectionItem

      @RequestMapping(value="/{id}/{collectionField:[^0-9].*}/{collectionItemId}", method=POST) public String updateCollectionItem(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, org.springframework.ui.Model model, @PathVariable Map<String,String> pathVars, @PathVariable("id") String id, @PathVariable("collectionField") String collectionField, @PathVariable("collectionItemId") String collectionItemId, @ModelAttribute("entityForm") org.broadleafcommerce.openadmin.web.form.entity.EntityForm entityForm, org.springframework.validation.BindingResult result) throws Exception
      Overrides:
      updateCollectionItem in class org.broadleafcommerce.openadmin.web.controller.entity.AdminBasicEntityController
      Throws:
      Exception

    • addCollectionItem

      @RequestMapping(value="/{id}/{collectionField:[^0-9].*}/add", method=POST) public String addCollectionItem(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, org.springframework.ui.Model model, @PathVariable Map<String,String> pathVars, @PathVariable("id") String id, @PathVariable("collectionField") String collectionField, @ModelAttribute("entityForm") org.broadleafcommerce.openadmin.web.form.entity.EntityForm entityForm, org.springframework.validation.BindingResult result) throws Exception
      Overrides:
      addCollectionItem in class org.broadleafcommerce.openadmin.web.controller.entity.AdminBasicEntityController
      Throws:
      Exception

    • getAvailablePageFieldKeys

      @RequestMapping(value="/available-page-fieldkeys/{id}", method=GET) @ResponseBody public Map<String,Object> getAvailablePageFieldKeys(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, org.springframework.ui.Model model, @PathVariable Map<String,String> pathVars, @PathVariable("id") Long pageId) throws Exception
      Throws:
      Exception

    • getDynamicPageField

      @RequestMapping(value="/page-dynamic-field/{id}/{fieldKey}", method=GET) public String getDynamicPageField(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, org.springframework.ui.Model model, @PathVariable Map<String,String> pathVars, @PathVariable("id") Long pageId, @PathVariable("fieldKey") String fieldKey) throws Exception
      Throws:
      Exception

    • extractFieldDefinitions

      protected Collection<org.broadleafcommerce.cms.field.domain.FieldDefinition> extractFieldDefinitions(Map<String,com.broadleafcommerce.theme.domain.page.PageTypeFieldDefinitionXref> xrefMap)

    • extractPagefields

      protected Collection<org.broadleafcommerce.cms.field.domain.FieldDefinition> extractPagefields(org.broadleafcommerce.cms.page.domain.Page page)