org.broadleafcommerce.openadmin.server.security.service.navigation

Interface AdminNavigationService

All Known Implementing Classes:

AdminNavigationServiceImpl

public interface AdminNavigationService

Method Summary

Methods

Modifier and Type	Method and Description
AdminMenu	buildMenu(AdminUser adminUser)
boolean	checkPermissions(Set<String> authorizedPermissionNames, String permissionName)
AdminSection	findAdminSectionByClassAndSectionId(Class<?> clazz, String sectionId) In some cases, a single class is served by more than one section.
AdminSection	findAdminSectionByClassAndSectionId(String className, String sectionId) In some cases, a single class is served by more than one section.
AdminSection	findAdminSectionBySectionKey(String sectionKey)
AdminSection	findAdminSectionByURI(String uri)
List<AdminSection>	findAllAdminSections() Gets all of the AdminSections in the system, sorted by the AdminSection.getDisplayOrder()
String	getClassNameForSection(String sectionKey) Gets the fully qualified ceiling entity classname for this section.
List<SectionCrumb>	getSectionCrumbs(String crumbList) Utility method for parsing a delimitted section crumb list (usually the "sectionCrumbs" parameter on the HttpServletRequest).
boolean	isUserAuthorizedToViewModule(AdminUser adminUser, AdminModule module)
boolean	isUserAuthorizedToViewSection(AdminUser adminUser, AdminSection section)
void	remove(AdminSection adminSection)
AdminSection	save(AdminSection adminSection)

Method Detail

buildMenu

AdminMenu buildMenu(AdminUser adminUser)

isUserAuthorizedToViewSection

boolean isUserAuthorizedToViewSection(AdminUser adminUser,
                                    AdminSection section)

isUserAuthorizedToViewModule

boolean isUserAuthorizedToViewModule(AdminUser adminUser,
                                   AdminModule module)

findAdminSectionByURI

AdminSection findAdminSectionByURI(String uri)

findAdminSectionBySectionKey

AdminSection findAdminSectionBySectionKey(String sectionKey)

findAdminSectionByClassAndSectionId

AdminSection findAdminSectionByClassAndSectionId(String className,
                                               String sectionId)

In some cases, a single class is served by more than one section.

Parameters:

className -

sectionId -

Returns:

findAdminSectionByClassAndSectionId

AdminSection findAdminSectionByClassAndSectionId(Class<?> clazz,
                                               String sectionId)

In some cases, a single class is served by more than one section.

Parameters:

className -

sectionId -

Returns:

findAllAdminSections

List<AdminSection> findAllAdminSections()

Gets all of the AdminSections in the system, sorted by the AdminSection.getDisplayOrder()

Returns:

the list of all AdminSections sorted by AdminSection.getDisplayOrder()

save

AdminSection save(AdminSection adminSection)

remove

void remove(AdminSection adminSection)

checkPermissions

boolean checkPermissions(Set<String> authorizedPermissionNames,
                       String permissionName)

getClassNameForSection

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

getSectionCrumbs

List<SectionCrumb> getSectionCrumbs(String crumbList)

Utility method for parsing a delimitted section crumb list (usually the "sectionCrumbs" parameter on the HttpServletRequest). Should return a list of SectionCrumb instances used to identify the different, currently active admin sections.

Parameters:

crumbList - delimitted string of section identifiers

Returns:

currently active admin sections in the order specified in the crumbList param