org.jboss.security.auth.login
Interface XMLLoginConfigMBean

All Superinterfaces:

Service (src) , ServiceMBean (src)

All Known Implementing Classes:

XMLLoginConfig (src)

public interface XMLLoginConfigMBean

extends ServiceMBean (src)

The managment bean interface for the XML based JAAS login configuration object.

getConfigURL

public java.net.URL getConfigURL()

Set the URL of the XML login configuration file that should be loaded by this mbean on startup.

setConfigURL

public void setConfigURL(java.net.URL configURL)

Set the URL of the XML login configuration file that should be loaded by this mbean on startup.

setConfigResource

public void setConfigResource(java.lang.String resourceName)
                       throws java.io.IOException

Set the resource name of the XML login configuration file that should be loaded by this mbean on startup.

Throws:

java.io.IOException

getValidateDTD

public boolean getValidateDTD()

Get whether the login config xml document is validated againsts its DTD

setValidateDTD

public void setValidateDTD(boolean flag)

Set whether the login config xml document is validated againsts its DTD

getPassSecurityDomainName

public boolean getPassSecurityDomainName()

setPassSecurityDomainName

public void setPassSecurityDomainName(boolean flag)

getConfiguration

public javax.security.auth.login.Configuration getConfiguration(javax.security.auth.login.Configuration prevConfig)

Get the XML based configuration given the Configuration it should delegate to when an application cannot be found.

addAppConfig

public void addAppConfig(java.lang.String appName,
                         javax.security.auth.login.AppConfigurationEntry[] entries)

Add an application login configuration. Any existing configuration for the given appName will be replaced.

removeAppConfig

public void removeAppConfig(java.lang.String appName)

Remove an application login configuration.

loadConfig

public java.lang.String[] loadConfig(java.net.URL configURL)
                              throws java.lang.Exception

Load the login configuration information from the given config URL.

Parameters:

configURL - A URL to an XML or Sun login config file.

Returns:

An array of the application config names loaded

Throws:

java.lang.Exception - on failure to load the configuration

removeConfigs

public void removeConfigs(java.lang.String[] appNames)

Remove the given login configurations. This invokes removeAppConfig for each element of appNames.

Parameters:

appNames - the names of the login configurations to remove.

displayAppConfig

public java.lang.String displayAppConfig(java.lang.String appName)

Display the login configuration for the given application.