KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > avalon > phoenix > interfaces > ConfigurationRepositoryMBean


1 /*
2  * Copyright (C) The Apache Software Foundation. All rights reserved.
3  *
4  * This software is published under the terms of the Apache Software License
5  * version 1.1, a copy of which has been included with this distribution in
6  * the LICENSE.txt file.
7  */
8 package org.apache.avalon.phoenix.interfaces;
9
10 import org.apache.avalon.framework.configuration.Configuration;
11 import org.apache.avalon.framework.configuration.ConfigurationException;
12
13 /**
14  * Management interface for a Configuration Repository
15  *
16  * @phoenix:mx-topic name="ConfigurationRepository"
17  *
18  * @author <a HREF="mailto:proyal@apache.org">Peter Royal</a>
19  * @see ConfigurationRepository
20  */
21 public interface ConfigurationRepositoryMBean
22 {
23     /**
24      * Retrieve configuration information from the repository
25      *
26      * @param application Application name
27      * @param block Block name to get configuration for
28      *
29      * @return Configuration information
30      *
31      * @throws ConfigurationException if no configuration could be found
32      *
33      * @phoenix:mx-operation
34      */
35     Configuration getConfiguration( String JavaDoc application, String JavaDoc block )
36         throws ConfigurationException;
37
38     /**
39      * Store configuration information in the repository
40      *
41      * @param application Application name
42      * @param block Block name to store configuration for
43      * @param configuration information to store.
44      *
45      * @throws ConfigurationException if configuration could not be stored
46      *
47      * @phoenix:mx-operation
48      */
49     void storeConfiguration( String JavaDoc application,
50                              String JavaDoc block,
51                              Configuration configuration )
52         throws ConfigurationException;
53
54     /**
55      * Check to see if the repository has configuration information for the specified
56      * application and block
57      *
58      * @param application Application name
59      * @param block Block name to check configuration for
60      *
61      * @return true if repository has configuration
62      *
63      * @phoenix:mx-operation
64      */
65     boolean hasConfiguration( String JavaDoc application, String JavaDoc block );
66 }
67
Popular Tags