1 /*
2 * Copyright (c) 2002-2022, City of Paris
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright notice
10 * and the following disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above copyright notice
13 * and the following disclaimer in the documentation and/or other materials
14 * provided with the distribution.
15 *
16 * 3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 *
32 * License 1.0
33 */
34 package fr.paris.lutece.portal.business.user.menu;
35
36 import javax.servlet.http.HttpServletRequest;
37
38 import fr.paris.lutece.portal.service.spring.SpringContextService;
39
40 /**
41 * Base class for admin user menu item providers.
42 *
43 * Considers the item provider origin plugin state to decide if it is invoked
44 *
45 * @since 6.2.0
46 */
47 public abstract class AbstractAdminUserMenuItemProvider implements IAdminUserMenuItemProvider
48 {
49
50 private String _strName;
51
52 @Override
53 public final void setName( String strName )
54 {
55 _strName = strName;
56 }
57
58 @Override
59 public final String getName( )
60 {
61 return _strName;
62 }
63
64 @Override
65 public final boolean isInvoked( HttpServletRequest request )
66 {
67 return SpringContextService.isBeanEnabled( getName( ) ) && isItemProviderInvoked( request );
68 }
69
70 /**
71 * Should this item provider be included for the request.
72 *
73 * This is only called if the plugin declaring this item provider is active.
74 *
75 * @param request
76 * the request
77 * @return <code>true</code> if this item provider should be included, <code>false</code> otherwise
78 */
79 protected abstract boolean isItemProviderInvoked( HttpServletRequest request );
80
81 }