View Javadoc
1   /*
2    * Copyright (c) 2002-2014, Mairie de 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.web.xpages;
35  
36  import fr.paris.lutece.portal.service.cache.AbstractCacheableService;
37  import fr.paris.lutece.portal.service.page.PageEvent;
38  import fr.paris.lutece.portal.service.page.PageEventListener;
39  import fr.paris.lutece.portal.service.page.PageService;
40  
41  
42  /**
43   * SiteMapCacheService
44   */
45  public final class SiteMapCacheService extends AbstractCacheableService implements PageEventListener
46  {
47      private static final String SERVICE_NAME = "SiteMapService";
48      private static SiteMapCacheService _instance = new SiteMapCacheService(  );
49  
50      /**
51       * Private constructor
52       */
53      private SiteMapCacheService(  )
54      {
55          initCache(  );
56          PageService.addPageEventListener( this );
57      }
58  
59      /**
60       * Get the instance of the cache service
61       * @return The instance of the cache service
62       */
63      public static SiteMapCacheService getInstance(  )
64      {
65          return _instance;
66      }
67  
68      /**
69       * Returns the service name
70       * @return The service name
71       */
72      @Override
73      public String getName(  )
74      {
75          return SERVICE_NAME;
76      }
77  
78      @Override
79      public void processPageEvent( PageEvent event )
80      {
81          // page was added, removed or updated; clear cache
82          resetCache(  );
83      }
84  }