Tomcat5MBean


1   /*
2    * JBoss, the OpenSource WebOS
3    *
4    * Distributable under LGPL license.
5    * See terms of license at gnu.org.
6    */
7   package org.jboss.web.tomcat.tc5;
8   
9   import org.jboss.web.AbstractWebContainerMBean;
10  import org.jboss.security.plugins.JaasSecurityManagerServiceMBean;
11  
12  /**
13   * An implementation of the AbstractWebContainer for the Jakarta Tomcat5
14   * servlet container. It has no code dependency on tomcat - only the new JMX
15   * model is used.
16   * <p/>
17   * Tomcat5 is organized as a set of mbeans - just like jboss.
18   *
19   * @author Scott.Stark@jboss.org
20   * @author Costin Manolache
21   * @version $Revision: 1.12.2.4 $
22   * @see AbstractWebContainerMBean
23   */
24  public interface Tomcat5MBean extends AbstractWebContainerMBean
25  {
26     /** JMX notification type to signal after-start connector event */ 
27     public final String   TOMCAT_CONNECTORS_STARTED  = "jboss.tomcat.connectors.started";
28     
29     /**
30      * @return the jmx domain for the tomcat management mbeans
31      */
32     public String   getDomain();
33  
34     /**
35      * The most important attribute - defines the managed domain.
36      * A catalina instance (engine) corresponds to a JMX domain, that's
37      * how we know where to deploy webapps.
38      *
39      * @param domainName the jmx domain under which tc registers
40      */
41     public void setDomain(String   domainName);
42  
43     /**
44      * Set the snapshot mode in a clustered environment
45      */
46     public void setSnapshotMode(String   mode);
47  
48     /**
49      * Get the snapshot mode in a clustered environment
50      */
51     public String   getSnapshotMode();
52  
53     /**
54      * Set the snapshot interval in ms for the interval snapshot mode
55      */
56     public void setSnapshotInterval(int interval);
57  
58     /**
59      * Get the snapshot interval
60      */
61     public int getSnapshotInterval();
62  
63     /**
64      * Get the clustering code cache behaviour
65      */
66     public boolean isUseLocalCache();
67  
68     /**
69      * Set the clustering code cache behaviour
70      */
71     public void setUseLocalCache(boolean useLocalCache);
72  
73     /**
74      * Get the clustering code failover behaviour whether MOD_JK(2) is used or not.
75      */
76     public boolean isUseJK();
77  
78     /**
79      * Set the clustering code failover behaviour whether MOD_JK(2) is used or not.
80      */
81     public void setUseJK(boolean useJK);
82  
83     /**
84      * The SessionIdAlphabet is the set of characters used to create a session Id
85      */
86     public void setSessionIdAlphabet(String   sessionIdAlphabet);
87  
88     /**
89      * The SessionIdAlphabet is the set of characters used to create a session Id
90      */
91     public String   getSessionIdAlphabet();
92     
93     /**
94      * Gets the JMX object name of a shared TreeCache to be used for clustered
95      * single-sign-on.
96      *
97      * @see org.jboss.web.tomcat.tc5.sso.TreeCacheSSOClusterManager
98      */
99     public String   getCacheName();
100 
101    /**
102     * Gets the JMX object name of a shared TreeCache to be used for clustered
103     * single-sign-on.
104     * <p/>
105     * <b>NOTE:</b> TreeCache must be deployed before this service.
106     *
107     * @see org.jboss.web.tomcat.tc5.sso.TreeCacheSSOClusterManager
108     */
109    public void setCacheName(String   cacheName);
110 
111    /**
112     * Get the JBoss UCL use flag
113     */
114    public boolean getUseJBossWebLoader();
115 
116    /**
117     * Set the JBoss UCL use flag
118     */
119    public void setUseJBossWebLoader(boolean flag);
120 
121    public String   getManagerClass();
122 
123    public void setManagerClass(String   managerClass);
124 
125    /** */
126    public String   getContextMBeanCode();
127 
128    /** */
129    public void setContextMBeanCode(String   className);
130 
131    /**
132     * Get the name of the external tomcat server configuration file.
133     *
134     * @return the config file name, server.xml for example
135     */
136    public String   getConfigFile();
137 
138    /**
139     * Set the name of the external tomcat server configuration file.
140     *
141     * @param configFile - the config file name, server.xml for example
142     */
143    public void setConfigFile(String   configFile);
144 
145    /**
146     * Get the request attribute name under which the JAAS Subject is store
147     */
148    public String   getSubjectAttributeName();
149 
150    /**
151     * Set the request attribute name under which the JAAS Subject will be
152     * stored when running with a security mgr that supports JAAS. If this is
153     * empty then the Subject will not be store in the request.
154     *
155     * @param name the HttpServletRequest attribute name to store the Subject
156     */
157    public void setSubjectAttributeName(String   name);
158 
159    /**
160     * Start all connectors of the Domain + ":type=Service,serviceName=jboss.web"
161     * service.
162     *
163     * @throws Exception
164     */
165    public void startConnectors() throws Exception  ;
166 
167    /**
168     * Stop all connectors of the Domain + ":type=Service,serviceName=jboss.web"
169     * service.
170     *
171     * @throws Exception
172     */
173    public void stopConnectors() throws Exception  ;
174 
175    /**
176     * Get whether web-apps are able to control the privileged flag
177     */
178    public boolean isAllowSelfPrivilegedWebApps();
179 
180    /**
181     * Set whether web-apps are able to control the privileged flag
182     */
183    public void setAllowSelfPrivilegedWebApps(boolean flag);
184 
185    /** Set the SecurityManagerService binding. This is used to flush any
186     * associated authentication cache on session invalidation.
187     * @param mgr the JaasSecurityManagerServiceMBean
188     */ 
189    public void setSecurityManagerService(JaasSecurityManagerServiceMBean mgr);
190 
191    /**
192     * 
193     * @return
194     */ 
195    public String  [] getFilteredPackages();
196    /**
197     * 
198     * @param pkgs
199     */ 
200    public void setFilteredPackages(String  [] pkgs);
201 }
202
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags