KickJava   Java API By Example, From Geeks To Geeks.

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


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/ProviderConfig.java,v 1.4.2.1 2006/09/21 22:49:13 ne110415 Exp $
26  * $Revision: 1.4.2.1 $
27  * $Date: 2006/09/21 22:49:13 $
28  */
29
30
31 package com.sun.appserv.management.config;
32
33 import java.util.Map JavaDoc;
34
35 import com.sun.appserv.management.base.XTypes;
36 import com.sun.appserv.management.base.Container;
37
38 /**
39      Configuration for the <provider-config> element.
40 */
41
42 public interface ProviderConfig
43     extends NamedConfigElement, PropertiesAccess, Container
44 {
45 /** The j2eeType as returned by {@link com.sun.appserv.management.base.AMX#getJ2EEType}. */
46     public static final String JavaDoc J2EE_TYPE = XTypes.PROVIDER_CONFIG;
47     
48     /** Key for use with {@link #createRequestPolicyConfig} and {@link #createResponsePolicyConfig}*/
49     public static final String JavaDoc AUTH_SOURCE_KEY = "AuthSource";
50     
51     /** Key for use with {@link #createRequestPolicyConfig} and {@link #createResponsePolicyConfig}*/
52     public static final String JavaDoc AUTH_RECIPIENT_KEY = "AuthRecipient";
53
54     /** */
55     public static final String JavaDoc PROVIDER_TYPE_CLIENT = "client";
56     
57     /** */
58     public static final String JavaDoc PROVIDER_TYPE_SERVER = "server";
59     
60     public String JavaDoc getClassName();
61     public void setClassName( final String JavaDoc value );
62
63     public String JavaDoc getProviderId();
64
65     /** Returns {@link #PROVIDER_TYPE_CLIENT} or {@link #PROVIDER_TYPE_SERVER} */
66     public String JavaDoc getProviderType();
67     
68     /** Use {@link #PROVIDER_TYPE_CLIENT} or {@link #PROVIDER_TYPE_SERVER} */
69     public void setProviderType( final String JavaDoc value );
70
71 // -------------------- Operations --------------------
72 /**
73         Creates new request-policy-config element.
74
75         @param optional Map of optional attributes whose keys are defined here.
76         (eg:- AUTH_RECIPIENT_KEY)
77         @return A proxy to the RequestPolicyConfig MBean.
78      */
79     public RequestPolicyConfig createRequestPolicyConfig( Map JavaDoc<String JavaDoc,String JavaDoc> optional );
80
81     /**
82         Removes request-policy-config element.
83      */
84     public void removeRequestPolicyConfig();
85
86     /**
87         Get the RequestPolicyConfig MBean.
88      */
89     RequestPolicyConfig getRequestPolicyConfig();
90
91     /**
92         Creates new response-policy-config element.
93
94         @param optional Map of optional attributes whose keys are defined here.
95         (eg:- AUTH_RECIPIENT_KEY)
96         @return A proxy to the ResponsePolicyConfig MBean.
97      */
98     public ResponsePolicyConfig createResponsePolicyConfig( Map JavaDoc<String JavaDoc,String JavaDoc> optional );
99
100     /**
101         Removes response-policy-config element.
102      */
103     public void removeResponsePolicyConfig();
104
105     /**
106         Get the ResponsePolicyConfig MBean.
107      */
108     ResponsePolicyConfig getResponsePolicyConfig();
109
110
111
112 }
113
Popular Tags