ExtendableResourceActionHit.java

  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.service.resource;

  35. import fr.paris.lutece.portal.service.spring.SpringContextService;

  36. import java.util.HashMap;
  37. import java.util.Map;
  38. import java.util.Map.Entry;

  39. /**
  40.  * Class to notify listeners of actions performed on resources. Listeners keep at least track of the number of actions performed over a given resource.
  41.  */
  42. public final class ExtendableResourceActionHit
  43. {
  44.     /**
  45.      * Download action
  46.      */
  47.     public static final String ACTION_DOWNLOAD = "download";

  48.     /**
  49.      * Creation action
  50.      */
  51.     public static final String ACTION_CREATION = "creation";

  52.     /**
  53.      * Update action
  54.      */
  55.     public static final String ACTION_UPDATE = "update";

  56.     /**
  57.      * Archive action
  58.      */
  59.     public static final String ACTION_ARCHIVE = "archive";

  60.     /**
  61.      * Delete action
  62.      */
  63.     public static final String ACTION_DELETE = "delete";
  64.     private static ExtendableResourceActionHit _instance = new ExtendableResourceActionHit( );

  65.     /**
  66.      * Private constructor
  67.      */
  68.     private ExtendableResourceActionHit( )
  69.     {
  70.     }

  71.     /**
  72.      * Get the service instance
  73.      *
  74.      * @return The instance of the service
  75.      */
  76.     public static ExtendableResourceActionHit getInstance( )
  77.     {
  78.         return _instance;
  79.     }

  80.     /**
  81.      * Get the total number of hit associated to a given action name and resource type
  82.      *
  83.      * @param strActionName
  84.      *            The name of the action to get the number of hit of
  85.      * @param strExtendableResourceType
  86.      *            The resource type to get the hit of
  87.      * @return The number of hit, or 0 if this action has no hit for this resource type
  88.      */
  89.     public int getActionHit( String strActionName, String strExtendableResourceType )
  90.     {
  91.         int nResult = 0;

  92.         for ( IExtendableResourceActionHitListener listener : SpringContextService.getBeansOfType( IExtendableResourceActionHitListener.class ) )
  93.         {
  94.             nResult += listener.getActionHit( strActionName, strExtendableResourceType );
  95.         }

  96.         return nResult;
  97.     }

  98.     /**
  99.      * Get the list of action names associated with a number of hit for a given resource
  100.      *
  101.      * @param strExtendableResourceId
  102.      *            The id of the resource
  103.      * @param strExtendableResourceType
  104.      *            The type of the resource
  105.      * @return A map containing associations between action names and hit number
  106.      */
  107.     public Map<String, Integer> getResourceHit( String strExtendableResourceId, String strExtendableResourceType )
  108.     {
  109.         Map<String, Integer> mapActionHit = new HashMap<>( );

  110.         for ( IExtendableResourceActionHitListener listener : SpringContextService.getBeansOfType( IExtendableResourceActionHitListener.class ) )
  111.         {
  112.             for ( Entry<String, Integer> entry : listener.getResourceHit( strExtendableResourceId, strExtendableResourceType ).entrySet( ) )
  113.             {
  114.                 if ( mapActionHit.containsKey( entry.getKey( ) ) )
  115.                 {
  116.                     mapActionHit.put( entry.getKey( ), mapActionHit.get( entry.getKey( ) ) + entry.getValue( ) );
  117.                 }
  118.                 else
  119.                 {
  120.                     mapActionHit.put( entry.getKey( ), entry.getValue( ) );
  121.                 }
  122.             }
  123.         }

  124.         return mapActionHit;
  125.     }

  126.     /**
  127.      * Get the number of hit associated with a resource and an action name
  128.      *
  129.      * @param strExtendableResourceId
  130.      *            The id of the resource
  131.      * @param strExtendableResourceType
  132.      *            The type of the resource
  133.      * @param strActionName
  134.      *            The name of the action
  135.      * @return The number of hit, or 0 if the resource has no hit for this action
  136.      */
  137.     public int getResourceActionHit( String strExtendableResourceId, String strExtendableResourceType, String strActionName )
  138.     {
  139.         int nResult = 0;

  140.         for ( IExtendableResourceActionHitListener listener : SpringContextService.getBeansOfType( IExtendableResourceActionHitListener.class ) )
  141.         {
  142.             nResult += listener.getResourceActionHit( strExtendableResourceId, strExtendableResourceType, strActionName );
  143.         }

  144.         return nResult;
  145.     }

  146.     /**
  147.      * Notify every listeners that an action has been performed on a resource
  148.      *
  149.      * @param strExtendableResourceId
  150.      *            The id of the resource the action was performed on
  151.      * @param strExtendableResourceType
  152.      *            The type of the resource the action was performed on
  153.      * @param strActionName
  154.      *            The name of the action that was performed on the resource. Action names can be any strings, but the class {@link ExtendableResourceActionHit}
  155.      *            exposes standard action names.
  156.      */
  157.     public void notifyActionOnResource( String strExtendableResourceId, String strExtendableResourceType, String strActionName )
  158.     {
  159.         for ( IExtendableResourceActionHitListener listener : SpringContextService.getBeansOfType( IExtendableResourceActionHitListener.class ) )
  160.         {
  161.             listener.notifyActionOnResource( strExtendableResourceId, strExtendableResourceType, strActionName );
  162.         }
  163.     }
  164. }