KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > appserv > management > config > DeployedItemRefConfigCR


1 /*
2  * The contents of this file are subject to the terms
3  * of the Common Development and Distribution License
4  * (the License). You may not use this file except in
5  * compliance with the License.
6  *
7  * You can obtain a copy of the license at
8  * https://glassfish.dev.java.net/public/CDDLv1.0.html or
9  * glassfish/bootstrap/legal/CDDLv1.0.txt.
10  * See the License for the specific language governing
11  * permissions and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL
14  * Header Notice in each file and include the License file
15  * at glassfish/bootstrap/legal/CDDLv1.0.txt.
16  * If applicable, add the following below the CDDL Header,
17  * with the fields enclosed by brackets [] replaced by
18  * you own identifying information:
19  * "Portions Copyrighted [year] [name of copyright owner]"
20  *
21  * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
22  */
23  
24 /*
25  * $Header: /cvs/glassfish/admin-core/mbeanapi/src/java/com/sun/appserv/management/config/DeployedItemRefConfigCR.java,v 1.7 2006/03/09 20:30:23 llc Exp $
26  * $Revision: 1.7 $
27  * $Date: 2006/03/09 20:30:23 $
28  */
29 package com.sun.appserv.management.config;
30
31 import java.util.Map JavaDoc;
32
33
34 /**
35     Represents the capability to create or remove ("CR") an instance of
36     the <application-ref> element.
37 */
38 public interface DeployedItemRefConfigCR extends ConfigRemover
39 {
40     /** Key for use with createDeployedItemRefConfig() */
41     public final static String JavaDoc REF_KEY = "Ref";
42     /** Key for use with createDeployedItemRefConfig() */
43     public final static String JavaDoc ENABLED_KEY = "Enabled";
44     /** Key for use with createDeployedItemRefConfig() */
45     public final static String JavaDoc VIRTUAL_SERVERS_KEY = "VirtualServers";
46     
47     public final static String JavaDoc LB_ENABLED_KEY = "LBEnabled";
48
49     public final static String JavaDoc DISABLE_TIMEOUT_IN_MINUTES_KEY = "DisableTimeoutInMinutes";
50
51
52     /**
53         Creates a new application-ref element.
54
55         @param referencedApplicationName Application name.
56         @param optional Map of optional aattributes whose keys are defined here.
57         @return A proxy to the DeployedItemRefConfig MBean that manages the
58         config of newly created application-ref.
59      */
60     public DeployedItemRefConfig createDeployedItemRefConfig(
61         String JavaDoc referencedApplicationName, Map JavaDoc<String JavaDoc,String JavaDoc> optional);
62         
63     /**
64         Creates a new application-ref element.
65
66         @param enabled
67         @param referencedApplicationName Application name.
68         @param virtualServers Comma separated list of virtual servers.
69         @param lbEnabled
70         @param disableTimeoutInMinutes
71         @return A proxy to the DeployedItemRefConfig MBean that manages the
72         config of newly created application-ref.
73      */
74     public DeployedItemRefConfig createDeployedItemRefConfig(boolean enabled,
75         String JavaDoc referencedApplicationName, String JavaDoc virtualServers,
76         boolean lbEnabled, int disableTimeoutInMinutes);
77         
78     /**
79         Creates a new application-ref element.
80
81         @param referencedApplicationName Application name.
82         @return A proxy to the DeployedItemRefConfig MBean that manages the
83         config of newly created application-ref.
84      */
85     public DeployedItemRefConfig createDeployedItemRefConfig(String JavaDoc referencedApplicationName);
86     
87     /**
88      * Remove an existing &lt;application-ref&gt;
89      *
90      * @param referencedApplicationName the name of the application to remove
91      */
92     public void removeDeployedItemRefConfig( String JavaDoc referencedApplicationName );
93 }
94
Popular Tags