org.jboss.security.auth.login
Interface DynamicLoginConfigMBean

All Superinterfaces:
Service (src) , ServiceMBean (src)
All Known Implementing Classes:
DynamicLoginConfig (src)

public interface DynamicLoginConfigMBean
extends ServiceMBean (src)

The management interface for the DynamicLoginConfig service.


Field Summary
 
Fields inherited from interface org.jboss.system.ServiceMBean (src)
CREATE_EVENT, CREATED, DESTROY_EVENT, DESTROYED, FAILED, REGISTERED, START_EVENT, STARTED, STARTING, states, STOP_EVENT, STOPPED, STOPPING, UNREGISTERED
 
Method Summary
 void flushAuthenticationCaches()
          Flush the caches of the security domains that have been registered by this service.
 java.lang.String getAuthConfig()
          Get the resource path to the JAAS login configuration file to use.
 ObjectName (src) getLoginConfigService()
          Get the XMLLoginConfig service to use for loading.
 ObjectName (src) getSecurityManagerService()
          Get the SecurityManagerService used to flush the registered security domains.
 void setAuthConfig(java.lang.String authConf)
          Set the resource path to the JAAS login configuration file to use.
 void setLoginConfigService(ObjectName (src)  serviceName)
          Get the XMLLoginConfig service to use for loading.
 void setSecurityManagerService(ObjectName (src)  serviceName)
          Set the SecurityManagerService used to flush the registered security domains.
 
Methods inherited from interface org.jboss.system.ServiceMBean (src)
getName, getState, getStateString, jbossInternalLifecycle
 
Methods inherited from interface org.jboss.system.Service (src)
create, destroy, start, stop
 

Method Detail

getAuthConfig

public java.lang.String getAuthConfig()
Get the resource path to the JAAS login configuration file to use.


setAuthConfig

public void setAuthConfig(java.lang.String authConf)
Set the resource path to the JAAS login configuration file to use.

Parameters:
authConf - - the classpath resource to load.

getLoginConfigService

public ObjectName (src)  getLoginConfigService()
Get the XMLLoginConfig service to use for loading.

Returns:
the XMLLoginConfig service name.

setLoginConfigService

public void setLoginConfigService(ObjectName (src)  serviceName)
Get the XMLLoginConfig service to use for loading. This service must support a String[] loadConfig(URL) operation to load the configurations.

Parameters:
serviceName - - the XMLLoginConfig service name.

flushAuthenticationCaches

public void flushAuthenticationCaches()
                               throws java.lang.Exception
Flush the caches of the security domains that have been registered by this service.

Throws:
java.lang.Exception

getSecurityManagerService

public ObjectName (src)  getSecurityManagerService()
Get the SecurityManagerService used to flush the registered security domains.

Returns:
the SecurityManagerService service name.

setSecurityManagerService

public void setSecurityManagerService(ObjectName (src)  serviceName)
Set the SecurityManagerService used to flush the registered security domains. This service must support an flushAuthenticationCache(String) operation to flush the case for the argument security domain. Setting this triggers the flush of the authentication caches when the service is stopped.

Parameters:
serviceName - - the SecurityManagerService service name.