1 /*
2 * Copyright (c) 2001-2004,
3 * RedVerst Group, ISP RAS http://www.ispras.ru
4 * 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 met:
8 *
9 * 1. Redistributions of source code must retain the above copyright notice, this
10 * list of conditions and the following disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above copyright notice,
13 * this list of conditions and the following disclaimer in the documentation
14 * and/or other materials provided with the distribution.
15 *
16 * 3. The names "ATP", "TreeDL", "RedVerst", "ISP RAS"
17 * may not be used to endorse or promote products derived from this software
18 * without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
22 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
23 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
24 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
25 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
26 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
27 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
29 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 */
31
32 package com.unitesk.atp.tool;
33
34 /***
35 * Plugin is a functionality extention module.
36 *
37 * @author <A href="mailto:demakov@ispras.ru">Alexey Demakov</A>
38 * @version $Id: Plugin.java,v 1.1 2004/10/09 06:43:21 all-x Exp $
39 */
40 public interface Plugin
41 {
42 /***
43 * Returns the type of plugin - action, attribute etc.
44 */
45 String getKind();
46
47 /***
48 * Returns plugin name.
49 *
50 * @return plugin name
51 */
52 String getName();
53
54 /***
55 * Returns plugin version.
56 */
57 String getVersion();
58
59 /***
60 * Links this plugin to the specified plugin manager.
61 * Must be called before plugin usage.
62 *
63 * @param pm The plugin manager to link plugin to.
64 * @param name The name of plugin.
65 */
66 void init( PluginManager pm, String name );
67
68 /***
69 * Returns plugin with the specified name. Any object can be plugin.
70 *
71 * @param name The name of plugin.
72 */
73 Object getPlugin( String name );
74
75 /***
76 * Gets the name of a system property for the specified plugin property.
77 *
78 * @param name The name of a plugin property.
79 * @return The name of a system property.
80 */
81 String getPropertyName( String name );
82
83 /***
84 * Gets the value of a plugin property with the specified name.
85 *
86 * @param name The name of a plugin property.
87 * @return The value of a plugin property with the specified name.
88 */
89 String getProperty( String name );
90
91 /***
92 * Gets the value of a plugin property with the specified name
93 * or the specified default value if this property is not defined.
94 *
95 * @param name The name of a plugin property.
96 * @param value The default value of a property.
97 * @return The value of a plugin property with the specified name.
98 */
99 String getProperty( String name, String value );
100
101 /***
102 * Gets plugin manager for this plugin.
103 *
104 * @return The plugin manager for this plugin
105 */
106 PluginManager getPluginManager();
107 }