View Javadoc
1   /*
2    * Copyright (c) 2002-2017, 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.plugins.jsr168.pluto.xml;
35  
36  import org.apache.pluto.portalImpl.util.Properties;
37  
38  
39  /**
40   * Java bean to map the service configuration file<br>
41   * Map a service definition
42   */
43  public class ServiceXML
44  {
45      private final String _strServiceBase;
46      private final String _strImplementation;
47      private final Properties _properties;
48  
49      /**
50       * Default service definition constructor
51       *
52       * @param serviceBase The service base class where service must be registred
53       * @param implementation The implementation class
54       */
55      ServiceXML( String serviceBase, String implementation )
56      {
57          _strServiceBase = serviceBase;
58          _strImplementation = implementation;
59          _properties = new Properties(  );
60      }
61  
62      /**
63       * Add a property to service definition<br>
64       * Used to build the definition
65       *
66       * @param name Name of the property
67       * @param value Value of the property
68       */
69      void addProperty( String name, String value )
70      {
71          _properties.add( name, value );
72      }
73  
74      /**
75       * Return the service base class where service must be registred
76       *
77       * @return the service base class where service must be registred
78       */
79      public String getServiceBase(  )
80      {
81          return _strServiceBase;
82      }
83  
84      /**
85       * Return the implementation class
86       *
87       * @return the implementation class
88       */
89      public String getImplementation(  )
90      {
91          return _strImplementation;
92      }
93  
94      /**
95       * Properties associated to the plugin
96       *
97       * @return Properties associated to the plugin
98       */
99      public Properties getProperties(  )
100     {
101         return _properties;
102     }
103 }