org.jboss.security.plugins
Interface JaasSecurityManagerServiceMBean

All Superinterfaces:

SecurityManagerMBean (src) , Service (src) , ServiceMBean (src)

All Known Implementing Classes:

JaasSecurityManagerService (src)

public interface JaasSecurityManagerServiceMBean

extends ServiceMBean (src) , SecurityManagerMBean (src)

The management interface for the JaasSecurityManagerService mbean.

OBJECT_NAME

public static final ObjectName (src)  OBJECT_NAME

getSecurityManagerClassName

public java.lang.String getSecurityManagerClassName()

Get the name of the class that provides the security manager implementation.

setSecurityManagerClassName

public void setSecurityManagerClassName(java.lang.String className)
                                 throws java.lang.ClassNotFoundException,
                                        java.lang.ClassCastException

Set the name of the class that provides the security manager implementation.

Throws:

java.lang.ClassNotFoundException - thrown if the className cannot be found using the thread context class loader.

java.lang.ClassCastException - thrown if the className does not implement the org.jboss.security.AuthenticationManager interface.

getSecurityProxyFactoryClassName

public java.lang.String getSecurityProxyFactoryClassName()

Get the name of the class that provides the SecurityProxyFactory implementation.

setSecurityProxyFactoryClassName

public void setSecurityProxyFactoryClassName(java.lang.String className)
                                      throws java.lang.ClassNotFoundException

Set the name of the class that provides the SecurityProxyFactory implementation.

Throws:

java.lang.ClassNotFoundException

getCallbackHandlerClassName

public java.lang.String getCallbackHandlerClassName()

Get the default CallbackHandler implementation class name

Returns:

The fully qualified classname of the

setCallbackHandlerClassName

public void setCallbackHandlerClassName(java.lang.String className)
                                 throws java.lang.ClassNotFoundException

Set the default CallbackHandler implementation class name

Throws:

java.lang.ClassNotFoundException

See Also:

CallbackHandler

getAuthenticationCacheJndiName

public java.lang.String getAuthenticationCacheJndiName()

Get the jndi name under which the authentication CachePolicy implenentation is found

setAuthenticationCacheJndiName

public void setAuthenticationCacheJndiName(java.lang.String jndiName)

Set the location of the security credential cache policy. This is first treated as a ObjectFactory location that is capable of returning CachePolicy instances on a per security domain basis by appending a '/security-domain-name' string to this name when looking up the CachePolicy for a domain. If this fails then the location is treated as a single CachePolicy for all security domains.

Parameters:

jndiName - the name to the ObjectFactory or CachePolicy binding.

getDefaultCacheTimeout

public int getDefaultCacheTimeout()

Get the default timed cache policy timeout.

Returns:

the default cache timeout in seconds.

setDefaultCacheTimeout

public void setDefaultCacheTimeout(int timeoutInSecs)

Set the default timed cache policy timeout. This has no affect if the AuthenticationCacheJndiName has been changed from the default value.

Parameters:

timeoutInSecs - the cache timeout in seconds.

getDefaultCacheResolution

public int getDefaultCacheResolution()

Get the default timed cache policy resolution.

setDefaultCacheResolution

public void setDefaultCacheResolution(int resInSecs)

Set the default timed cache policy resolution. This has no affect if the AuthenticationCacheJndiName has been changed from the default value.

Parameters:

resInSecs - resolution of timeouts in seconds.

setCacheTimeout

public void setCacheTimeout(java.lang.String securityDomain,
                            int timeoutInSecs,
                            int resInSecs)

Set the indicated security domain cache timeout. This only has an effect if the security domain is using the default jboss TimedCachePolicy implementation.

Parameters:

securityDomain - the name of the security domain cache

timeoutInSecs - - the cache timeout in seconds.

resInSecs - - resolution of timeouts in seconds.

flushAuthenticationCache

public void flushAuthenticationCache(java.lang.String securityDomain)

Flush the authentication cache associated with the given securityDomain.

Parameters:

securityDomain - the name of the security domain cache

flushAuthenticationCache

public void flushAuthenticationCache(java.lang.String securityDomain,
                                     java.security.Principal user)

Flush a principal's authentication cache entry associated with the given securityDomain.

Parameters:

securityDomain - the name of the security domain cache

user - the principal of the user to flush

getAuthenticationCachePrincipals

public java.util.List getAuthenticationCachePrincipals(java.lang.String securityDomain)

The the list of active Principls for the given security domain

Parameters:

securityDomain -

Returns:

List of active users, may be null.

registerSecurityDomain

public void registerSecurityDomain(java.lang.String securityDomain,
                                   SecurityDomain (src)  instance)

Register a SecurityDomain implmentation

getDefaultUnauthenticatedPrincipal

public java.lang.String getDefaultUnauthenticatedPrincipal()

Get the default unauthenticated principal.

Returns:

The principal name

setDefaultUnauthenticatedPrincipal

public void setDefaultUnauthenticatedPrincipal(java.lang.String principal)

Set the default unauthenticated principal.

Parameters:

principal - The principal name