ConfigurationValidatorMBean


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 to the Configuration Validator
15   *
16   * @phoenix:mx-topic name="ConfigurationValidator"
17   *
18   * @author <a HREF="mailto:proyal@apache.org">Peter Royal</a>
19   * @see ConfigurationValidator
20   */
21  public interface ConfigurationValidatorMBean
22  {
23      /**
24       * Get the schema type for the specified application and block. Returns
25       * null if no schema
26       *
27       * @param application to get schema for
28       * @param block to get schema for
29       * @return schema type, or null if none exists
30       * @phoenix:mx-operation
31       */
32      String   getSchemaType( final String   application, final String   block );
33  
34      /**
35       * Get the XML that represents the schema for the specified application and block.
36       * Returns null if no schema.
37       *
38       * @param application to get schema for
39       * @param block to get schema for
40       * @return schema as string, or null if none exists
41       * @phoenix:mx-operation
42       */
43      String   getSchema( final String   application, final String   block );
44  
45      /**
46       * Check to see if configuration is valid.
47       *
48       * @param application Application name
49       * @param block Block name to store configuration for
50       * @param configuration Configuration to check
51       *
52       * @return true if configuration is valid
53       *
54       * @throws ConfigurationException if no schema is found
55       *
56       * @see ConfigurationValidator#isValid
57       *
58       * @phoenix:mx-operation
59       */
60      boolean isValid( String   application, String   block, Configuration configuration )
61          throws ConfigurationException;
62  }
63
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags