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.service.insert;
35  
36  import fr.paris.lutece.portal.service.util.AppLogService;
37  
38  import java.util.ArrayList;
39  import java.util.Collection;
40  import java.util.HashMap;
41  import java.util.List;
42  import java.util.Map;
43  
44  
45  /**
46   * Manager of the InsertServices (Insert + HTML). Responsible for (un)registering them.
47   */
48  public final class InsertServiceManager
49  {
50      ////////////////////////////////////////////////////////////////////////////
51      // Class attributes
52  
53      /** Insert Service registry */
54      private static Map<String, InsertService> _mapInsertServicesRegistry = new HashMap<String, InsertService>(  );
55  
56      ////////////////////////////////////////////////////////////////////////////
57      // Methods
58  
59      /**
60       * Creates a new InsertServiceManager object
61       */
62      private InsertServiceManager(  )
63      {
64      }
65  
66      /**
67       * Registers a new Index Service
68       *
69       * @param is the  service
70       */
71      public static void registerInsertService( InsertService is )
72      {
73          _mapInsertServicesRegistry.put( is.getId(  ), is );
74          AppLogService.info( "New Insert Service registered : " + is.getId(  ) );
75      }
76  
77      /**
78       * Returns all registered Insert services
79       *
80       * @return A collection containing all registered Insert services
81       */
82      public static Collection<InsertService> getInsertServicesList(  )
83      {
84          ArrayList<InsertService> listServices = new ArrayList<InsertService>(  );
85  
86          for ( InsertService service : _mapInsertServicesRegistry.values(  ) )
87          {
88              if ( service.isEnabled(  ) )
89              {
90                  listServices.add( service );
91              }
92          }
93  
94          return listServices;
95      }
96  
97      /**
98       * Get a particular Insert service
99       *
100      * @param strId Identifier of the seeked service
101      * @return the selected Insert service
102      */
103     public static InsertService getInsertService( String strId )
104     {
105         return _mapInsertServicesRegistry.get( strId );
106     }
107 
108     /**
109      * Returns the names of all registered Insert Service
110      *
111      * @return An enumeration containing the names of all registered Insert Service
112      */
113     public static List<String> getInsertsLabels(  )
114     {
115         List<String> listInserts = new ArrayList<String>(  );
116 
117         for ( InsertService ls : getInsertServicesList(  ) )
118         {
119             listInserts.add( ls.getLabelKey(  ) );
120         }
121 
122         return listInserts;
123     }
124 }