WebModule


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/j2ee/WebModule.java,v 1.5 2006/01/31 02:44:06 llc Exp $
26   * $Revision: 1.5 $
27   * $Date: 2006/01/31 02:44:06 $
28   */
29   
30  package com.sun.appserv.management.j2ee;
31  
32  import java.util.Map  ;
33  
34  import com.sun.appserv.management.base.Container;
35  
36  /**
37      A J2EE WebModule. Extends the J2EE management model with
38      additional product-specific Attributes and operations.
39      <br>
40      The monitoring peer as returned from getMonitoringPeer() is
41      {@link com.sun.appserv.management.monitor.WebModuleVirtualServerMonitor}
42   */
43  public interface WebModule extends J2EEModule, Container
44  {
45      public final static String    J2EE_TYPE   = J2EETypes.WEB_MODULE;
46      
47      /**
48          Note that the Attribute name is case-sensitive
49          "servlets" as defined by JSR 77.
50       */
51      public String  [] getservlets();
52      
53      /**
54       */
55      public Map  <String  ,Servlet>  getServletMap();
56      
57      
58      /**
59          Allow symlinking to outside the webapp root directory,
60          if the webapp is an exploded directory
61      */
62      public boolean  getAllowLinking();
63      /**
64          Allow symlinking to outside the webapp root directory,
65          if the webapp is an exploded directory
66      */
67      public void setAllowLinking( final boolean value );
68  
69      /**
70          Maximum cache size in KB
71      */
72      public int  getCacheMaxSize();
73      /**
74          Maximum cache size in KB
75      */
76      public void setCacheMaxSize( final int value );
77  
78      /**
79          Time interval in ms between cache refeshes
80      */
81      public int  getCacheTTL();
82      /**
83          Time interval in ms between cache refeshes
84      */
85      public void setCacheTTL( final int value );
86  
87      /**
88          Should we cache static resources for this webapp
89      */
90      public boolean  getCachingAllowed();
91      /**
92          Should we cache static resources for this webapp
93      */
94      public void setCachingAllowed( final boolean value );
95  
96      /**
97          Should case sensitivity checks be performed
98      */
99      public boolean  getCaseSensitive();
100     /**
101         Should case sensitivity checks be performed
102     */
103     public void setCaseSensitive( final boolean value );
104 
105     /**
106         Object names of all children
107     public ObjectName[] getChildren();
108     */
109 
110     /**
111         The compiler classpath to use
112     */
113     public String     getCompilerClasspath();
114     /**
115         The compiler classpath to use
116     */
117     public void setCompilerClasspath( final String   value );
118 
119     /**
120         Should we attempt to use cookies for session id communication?
121     */
122     public boolean  getCookies();
123     /**
124         Should we attempt to use cookies for session id communication?
125     */
126     public void setCookies( final boolean value );
127 
128     /**
129         Should we allow the ServletContext.getContext() method
130         to access the context of other web applications in this server?
131     */
132     public boolean  getCrossContext();
133     /**
134         Should we allow the ServletContext.getContext() method
135         to access the context of other web applications in this server?
136     */
137     public void setCrossContext( final boolean value );
138 
139     /**
140         The debugging detail level for this component
141     */
142     public int  getDebug();
143     /**
144         The debugging detail level for this component
145     */
146     public void setDebug( final int value );
147 
148     /**
149         Location of the default web.xml resource or file
150     */
151     public String     getDefaultWebXML();
152 
153     /**
154         The document root for this web application
155     */
156     public String     getDocBase();
157 
158     /**
159         An array of URL addresses defined in this Web Module to invoke web services endpoints implementations
160     */
161     public String  [] getEndpointAddresses();
162 
163     /**
164         Name of the engine domain, if different from the context domain
165     */
166     public String     getEngineName();
167     /**
168         Name of the engine domain, if different from the context domain
169     */
170     public void setEngineName( final String   value );
171 
172     /**
173         True if the web module implements web services endpoints
174     */
175     public boolean  getHasWebServices();
176 
177     /**
178         The frequency of the manager checks (expiration and passivation)
179     */
180     public int  getManagerChecksFrequency();
181     /**
182         The frequency of the manager checks (expiration and passivation)
183     */
184     public void setManagerChecksFrequency( final int value );
185 
186     /**
187         Type of the modeled resource. Can be set only once
188     */
189     public String     getModelerType();
190 
191     /**
192         The DefaultContext override flag for this web application
193     */
194     public boolean  getOverride();
195     /**
196         The DefaultContext override flag for this web application
197     */
198     public void setOverride( final boolean value );
199 
200     /**
201         The context path for this Context
202     */
203     public String     getPath();
204     /**
205         The context path for this Context
206     */
207     public void setPath( final String   value );
208 
209     /**
210         The reloadable flag for this web application
211     */
212     public boolean  getReloadable();
213     /**
214         The reloadable flag for this web application
215     */
216     public void setReloadable( final boolean value );
217 
218     /**
219          Names of all the defined resource references for this application.
220     */
221     public String  [] getResourceNames();
222 
223     /**
224         Startup time for this context
225     */
226     public long getStartupTime();
227 
228     /**
229         Flag to set to cause the system.out and system.err to be redirected to the logger when executing a servlet
230     */
231     public boolean  getSwallowOutput();
232     /**
233         Flag to set to cause the system.out and system.err to be redirected to the logger when executing a servlet
234     */
235     public void setSwallowOutput( final boolean value );
236 
237     /**
238         Time spend scanning jars for TLDs for this context
239     */
240     public long getTLDScanTime();
241     /**
242         Time spend scanning jars for TLDs for this context
243     */
244     public void setTLDScanTime( final long value );
245 
246     /**
247         Create a JNDI naming context for this application?
248     */
249     public boolean  getUseNaming();
250     /**
251         Create a JNDI naming context for this application?
252     */
253     public void setUseNaming( final boolean value );
254 
255     /**
256         The welcome files for this context
257     */
258     public String  [] getWelcomeFiles();
259 
260     /**
261         The pathname to the work directory for this context
262     */
263     public String     getWorkDir();
264 
265 
266 // -------------------- Operations --------------------
267 
268     /**
269     */
270     public void reload();
271 }
272
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags