org.broadleafcommerce.openadmin.web.controller

Class AdminAbstractController

java.lang.Object

org.broadleafcommerce.common.web.controller.BroadleafAbstractController

org.broadleafcommerce.openadmin.web.controller.AdminAbstractController

Direct Known Subclasses:

AdminBasicEntityController, AdminBasicOperationsController, AdminExportController, AdminTranslationController

public abstract class AdminAbstractController
extends BroadleafAbstractController

An abstract controller that provides convenience methods and resource declarations for the Admin Operations that are shared between all admin controllers belong here.

Author:

elbertbautista, apazzolini

See Also:

org.broadleafcommerce.openadmin.web.handler.AdminNavigationHandlerMapping

Field Summary

Fields

Modifier and Type	Field and Description
protected AdminNavigationService	adminNavigationService
protected SecurityVerifier	adminRemoteSecurityService
static String	CURRENT_ADMIN_MODULE_ATTRIBUTE_NAME
static String	CURRENT_ADMIN_SECTION_ATTRIBUTE_NAME
protected AdminSectionCustomCriteriaService	customCriteriaService
protected EntityConfiguration	entityConfiguration
protected EntityFormValidator	entityFormValidator
protected AdminAbstractControllerExtensionManager	extensionManager
static String	FILTER_VALUE_SEPARATOR
static String	FILTER_VALUE_SEPARATOR_REGEX
protected FormBuilderService	formService
protected static org.apache.commons.logging.Log	LOG
protected MainEntityActionsExtensionManager	mainEntityActionsExtensionManager Deprecated.
protected AdminEntityService	service
protected ClassNameRequestParamValidationService	validationService

Constructor Summary

Constructors

Constructor and Description
AdminAbstractController()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	attachSectionSpecificInfo(PersistencePackageRequest ppr) Deprecated. in favor of attachSectionSpecificInfo(PersistencePackageRequest, Map)
protected void	attachSectionSpecificInfo(PersistencePackageRequest ppr, Map<String,String> pathVars) A hook method that is invoked every time the #getSectionPersistencePackageRequest(String) method is invoked.
protected void	extractDynamicFormFields(ClassMetadata cmd, EntityForm entityForm) This method will scan the entityForm for all dynamic form fields and pull them out as appropriate.
protected List<ClassTree>	getAddEntityTypes(ClassTree classTree) If there are certain types of entities that should not be allowed to be created, an override of this method would be able to specify that.
protected String	getClassNameForSection(String sectionKey) Gets the fully qualified ceiling entity classname for this section.
protected ListGrid	getCollectionListGrid(ClassMetadata mainMetadata, Entity entity, Property collectionProperty, org.springframework.util.MultiValueMap<String,String> requestParams, String sectionKey, List<SectionCrumb> sectionCrumbs) Convenience method for obtaining a ListGrid DTO object for a collection.
protected ListGrid	getCollectionListGrid(ClassMetadata mainMetadata, Entity entity, Property collectionProperty, org.springframework.util.MultiValueMap<String,String> requestParams, String sectionKey, PersistenceResponse persistenceResponse, List<SectionCrumb> sectionCrumbs) Convenience method for obtaining a ListGrid DTO object for a collection.
protected FilterAndSortCriteria[]	getCriteria(Map<String,List<String>> requestParams) Helper method to return an array of FilterAndSortCriteria based on a map of propertyName -> list of criteria value.
protected String	getDefaultEntityType() This method is called when attempting to add new entities that have a polymorphic tree.
protected EntityForm	getDynamicFieldTemplateForm(DynamicEntityFormInfo info, String entityId, EntityForm dynamicFormOverride) Convenience method for obtaining a dynamic field template form for a particular entity.
protected String	getDynamicForm(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.springframework.ui.Model model, Map<String,String> pathVars, DynamicEntityFormInfo info) Returns a partial representing a dynamic form.
protected EntityForm	getEntityForm(DynamicEntityFormInfo info)
protected EntityForm	getEntityForm(DynamicEntityFormInfo info, EntityForm dynamicFormOverride)
protected EntityForm	getEntityForm(String sectionKey, String sectionClassName, String id) Convenience method for obtaining a fully built EntityForm for the given sectionKey, sectionClassName, and id.
protected Integer	getMaxIndex(Map<String,List<String>> requestParams) Obtains the requested max index parameter
protected Integer	getMaxResults(Map<String,List<String>> requestParams) Obtains the requested max index parameter
protected List<SectionCrumb>	getSectionCrumbs(javax.servlet.http.HttpServletRequest request, String currentSection, String currentSectionId)
protected String[]	getSectionCustomCriteria() This method is invoked for every request for this controller.
protected String	getSectionKey(Map<String,String> pathVars) This method is used to determine the current section key.
protected PersistencePackageRequest	getSectionPersistencePackageRequest(String sectionClassName, List<SectionCrumb> sectionCrumbs) Deprecated. in favor of getSectionPersistencePackageRequest(String, List, Map)
protected PersistencePackageRequest	getSectionPersistencePackageRequest(String sectionClassName, List<SectionCrumb> sectionCrumbs, Map<String,String> pathVars) Returns a PersistencePackageRequest for the given sectionClassName.
protected PersistencePackageRequest	getSectionPersistencePackageRequest(String sectionClassName, org.springframework.util.MultiValueMap<String,String> requestParams, List<SectionCrumb> sectionCrumbs) Deprecated. in favor of getSectionPersistencePackageRequest(String, MultiValueMap, List, Map)
protected PersistencePackageRequest	getSectionPersistencePackageRequest(String sectionClassName, org.springframework.util.MultiValueMap<String,String> requestParams, List<SectionCrumb> sectionCrumbs, Map<String,String> pathVars) Returns the result of a call to #getSectionPersistencePackageRequest(String) with the additional filter and sort criteria attached.
protected List<String>	getSortDirections(Map<String,List<String>> requestParams) Obtains the list of sort directions from the bound request parameters.
protected List<String>	getSortPropertyNames(Map<String,List<String>> requestParams) Obtains the list of property names to sort on from the bound request parameters.
protected Integer	getStartIndex(Map<String,List<String>> requestParams) Obtains the requested start index parameter
protected void	modifyAddEntityForm(EntityForm entityForm, Map<String,String> pathVars) This method is invoked whenever an assembled EntityForm is rendered for the add entity screen.
protected void	modifyEntityForm(EntityForm entityForm, Map<String,String> pathVars) This method is invoked whenever an assembled EntityForm is rendered.
protected JsonResponse	populateJsonValidationErrors(EntityForm form, org.springframework.validation.BindingResult result, JsonResponse json) Populates the given json response object based on the given form and result
protected void	setModelAttributes(org.springframework.ui.Model model, String sectionKey) Attributes to add to the model on every request
protected void	setSpecializedNameForFields(DynamicEntityFormInfo info, EntityForm dynamicForm)
protected String	translateErrorMessage(org.springframework.validation.ObjectError error)

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 Detail

LOG

protected static final org.apache.commons.logging.Log LOG

FILTER_VALUE_SEPARATOR

public static final String FILTER_VALUE_SEPARATOR

See Also:

Constant Field Values

FILTER_VALUE_SEPARATOR_REGEX

public static final String FILTER_VALUE_SEPARATOR_REGEX

See Also:

Constant Field Values

CURRENT_ADMIN_MODULE_ATTRIBUTE_NAME

public static final String CURRENT_ADMIN_MODULE_ATTRIBUTE_NAME

See Also:

Constant Field Values

CURRENT_ADMIN_SECTION_ATTRIBUTE_NAME

public static final String CURRENT_ADMIN_SECTION_ATTRIBUTE_NAME

See Also:

Constant Field Values

service

protected AdminEntityService service

formService

protected FormBuilderService formService

adminNavigationService

protected AdminNavigationService adminNavigationService

entityConfiguration

protected EntityConfiguration entityConfiguration

entityFormValidator

protected EntityFormValidator entityFormValidator

adminRemoteSecurityService

protected SecurityVerifier adminRemoteSecurityService

customCriteriaService

protected AdminSectionCustomCriteriaService customCriteriaService

mainEntityActionsExtensionManager

@Deprecated
protected MainEntityActionsExtensionManager mainEntityActionsExtensionManager

Deprecated.

Deprecated in favor of AdminAbstractControllerExtensionManager

extensionManager

protected AdminAbstractControllerExtensionManager extensionManager

validationService

protected ClassNameRequestParamValidationService validationService

Constructor Detail

AdminAbstractController

public AdminAbstractController()

Method Detail

getEntityForm

protected EntityForm getEntityForm(String sectionKey,
                       String sectionClassName,
                       String id)
                            throws ServiceException

Convenience method for obtaining a fully built EntityForm for the given sectionKey, sectionClassName, and id.

Parameters:

sectionKey -

sectionClassName -

id -

Returns:

a fully composed EntityForm

Throws:

ServiceException

getDynamicForm

protected String getDynamicForm(javax.servlet.http.HttpServletRequest request,
                    javax.servlet.http.HttpServletResponse response,
                    org.springframework.ui.Model model,
                    Map<String,String> pathVars,
                    DynamicEntityFormInfo info)
                         throws Exception

Returns a partial representing a dynamic form. An example of this is the dynamic fields that render on structured content, which are determined by the currently selected structured content type. This method is typically only invoked through Javascript and used to replace the current dynamic form with the one for the newly selected type.

Parameters:

request -

response -

model -

pathVars -

info -

Returns:

the return view path

Throws:

Exception

getCollectionListGrid

protected ListGrid getCollectionListGrid(ClassMetadata mainMetadata,
                             Entity entity,
                             Property collectionProperty,
                             org.springframework.util.MultiValueMap<String,String> requestParams,
                             String sectionKey,
                             PersistenceResponse persistenceResponse,
                             List<SectionCrumb> sectionCrumbs)
                                  throws ServiceException

Convenience method for obtaining a ListGrid DTO object for a collection. Note that if no criteria is available, then this should be null (or empty)

Parameters:

mainMetadata - class metadata for the root entity that this collectionProperty relates to

id - foreign key from the root entity for collectionProperty

collectionProperty - property that this collection should be based on from the root entity

form - the criteria form model attribute

sectionKey - the current main section key

Returns:

the list grid

Throws:

ServiceException

getCollectionListGrid

protected ListGrid getCollectionListGrid(ClassMetadata mainMetadata,
                             Entity entity,
                             Property collectionProperty,
                             org.springframework.util.MultiValueMap<String,String> requestParams,
                             String sectionKey,
                             List<SectionCrumb> sectionCrumbs)
                                  throws ServiceException

Convenience method for obtaining a ListGrid DTO object for a collection. Note that if no criteria is available, then this should be null (or empty)

Parameters:

mainMetadata - class metadata for the root entity that this collectionProperty relates to

id - foreign key from the root entity for collectionProperty

collectionProperty - property that this collection should be based on from the root entity

form - the criteria form model attribute

sectionKey - the current main section key

Returns:

the list grid

Throws:

ServiceException

getEntityForm

protected EntityForm getEntityForm(DynamicEntityFormInfo info)
                            throws ServiceException

Throws:

ServiceException

getEntityForm

protected EntityForm getEntityForm(DynamicEntityFormInfo info,
                       EntityForm dynamicFormOverride)
                            throws ServiceException

Throws:

ServiceException

getDynamicFieldTemplateForm

protected EntityForm getDynamicFieldTemplateForm(DynamicEntityFormInfo info,
                                     String entityId,
                                     EntityForm dynamicFormOverride)
                                          throws ServiceException

Convenience method for obtaining a dynamic field template form for a particular entity. This method differs from #getBlankDynamicFieldTemplateForm(DynamicEntityFormInfo) in that it will fill out the current values for the fields in this dynamic form from the database. This method is invoked when the initial view of a page containing a dynamic form is triggered. Optionally, you can pass in a pre-existing dynamic form to this method that already has updated values. Example usage would be for after validation has failed and you do not want to lookup old values from the database again.

Parameters:

info -

entityId -

dynamicForm - optional dynamic form that already has values to fill out

Returns:

the entity form

Throws:

ServiceException

setSpecializedNameForFields

protected void setSpecializedNameForFields(DynamicEntityFormInfo info,
                               EntityForm dynamicForm)

extractDynamicFormFields

protected void extractDynamicFormFields(ClassMetadata cmd,
                            EntityForm entityForm)

This method will scan the entityForm for all dynamic form fields and pull them out as appropriate.

Parameters:

cmd -

entityForm -

getSectionKey

protected String getSectionKey(Map<String,String> pathVars)

This method is used to determine the current section key. For this default implementation, the sectionKey is pulled from the pathVariable, {sectionKey}, as defined by the request mapping on this controller. To support controller inheritance and allow more specialized controllers to delegate some methods to this basic controller, overridden implementations of this method could return a hardcoded value instead of reading the map

Parameters:

pathVars - - the map of all currently bound path variables for this request

Returns:

the sectionKey for this request

getCriteria

protected FilterAndSortCriteria[] getCriteria(Map<String,List<String>> requestParams)

Helper method to return an array of FilterAndSortCriteria based on a map of propertyName -> list of criteria value. This will also grab the sorts off of the request parameters, if any.

The multi-valued map allows users to specify multiple criteria values per property, as well as multiple sort properties and sort directions. For multiple sort properties and sort directions, these would usually come in as request parameters like:

....?sortProperty=defaultSku.name&sortProperty=manufacturer&sortDirection=ASCENDING&sortDirection=DESCENDING

This would attach criteria such that defaultSku.name was sorted ascending, and manufacturer was sorted descending

Parameters:

requestParams - usually a MultiValueMap that has been bound by a controller to receive all of the request parameters that are not explicitly named

Returns:

the final array of FilterAndSortCriteria to pass to the fetch

See Also:

#getSortPropertyNames(Map)}, #getSortDirections(Map)}

getSortDirections

protected List<String> getSortDirections(Map<String,List<String>> requestParams)

Obtains the list of sort directions from the bound request parameters. Note that these should appear in the same relative order as getSortPropertyNames(Map)

Parameters:

requestParams -

Returns:

getSortPropertyNames

protected List<String> getSortPropertyNames(Map<String,List<String>> requestParams)

Obtains the list of property names to sort on from the bound request parameters. Note that these should appear in the same relative order as getSortDirections(Map).

Parameters:

requestParams -

Returns:

getClassNameForSection

protected String getClassNameForSection(String sectionKey)

Gets the fully qualified ceiling entity classname for this section. If this section is not explicitly defined in the database, will return the value passed into this function. For example, if there is a mapping from "/myentity" to "com.mycompany.myentity", both "http://localhost/myentity" and "http://localhost/com.mycompany.myentity" are valid request paths.

Parameters:

sectionKey -

Returns:

the className for this sectionKey if found in the database or the sectionKey if not

getAddEntityTypes

protected List<ClassTree> getAddEntityTypes(ClassTree classTree)

If there are certain types of entities that should not be allowed to be created, an override of this method would be able to specify that. It could also add additional types if desired.

Parameters:

classTree -

Returns:

a List representing all potentially avaialble entity types to create

getDefaultEntityType

protected String getDefaultEntityType()

This method is called when attempting to add new entities that have a polymorphic tree. If this method returns null, there is no default type set for this particular entity type, and the user will be presented with a selection of possible types to utilize. If it returns a non-null value, the returned fullyQualifiedClassname will be used and will bypass the selection step.

Returns:

null if there is no default type, otherwise the default type

getSectionCustomCriteria

protected String[] getSectionCustomCriteria()

This method is invoked for every request for this controller. By default, we do not want to specify a custom criteria, but specialized controllers may want to.

Returns:

the custom criteria for this section for all requests, if any

attachSectionSpecificInfo

@Deprecated
protected void attachSectionSpecificInfo(PersistencePackageRequest ppr)

Deprecated. in favor of attachSectionSpecificInfo(PersistencePackageRequest, Map)

modifyEntityForm

protected void modifyEntityForm(EntityForm entityForm,
                    Map<String,String> pathVars)
                         throws Exception

This method is invoked whenever an assembled EntityForm is rendered. This typically occurs when viewing an entity in the admin or viewing an error state on a POST for that entity.

Parameters:

entityForm -

Throws:

Exception

modifyAddEntityForm

protected void modifyAddEntityForm(EntityForm entityForm,
                       Map<String,String> pathVars)

This method is invoked whenever an assembled EntityForm is rendered for the add entity screen.

Parameters:

entityForm -

attachSectionSpecificInfo

protected void attachSectionSpecificInfo(PersistencePackageRequest ppr,
                             Map<String,String> pathVars)

A hook method that is invoked every time the #getSectionPersistencePackageRequest(String) method is invoked. This allows specialized controllers to hook into every request and manipulate the persistence package request as desired.

Parameters:

ppr -

getStartIndex

protected Integer getStartIndex(Map<String,List<String>> requestParams)

Obtains the requested start index parameter

Parameters:

requestParams -

Returns:

getMaxIndex

protected Integer getMaxIndex(Map<String,List<String>> requestParams)

Obtains the requested max index parameter

Parameters:

requestParams -

Returns:

getMaxResults

protected Integer getMaxResults(Map<String,List<String>> requestParams)

Obtains the requested max index parameter

Parameters:

requestParams -

Returns:

setModelAttributes

protected void setModelAttributes(org.springframework.ui.Model model,
                      String sectionKey)

Attributes to add to the model on every request

Parameters:

model -

sectionKey -

getSectionPersistencePackageRequest

@Deprecated
protected PersistencePackageRequest getSectionPersistencePackageRequest(String sectionClassName,
                                                                       List<SectionCrumb> sectionCrumbs)

Deprecated. in favor of getSectionPersistencePackageRequest(String, List, Map)

getSectionPersistencePackageRequest

protected PersistencePackageRequest getSectionPersistencePackageRequest(String sectionClassName,
                                                            List<SectionCrumb> sectionCrumbs,
                                                            Map<String,String> pathVars)

Returns a PersistencePackageRequest for the given sectionClassName. Will also invoke the getSectionCustomCriteria() and attachSectionSpecificInfo(PersistencePackageRequest) to allow specialized controllers to manipulate the request for every action in this controller.

Parameters:

sectionClassName -

sectionCrumbs -

pathVars -

Returns:

getSectionPersistencePackageRequest

@Deprecated
protected PersistencePackageRequest getSectionPersistencePackageRequest(String sectionClassName,
                                                                       org.springframework.util.MultiValueMap<String,String> requestParams,
                                                                       List<SectionCrumb> sectionCrumbs)

Deprecated. in favor of getSectionPersistencePackageRequest(String, MultiValueMap, List, Map)

getSectionPersistencePackageRequest

protected PersistencePackageRequest getSectionPersistencePackageRequest(String sectionClassName,
                                                            org.springframework.util.MultiValueMap<String,String> requestParams,
                                                            List<SectionCrumb> sectionCrumbs,
                                                            Map<String,String> pathVars)

Returns the result of a call to #getSectionPersistencePackageRequest(String) with the additional filter and sort criteria attached.

Parameters:

sectionClassName -

filterAndSortCriteria -

Returns:

the PersistencePacakageRequest

getSectionCrumbs

protected List<SectionCrumb> getSectionCrumbs(javax.servlet.http.HttpServletRequest request,
                                  String currentSection,
                                  String currentSectionId)

populateJsonValidationErrors

protected JsonResponse populateJsonValidationErrors(EntityForm form,
                                        org.springframework.validation.BindingResult result,
                                        JsonResponse json)

Populates the given json response object based on the given form and result

Returns:

the same result that was passed in

translateErrorMessage

protected String translateErrorMessage(org.springframework.validation.ObjectError error)