Project Report: fawkez

Packagesummary org.jcoderz.commons.config

org.jcoderz.commons.config.ConfigurationServiceInterface

LineHitsNoteSource
1  /*
2   * $Id: ConfigurationServiceInterface.java 1067 2008-07-08 19:13:20Z amandel $
3   *
4   * Copyright 2006, The jCoderZ.org Project. All rights reserved.
5   *
6   * Redistribution and use in source and binary forms, with or without
7   * modification, are permitted provided that the following conditions are
8   * met:
9   *
10   *    * Redistributions of source code must retain the above copyright
11   *      notice, this list of conditions and the following disclaimer.
12   *    * Redistributions in binary form must reproduce the above
13   *      copyright notice, this list of conditions and the following
14   *      disclaimer in the documentation and/or other materials
15   *      provided with the distribution.
16   *    * Neither the name of the jCoderZ.org Project nor the names of
17   *      its contributors may be used to endorse or promote products
18   *      derived from this software without specific prior written
19   *      permission.
20   *
21   * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS "AS IS" AND
22   * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
24   * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS
25   * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
28   * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
29   * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
30   * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
31   * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32   */
33  package org.jcoderz.commons.config;
34  
35  import java.rmi.RemoteException;
36  
37  import org.jcoderz.commons.ArgumentMalformedException;
38  
39  /**
40   * ConfigurationService's business interface in order to fetch specific
41   * configuration data.
42   *
43   * On this level only primitive types String, int, long and boolean are used.
44   * The well formed and complex typed interfaces for the specific services are
45   * using this more simple interface.
46   *
47   * A factory method is provided to get the service specific typed interface.
48   * The service specific, well formed and typed interfaces and their
49   * implementation is generated by XSLT.
50   *
51   * For notifications of cache updates a registration for a ConfigurationListener
52   * is provided.
53   *
54   */
55 (1)public interface ConfigurationServiceInterface
56        extends ConfigurationServiceCommonInterface
57  {
58     /**
59      * gets the ServiceConfiguration interface related to the given
60      * *Service*Configuration classname.
61      * This is the factory method that is used in the generated Container and
62      * Client Factories for the given service.
63      *
64      * @param classname the service configuration interface classname (full
65      *       qualified) for which the ServiceConfiguration interface should be
66      *       created. The classname MUST include the complete package path.
67      * @return the related ServiceConfiguration instance
68      *
69      * @throws RemoteException if a remote call fails.
70      * @throws ArgumentMalformedException Is thrown to indicate the illegal use
71      *         of a null object as input parameter.
72      * @throws ConfigurationFactoryFailedException if no ServiceConfiguration
73      *       instance for the given application service could be found/created.
74      */
75     ServiceConfiguration getServiceConfiguration (
76           String classname)
77           throws RemoteException, ArgumentMalformedException,
78                 ConfigurationFactoryFailedException;
79  
80     /**
81      * ConfigurationListener instance that will be registered to receive
82      * notifications.
83      *
84      * @param listener ConfigurationListener instance that will be registered
85      *        to receive notifications.
86      * @throws RemoteException if a remote call fails.
87      * @throws ArgumentMalformedException Is thrown to indicate the illegal use
88      *         of a null object as input parameter.
89      */
90     void addConfigurationListener (ConfigurationListener listener)
91           throws RemoteException, ArgumentMalformedException;
92  
93  }

Findings in this File

c (1) 55 : 0 Type Javadoc comment is missing an @author tag.