XMLLoginConfigMBean


1   /*
2   * JBoss, the OpenSource J2EE webOS
3   *
4   * Distributable under LGPL license.
5   * See terms of license at gnu.org.
6   */
7   package org.jboss.security.auth.login;
8   
9   import java.io.IOException  ;
10  import java.net.URL  ;
11  import javax.security.auth.login.AppConfigurationEntry  ;
12  import javax.security.auth.login.Configuration  ;
13  
14  import org.jboss.system.ServiceMBean;
15  
16  /** The managment bean interface for the XML based JAAS login configuration
17   object.
18  
19  @author  Scott.Stark@jboss.org
20  @version $Revision: 1.5.6.1 $
21   */
22  public interface XMLLoginConfigMBean extends ServiceMBean
23  {
24     /** Set the URL of the XML login configuration file that should
25      be loaded by this mbean on startup.
26      */
27     public URL   getConfigURL();
28     /** Set the URL of the XML login configuration file that should
29      be loaded by this mbean on startup.
30      */
31     public void setConfigURL(URL   configURL);
32  
33     /** Set the resource name of the XML login configuration file that should
34      be loaded by this mbean on startup.
35      */
36     public void setConfigResource(String   resourceName) throws IOException  ;
37  
38     /** Get whether the login config xml document is validated againsts its DTD
39      */
40     public boolean getValidateDTD();
41     /** Set whether the login config xml document is validated againsts its DTD
42      */
43     public void setValidateDTD(boolean flag);
44  
45     public boolean getPassSecurityDomainName();
46     public void setPassSecurityDomainName(boolean flag);
47  
48     /** Get the XML based configuration given the Configuration it should
49      delegate to when an application cannot be found.
50      */
51     public Configuration   getConfiguration(Configuration   prevConfig);
52  
53     /** Add an application login configuration. Any existing configuration for
54      the given appName will be replaced.
55      */
56     public void addAppConfig(String   appName, AppConfigurationEntry  [] entries);
57     /** Remove an application login configuration.
58      */
59     public void removeAppConfig(String   appName);
60  
61     /** Load the login configuration information from the given config URL.
62      * @param configURL A URL to an XML or Sun login config file.
63      * @return An array of the application config names loaded
64      * @throws Exception on failure to load the configuration
65      */ 
66     public String  [] loadConfig(URL   configURL) throws Exception  ;
67     /** Remove the given login configurations. This invokes removeAppConfig
68      * for each element of appNames.
69      * 
70      * @param appNames the names of the login configurations to remove. 
71      */ 
72     public void removeConfigs(String  [] appNames);
73  
74     /** Display the login configuration for the given application.
75      */
76     public String   displayAppConfig(String   appName);
77  }
78  
79
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags