MainTreeMenuAllPagesCacheService.java

/*
 * Copyright (c) 2002-2025, City of Paris
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *  1. Redistributions of source code must retain the above copyright notice
 *     and the following disclaimer.
 *
 *  2. Redistributions in binary form must reproduce the above copyright notice
 *     and the following disclaimer in the documentation and/or other materials
 *     provided with the distribution.
 *
 *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
 *     contributors may be used to endorse or promote products derived from
 *     this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * License 1.0
 */
package fr.paris.lutece.plugins.menus.service.cache;

import fr.paris.lutece.portal.service.cache.AbstractCacheableService;

/**
 * Get the instance of the cache service
 */
public final class MainTreeMenuAllPagesCacheService extends AbstractCacheableService
{
	// Properties
	private static final String CACHE_NAME = "Plugin Menus - Main Tree Menu All Pages Cache";
	private static final String CACHE_KEY_MAIN_ALL_PAGES = "menus.main.allpages";
	private static final String CACHE_KEY_TREE_ALL_PAGES = "menus.tree.allpages";

	private static MainTreeMenuAllPagesCacheService _instance = new MainTreeMenuAllPagesCacheService( );

	/**
	 * Private constructor
	 */
	private MainTreeMenuAllPagesCacheService( )
	{
		super( );
		initCache( );
	}

	/**
	 * Get the instance of the cache service
	 * 
	 * @return The instance of the service
	 */
	public static MainTreeMenuAllPagesCacheService getInstance( )
	{
		return _instance;
	}

	/**
	 * Get the cache key for a given main menu
	 * 
	 * @return The cache key for the main
	 */
	public String getMainMenuCacheKey( )
	{
		return CACHE_KEY_MAIN_ALL_PAGES;
	}

	/**
	 * Get the cache key for a given menu tree with all pages
	 * 
	 * @param nCurrentPageId
	 *                       The id of the menu tree with all pages
	 * @return The cache key for the menu tree with all pages
	 */
	public String getMenuTreeCacheKey( int nCurrentPageId )
	{
		return CACHE_KEY_TREE_ALL_PAGES + nCurrentPageId;
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public String getName( )
	{
		return CACHE_NAME;
	}
}