com.communote.server.web.fe.admin

Class AdministrationMenuManager

java.lang.Object

com.communote.server.web.fe.admin.AdministrationMenuManager

@Service
public class AdministrationMenuManager
extends Object

Manager of the navigation menu of the administration section. The navigation menu consists of menu entries that point to the administration pages and categories that group these entries semantically.

The categories are distributed over two menus and an additional extension section. The two menus are the system and the account menu. The system menu is intended to hold entries to configure and administer the Communote installation (server settings, logging, ...). The account menu holds entries which are relevant to configure an account (aka a client in a non-standalone environment) like user or group management. When running a non-standalone version the system menu will only be available to the global client.

System and account menu can be extended with new categories and entries for the existing or new categories. Additionally filters can be added to include or exclude certain categories or entries in specific situations. Administration menu entries of extensions that should not be added to a category can just be added to the additional extension section.

Author:

Communote GmbH - http://www.communote.com/

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACCOUNT_CATEGORY_INTEGRATION
static String	ACCOUNT_CATEGORY_OVERVIEW
static String	ACCOUNT_CATEGORY_PROFILE
static String	ACCOUNT_CATEGORY_SECURITY
static String	ACCOUNT_CATEGORY_USER_MANAGEMENT
static String	SYSTEM_CATEGORY_APPLICATION
static String	SYSTEM_CATEGORY_COMMUNICATION
static String	SYSTEM_CATEGORY_CONTENT
static String	SYSTEM_CATEGORY_LOGGING

Constructor Summary

Constructors

Constructor and Description
AdministrationMenuManager()

Method Summary

Modifier and Type	Method and Description
void	addAccountMenuCategory(BasicMenuEntry category, PositionDescriptor positionDescriptor) Add a new category to the account menu.
void	addAccountMenuCategoryEntryFilter(MenuEntryFilter<AdministrationPageMenuEntry> filter) Add a filter that will be called when the system menu is built to decide whether a menu entry should be added to its category.
void	addAccountMenuCategoryFilter(MenuEntryFilter<BasicMenuEntry> filter) Add a filter that will be called when the account menu is built to decide whether a category should be included in the menu.
void	addSystemMenuCategory(BasicMenuEntry category, PositionDescriptor positionDescriptor) Same as addAccountMenuCategory(BasicMenuEntry, PositionDescriptor) except that the category is added to the system menu.
void	addSystemMenuCategoryEntryFilter(MenuEntryFilter<AdministrationPageMenuEntry> filter) Add a filter that will be called when the system menu is built to decide whether a menu entry should be added to its category.
void	addSystemMenuCategoryFilter(MenuEntryFilter<BasicMenuEntry> filter) Add a filter that will be called when the system menu is built to decide whether a category should be included in the menu.
void	addToAccountMenuCategory(String categoryId, AdministrationPageMenuEntry entry, PositionDescriptor positionDescriptor) Add a menu entry to a category of the account menu.
void	addToExtensionSection(AdministrationPageMenuEntry entry, PositionDescriptor positionDescriptor, boolean systemPage) Add an entry to the extension section.
void	addToSystemMenuCategory(String categoryId, AdministrationPageMenuEntry entry, PositionDescriptor positionDescriptor) Same as addToAccountMenuCategory(String, AdministrationPageMenuEntry, PositionDescriptor) except that the entry is added to a category of the system menu.
void	excludeAccountMenuEntryOnGlobalClient(String menuEntryId) Exclude a account menu entry if the menu is rendered on the global client.
SimpleMenu<BasicMenuEntry,AdministrationPageMenuEntry>	getAccountMenu()
AdministrationMenuEntryDetails	getCurrentEntry(javax.servlet.http.HttpServletRequest request) Return the entry that belongs to the current request.
AdministrationMenuEntryDetails	getEntry(String categoryId, String entryId) Get an entry of a given category.
CategoryEntry<BasicMenuEntry,AdministrationPageMenuEntry>	getExtensions()
SimpleMenu<BasicMenuEntry,AdministrationPageMenuEntry>	getSystemMenu()
protected void	init()
void	removeAccountMenuCategory(String categoryId) Remove a previously added category from the account menu.
void	removeAccountMenuCategoryEntryFilter(MenuEntryFilter<AdministrationPageMenuEntry> filter) Remove a previously added filter
void	removeAccountMenuCategoryFilter(MenuEntryFilter<BasicMenuEntry> filter) Remove a previously added filter
void	removeFromAccountMenuCategory(String categoryId, String entryId) Remove a previously added entry from a category of the account menu.
void	removeFromExtensionSection(String entryId)
void	removeFromSystemMenuCategory(String categoryId, String entryId) Remove a previously added entry from a category of the system menu.
void	removeSystemMenuCategory(String categoryId) Same as removeAccountMenuCategory(String) except that the category is removed from the system menu.
void	removeSystemMenuCategoryEntryFilter(MenuEntryFilter<AdministrationPageMenuEntry> filter) Remove a previously added filter
void	removeSystemMenuCategoryFilter(MenuEntryFilter<BasicMenuEntry> filter) Remove a previously added filter

Methods inherited from class java.lang.Object

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

Field Detail

SYSTEM_CATEGORY_CONTENT

public static final String SYSTEM_CATEGORY_CONTENT

See Also:

Constant Field Values

SYSTEM_CATEGORY_LOGGING

public static final String SYSTEM_CATEGORY_LOGGING

See Also:

Constant Field Values

SYSTEM_CATEGORY_COMMUNICATION

public static final String SYSTEM_CATEGORY_COMMUNICATION

See Also:

Constant Field Values

SYSTEM_CATEGORY_APPLICATION

public static final String SYSTEM_CATEGORY_APPLICATION

See Also:

Constant Field Values

ACCOUNT_CATEGORY_SECURITY

public static final String ACCOUNT_CATEGORY_SECURITY

See Also:

Constant Field Values

ACCOUNT_CATEGORY_INTEGRATION

public static final String ACCOUNT_CATEGORY_INTEGRATION

See Also:

Constant Field Values

ACCOUNT_CATEGORY_USER_MANAGEMENT

public static final String ACCOUNT_CATEGORY_USER_MANAGEMENT

See Also:

Constant Field Values

ACCOUNT_CATEGORY_PROFILE

public static final String ACCOUNT_CATEGORY_PROFILE

See Also:

Constant Field Values

ACCOUNT_CATEGORY_OVERVIEW

public static final String ACCOUNT_CATEGORY_OVERVIEW

See Also:

Constant Field Values

Constructor Detail

AdministrationMenuManager

public AdministrationMenuManager()

Method Detail

addAccountMenuCategory

public void addAccountMenuCategory(BasicMenuEntry category,
                                   PositionDescriptor positionDescriptor)

Add a new category to the account menu. If there is already a category with that ID the new one is ignored.

If called several times with position type TOP the categories which were added later will be positioned before those added earlier. If called several times with position type BOTTOM or AFTER (and the same menu entry ID to position after), the categories which were added later will be positioned after those added earlier. Entries with position type TOP are always before the BOTTOM positioned categories. Categories with position type AFTER will not appear in the resulting menu if the referenced category does not exist. However, if that referenced category is added later on, the categories to position after that category will than be contained in the menu.

To position after one of the core account menu categories the menu entry ID of the position descriptor can be set to one of the ACCOUNT_CATEGORY_* constants.

Parameters:

category - the category to add. The ID of the category must not be blank or contain whitespaces.

positionDescriptor - descriptor defining where the item should be added. If null the category will be added to the bottom.

Throws:

IllegalArgumentException - in case the ID of the category is not valid

addAccountMenuCategoryEntryFilter

public void addAccountMenuCategoryEntryFilter(MenuEntryFilter<AdministrationPageMenuEntry> filter)

Add a filter that will be called when the system menu is built to decide whether a menu entry should be added to its category.

Note: there is already a filter for excluding certain entries if the current client is not the global client. See excludeAccountMenuEntryOnGlobalClient(String)

Parameters:

filter - the filter to add

addAccountMenuCategoryFilter

public void addAccountMenuCategoryFilter(MenuEntryFilter<BasicMenuEntry> filter)

Add a filter that will be called when the account menu is built to decide whether a category should be included in the menu.

Parameters:

filter - the filter to add

addSystemMenuCategory

public void addSystemMenuCategory(BasicMenuEntry category,
                                  PositionDescriptor positionDescriptor)

Same as addAccountMenuCategory(BasicMenuEntry, PositionDescriptor) except that the category is added to the system menu.

To position after one of the core system menu categories the menu entry ID of the position descriptor can be set to one of the SYSTEM_CATEGORY_* constants.

Parameters:

category - the category to add. The ID of the category must not be blank or contain whitespaces.

positionDescriptor - descriptor defining where the item should be added. If null the category will be added to the bottom.

Throws:

IllegalArgumentException - in case the ID of the category is not valid

See Also:

addAccountMenuCategory(BasicMenuEntry, PositionDescriptor)

addSystemMenuCategoryEntryFilter

public void addSystemMenuCategoryEntryFilter(MenuEntryFilter<AdministrationPageMenuEntry> filter)

Add a filter that will be called when the system menu is built to decide whether a menu entry should be added to its category.

Parameters:

filter - the filter to add

addSystemMenuCategoryFilter

public void addSystemMenuCategoryFilter(MenuEntryFilter<BasicMenuEntry> filter)

Add a filter that will be called when the system menu is built to decide whether a category should be included in the menu.

Parameters:

filter - the filter to add

addToAccountMenuCategory

public void addToAccountMenuCategory(String categoryId,
                                     AdministrationPageMenuEntry entry,
                                     PositionDescriptor positionDescriptor)

Add a menu entry to a category of the account menu. If the category does not exist the entry won't be contained in the menu. But if the category is added later on this entry will be added automatically to the category.

If called several times with position type TOP the entries which were added later will be positioned before those added earlier. If called several times with position type BOTTOM or AFTER (and the same menu entry ID to position after), the entries which were added later will be positioned after those added earlier. Entries with position type TOP are always before the BOTTOM positioned entries. Entries with position type AFTER will not appear in the resulting menu if the referenced menu entry does not exist. However, if that referenced entry is added later on, the entries to position after that entry will than be contained in the category.

Parameters:

categoryId - the ID of the category. The ACCOUNT_CATEGORY_* constants can be used to add the entry to one of the core account menu categories.

entry - the entry to add. The URL of the entry has to start with /admin/ and the ID must not be blank or contain whitespaces otherwise an exception is thrown.

positionDescriptor - descriptor defining where the item should be added. If null the item will be added to the bottom

Throws:

IllegalArgumentException - in case the entry is not valid

addToExtensionSection

public void addToExtensionSection(AdministrationPageMenuEntry entry,
                                  PositionDescriptor positionDescriptor,
                                  boolean systemPage)

Add an entry to the extension section.

If called several times with position type TOP the entries which were added later will be positioned before those added earlier. If called several times with position type BOTTOM or AFTER (and the same menu entry ID to position after), the entries which were added later will be positioned after those added earlier. Entries with position type TOP are always before the BOTTOM positioned entries. Entries with position type AFTER will not appear in the resulting menu if the referenced menu entry does not exist. However, if that referenced entry is added later on, the entries to position after that entry will than be contained in the category.

Parameters:

entry - the entry to add. The URL of the entry has to start with /admin/ and the ID must not be blank or contain whitespaces otherwise an exception is thrown.

positionDescriptor - descriptor defining where the item should be added. If null the item will be added to the bottom

systemPage - true if the page is intended to configure or administer the installation, false if it is intended for the account. This is similar to the differentiation between system and account menu. With a non-standalone installation, a systemPage will only be included if it is rendered on the global client

Throws:

IllegalArgumentException - in case the entry is not valid

addToSystemMenuCategory

public void addToSystemMenuCategory(String categoryId,
                                    AdministrationPageMenuEntry entry,
                                    PositionDescriptor positionDescriptor)

Same as addToAccountMenuCategory(String, AdministrationPageMenuEntry, PositionDescriptor) except that the entry is added to a category of the system menu.

Parameters:

categoryId - the ID of the category. The SYSTEM_CATEGORY_* constants can be used to add the entry to one of the core system menu categories.

entry - the entry to add. The URL of the entry has to start with /admin/ and the ID must not be blank or contain whitespaces otherwise an exception is thrown.

positionDescriptor - descriptor defining where the item should be added. If null the item will be added to the bottom

Throws:

IllegalArgumentException - in case the entry is not valid

See Also:

addToAccountMenuCategory(String, AdministrationPageMenuEntry, PositionDescriptor)

excludeAccountMenuEntryOnGlobalClient

public void excludeAccountMenuEntryOnGlobalClient(String menuEntryId)

Exclude a account menu entry if the menu is rendered on the global client. This is a convenience function which will automatically add (and reuse) an appropriate filter.

Parameters:

menuEntryId - the ID of the menu entry to exclude

getAccountMenu

public SimpleMenu<BasicMenuEntry,AdministrationPageMenuEntry> getAccountMenu()

getCurrentEntry

public AdministrationMenuEntryDetails getCurrentEntry(javax.servlet.http.HttpServletRequest request)

Return the entry that belongs to the current request. The entry is retrieved by checking the URL of the current request to against the registered administration menu entries. If there is a match and the category exists the entry will be returned, even if it is not in the extensions, system or account menu as returned by their getters, because the filters are not applied.

Parameters:

request - the current request

Returns:

the entry or null if the request does not belong to a registered page

getEntry

public AdministrationMenuEntryDetails getEntry(String categoryId,
                                               String entryId)

Get an entry of a given category. This will also return entries which would be filtered out and thus would not be in the system or account menu or the extensions returned by their getters. However, if the category does not exist the entry is not returned.

Parameters:

categoryId - the ID of the category

entryId - the ID of the entry in the category

Returns:

the details of the entry or null if the entry or the category does not exist

getExtensions

public CategoryEntry<BasicMenuEntry,AdministrationPageMenuEntry> getExtensions()

Returns:

the administration menu entries that were added to the extensions section. Because of filtering the entries can be empty.

getSystemMenu

public SimpleMenu<BasicMenuEntry,AdministrationPageMenuEntry> getSystemMenu()

init

@PostConstruct
protected void init()

removeAccountMenuCategory

public void removeAccountMenuCategory(String categoryId)

Remove a previously added category from the account menu. The items that were added to that category are not removed but will instead just not be in the account menu. If the category is added again the items will also be contained in the menu again. The built-in core categories cannot be removed.

Parameters:

categoryId - the ID of the category to remove.

removeAccountMenuCategoryEntryFilter

public void removeAccountMenuCategoryEntryFilter(MenuEntryFilter<AdministrationPageMenuEntry> filter)

Remove a previously added filter

Parameters:

filter - the filter to remove

removeAccountMenuCategoryFilter

public void removeAccountMenuCategoryFilter(MenuEntryFilter<BasicMenuEntry> filter)

Remove a previously added filter

Parameters:

filter - the filter to remove

removeFromAccountMenuCategory

public void removeFromAccountMenuCategory(String categoryId,
                                          String entryId)

Remove a previously added entry from a category of the account menu.

Parameters:

categoryId - the ID of the category from which the entry should be removed

entryId - the ID of the entry to remove

removeFromExtensionSection

public void removeFromExtensionSection(String entryId)

removeFromSystemMenuCategory

public void removeFromSystemMenuCategory(String categoryId,
                                         String entryId)

Remove a previously added entry from a category of the system menu.

Parameters:

categoryId - the ID of the category from which the entry should be removed

entryId - the ID of the entry to remove

removeSystemMenuCategory

public void removeSystemMenuCategory(String categoryId)

Same as removeAccountMenuCategory(String) except that the category is removed from the system menu.

Parameters:

categoryId - the ID of the category to remove

removeSystemMenuCategoryEntryFilter

public void removeSystemMenuCategoryEntryFilter(MenuEntryFilter<AdministrationPageMenuEntry> filter)

Remove a previously added filter

Parameters:

filter - the filter to remove

removeSystemMenuCategoryFilter

public void removeSystemMenuCategoryFilter(MenuEntryFilter<BasicMenuEntry> filter)

Remove a previously added filter

Parameters:

filter - the filter to remove