KickJava   Java API By Example, From Geeks To Geeks.

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


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 package com.sun.appserv.management.config;
24
25 import java.util.Map JavaDoc;
26
27 import com.sun.appserv.management.base.XTypes;
28
29 import com.sun.appserv.management.base.Container;
30
31 /**
32     Configuration for the <message-security-config> element.
33 */
34 public interface MessageSecurityConfig
35     extends NamedConfigElement, Container
36 {
37 /** The j2eeType as returned by {@link com.sun.appserv.management.base.AMX#getJ2EEType}. */
38     public static final String JavaDoc J2EE_TYPE = XTypes.MESSAGE_SECURITY_CONFIG;
39
40     /** one of the legal values for auth-layer */
41     public static final String JavaDoc AUTH_LAYER_HTTP_SERVLET = "HttpServlet";
42     
43     /** one of the legal values for auth-layer */
44     public static final String JavaDoc AUTH_LAYER_SOAP = "SOAP";
45     
46     /**
47         One of the values defined by {@link MessageLayerValues}.
48      */
49     public String JavaDoc getAuthLayer();
50
51     public String JavaDoc getDefaultClientProvider();
52     public void setDefaultClientProvider( final String JavaDoc value );
53
54     public String JavaDoc getDefaultProvider();
55     public void setDefaultProvider( final String JavaDoc value );
56     
57     
58     /**
59      Create a new <provider-config>
60      <p>
61     Client providers must implement the <em>com.sun.enterprise.security.jauth.ClientAuthModule</em>
62     interface.
63     <p>
64     Server-side providers must implement the
65     <emcom.sun.enterprise.security.jauth.ServerAuthModule</em interface.
66     <p>
67     A provider may implement both interfaces, but it must implement the
68     interface corresponding to its provider type.
69     <p>
70     For example, default providers include:
71     <ul>
72     <li>com.sun.xml.wss.provider.ClientSecurityAuthModule</li>
73     <li>com.sun.xml.wss.provider.ServerSecurityAuthModule</li>
74     </ul>
75
76      @param providerId choose a self-explanatory and unique name for the provider
77      @param providerType either {@link ProviderConfig#PROVIDER_TYPE_CLIENT} or {@link ProviderConfig#PROVIDER_TYPE_SERVER}
78      @param className classname for the provider
79      @param reservedForFutureUse placeholder for future attributes
80
81      @return The proxy to the ProviderConfig MBean.
82     */
83     public ProviderConfig createProviderConfig(String JavaDoc providerId, String JavaDoc providerType,
84         String JavaDoc className, Map JavaDoc<String JavaDoc,String JavaDoc> reservedForFutureUse);
85
86
87     /**
88      Removes an existing provider config.
89          
90      @param providerId the id of the provider config to be removed.
91     */
92     public void removeProviderConfig(String JavaDoc providerId);
93
94     /**
95         @return A map of ProviderConfig MBean proxies keyed on provider-id.
96      */
97     public Map JavaDoc<String JavaDoc,ProviderConfig> getProviderConfigMap();
98 }
99
Popular Tags