org.jboss.security.auth.login
Interface XMLLoginConfigMBean

All Superinterfaces:

org.jboss.system.Service, org.jboss.system.ServiceMBean

All Known Implementing Classes:

XMLLoginConfig

public interface XMLLoginConfigMBean
extends org.jboss.system.ServiceMBean

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

Version:

$Revision: 57203 $

Author:

Scott.Stark@jboss.org

Field Summary

Fields inherited from interface org.jboss.system.ServiceMBean

CREATE_EVENT, CREATED, DESTROY_EVENT, DESTROYED, FAILED, REGISTERED, START_EVENT, STARTED, STARTING, states, STOP_EVENT, STOPPED, STOPPING, UNREGISTERED

Method Summary

void	addAppConfig(String appName, AppConfigurationEntry[] entries) Add an application login configuration.
String	displayAppConfig(String appName) Display the login configuration for the given application.
Configuration	getConfiguration(Configuration prevConfig) Get the XML based configuration given the Configuration it should delegate to when an application cannot be found.
URL	getConfigURL() Set the URL of the XML login configuration file that should be loaded by this mbean on startup.
boolean	getPassSecurityDomainName()
boolean	getValidateDTD() Get whether the login config xml document is validated againsts its DTD
String[]	loadConfig(URL configURL) Load the login configuration information from the given config URL.
void	removeAppConfig(String appName) Remove an application login configuration.
void	removeConfigs(String[] appNames) Remove the given login configurations.
void	setConfigResource(String resourceName) Set the resource name of the XML login configuration file that should be loaded by this mbean on startup.
void	setConfigURL(URL configURL) Set the URL of the XML login configuration file that should be loaded by this mbean on startup.
void	setPassSecurityDomainName(boolean flag)
void	setValidateDTD(boolean flag) Set whether the login config xml document is validated againsts its DTD

Methods inherited from interface org.jboss.system.ServiceMBean

getName, getState, getStateString, jbossInternalLifecycle

Methods inherited from interface org.jboss.system.Service

create, destroy, start, stop

Method Detail

getConfigURL

URL getConfigURL()

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

setConfigURL

void setConfigURL(URL configURL)

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

setConfigResource

void setConfigResource(String resourceName)
                       throws IOException

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

Throws:

IOException

getValidateDTD

boolean getValidateDTD()

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

setValidateDTD

void setValidateDTD(boolean flag)

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

getPassSecurityDomainName

boolean getPassSecurityDomainName()

setPassSecurityDomainName

void setPassSecurityDomainName(boolean flag)

getConfiguration

Configuration getConfiguration(Configuration prevConfig)

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

addAppConfig

void addAppConfig(String appName,
                  AppConfigurationEntry[] entries)

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

removeAppConfig

void removeAppConfig(String appName)

Remove an application login configuration.

loadConfig

String[] loadConfig(URL configURL)
                    throws 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:

Exception - on failure to load the configuration

removeConfigs

void removeConfigs(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

String displayAppConfig(String appName)

Display the login configuration for the given application.