KickJava   Java API By Example, From Geeks To Geeks.

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


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/WebModuleConfig.java,v 1.5 2005/12/25 03:50:12 tcfujii Exp $
26  * $Revision: 1.5 $
27  * $Date: 2005/12/25 03:50:12 $
28  */
29
30 package com.sun.appserv.management.config;
31
32 import java.util.Map JavaDoc;
33
34 import com.sun.appserv.management.base.XTypes;
35 import com.sun.appserv.management.base.Container;
36
37 /**
38      Configuration for the <web-module> element.
39 */
40
41 public interface WebModuleConfig
42     extends ModuleConfig, Libraries, Container, WebServiceEndpointConfigCR
43 {
44 /** The j2eeType as returned by {@link com.sun.appserv.management.base.AMX#getJ2EEType}. */
45     public static final String JavaDoc J2EE_TYPE = XTypes.WEB_MODULE_CONFIG;
46     
47     /**
48     The ContextRoot must match the pattern for the hpath production
49     in RFC 1738 which can be found at:
50     http://www.w3.org/Addressing/rfc1738.txt. This is flattened
51     to the following regular expression in XML Schema's pattern
52     language:
53
54     <pre>
55     ([a-zA-Z0-9$\-_.+!*'(),]|%[0-9A-Fa-f][0-9A-Fa-f]|;|:|&|=)*(/([
56     -zA-Z0-9$\-_.+!*'(),]|%[0-9A-Fa-f][0-9A-Fa-f]|;|:|&|=)*)*
57     </pre>
58       
59     Note that this includes the null or empty context root and
60     permits but does not require a context root to start with the
61     '/' character (including a context root which is simply the
62     '/' character).
63     @see #setContextRoot
64     */
65       
66     public String JavaDoc getContextRoot();
67     
68     /**
69     @see #getContextRoot
70     */
71     public void setContextRoot( String JavaDoc value );
72
73     /**
74         Controls whether availability is enabled
75         for HTTP Session Persistence. If this is "false", then all
76         session persistence is disabled for the given web module. If
77         it is "true" (and providing that all the availability-enabled
78         attributes above in precedence are also "true", then the web
79         module may be ha enabled. Finer-grained control exists at
80         lower level (see sun-web.xml).
81
82         @see #setAvailabilityEnabled
83      */
84     public boolean getAvailabilityEnabled();
85
86     /**
87         @see #getAvailabilityEnabled
88     */
89     public void setAvailabilityEnabled( boolean enabled );
90     
91     public Map JavaDoc<String JavaDoc,WebServiceEndpointConfig> getWebServiceEndpointConfigMap();
92 }
93
Popular Tags