KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > modules > j2ee > sun > bridge > apis > Controller


1 /*
2  * The contents of this file are subject to the terms of the Common Development
3  * and Distribution License (the License). You may not use this file except in
4  * compliance with the License.
5  *
6  * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7  * or http://www.netbeans.org/cddl.txt.
8  *
9  * When distributing Covered Code, include this CDDL Header Notice in each file
10  * and include the License file at http://www.netbeans.org/cddl.txt.
11  * If applicable, add the following below the CDDL Header, with the fields
12  * enclosed by brackets [] replaced by your own identifying information:
13  * "Portions Copyrighted [year] [name of copyright owner]"
14  *
15  * The Original Software is NetBeans. The Initial Developer of the Original
16  * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
17  * Microsystems, Inc. All Rights Reserved.
18  */

19 package org.netbeans.modules.j2ee.sun.bridge.apis;
20
21 import java.util.List JavaDoc;
22
23
24 /**
25  * A controller is responsible for acting as the bridge between Netbeans
26  * apis and the Sun Java Application Server AMX api for managment and monitoring.
27  * This allows for the decoupling of the data model (AMX) from the Netbeans
28  * node view.
29  */

30 public interface Controller {
31     
32     
33     /**
34      * Returns the properties of this controller in a java.util.Map.
35      *
36      * @propsToIgnore The String properties to ignore.
37      * @return All the properties for this controller.
38      */

39     public java.util.Map JavaDoc getProperties(List JavaDoc propsToIgnore);
40     
41     /**
42      * Sets a property given a name/value pair.
43      *
44      * @param attrName The name of the attribute to set.
45      * @param value The value of the attribute to set.
46      *
47      * @return the updated Attribute.
48      */

49     public javax.management.Attribute JavaDoc setProperty(final String JavaDoc attrName, final Object JavaDoc value);
50     
51     /**
52      * Returns the name of the component which this controller manages.
53      *
54      * @return The name of the component.
55      */

56     public String JavaDoc getName();
57     
58 }
59
Popular Tags