org.jboss.security.plugins
Interface JaasSecurityManagerServiceMBean

All Superinterfaces:

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

All Known Implementing Classes:

JaasSecurityManagerService

public interface JaasSecurityManagerServiceMBean
extends org.jboss.system.ServiceMBean, SecurityManagerMBean

The management interface for the JaasSecurityManagerService mbean.

Version:

$Revision: 1.14.6.4 $

Author:

Scott.Stark@jboss.org

Field Summary

static javax.management.ObjectName

OBJECT_NAME

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	flushAuthenticationCache(String securityDomain) Flush the authentication cache associated with the given securityDomain.
void	flushAuthenticationCache(String securityDomain, Principal user) Flush a principal's authentication cache entry associated with the given securityDomain.
String	getAuthenticationCacheJndiName() Get the jndi name under which the authentication CachePolicy implenentation is found
List	getAuthenticationCachePrincipals(String securityDomain) The the list of active Principls for the given security domain
String	getCallbackHandlerClassName() Get the default CallbackHandler implementation class name
boolean	getDeepCopySubjectMode() A flag indicating if the Deep Copy of Subject Sets should be enabled in the security managers
int	getDefaultCacheResolution() Get the default timed cache policy resolution.
int	getDefaultCacheTimeout() Get the default timed cache policy timeout.
String	getDefaultUnauthenticatedPrincipal() Get the default unauthenticated principal.
String	getSecurityManagerClassName() Get the name of the class that provides the security manager implementation.
String	getSecurityProxyFactoryClassName() Get the name of the class that provides the SecurityProxyFactory implementation.
boolean	getServerMode() A flag indicating if the SecurityAssociation.setServer should be called on service startup.
void	registerSecurityDomain(String securityDomain, SecurityDomain instance) Register a SecurityDomain implmentation
void	setAuthenticationCacheJndiName(String jndiName) Set the location of the security credential cache policy.
void	setCacheTimeout(String securityDomain, int timeoutInSecs, int resInSecs) Set the indicated security domain cache timeout.
void	setCallbackHandlerClassName(String className) Set the default CallbackHandler implementation class name
void	setDeepCopySubjectMode(boolean flag) A flag indicating if the Deep Copy of Subject Sets should be enabled in the security managers
void	setDefaultCacheResolution(int resInSecs) Set the default timed cache policy resolution.
void	setDefaultCacheTimeout(int timeoutInSecs) Set the default timed cache policy timeout.
void	setDefaultUnauthenticatedPrincipal(String principal) Set the default unauthenticated principal.
void	setSecurityManagerClassName(String className) Set the name of the class that provides the security manager implementation.
void	setSecurityProxyFactoryClassName(String className) Set the name of the class that provides the SecurityProxyFactory implementation.
void	setServerMode(boolean flag) The SecurityAssociation server mode flag.

Methods inherited from interface org.jboss.system.ServiceMBean

getName, getState, getStateString, jbossInternalLifecycle

Methods inherited from interface org.jboss.system.Service

create, destroy, start, stop

Methods inherited from interface org.jboss.security.plugins.SecurityManagerMBean

doesUserHaveRole, getPrincipal, getUserRoles, isValid

Field Detail

OBJECT_NAME

static final javax.management.ObjectName OBJECT_NAME

Method Detail

getDeepCopySubjectMode

boolean getDeepCopySubjectMode()

A flag indicating if the Deep Copy of Subject Sets should be enabled in the security managers

setDeepCopySubjectMode

void setDeepCopySubjectMode(boolean flag)

A flag indicating if the Deep Copy of Subject Sets should be enabled in the security managers

Parameters:

flag -

getServerMode

boolean getServerMode()

A flag indicating if the SecurityAssociation.setServer should be called on service startup.

Returns:

the SecurityAssociation.setServer flag.

setServerMode

void setServerMode(boolean flag)

The SecurityAssociation server mode flag.

Parameters:

flag - - A flag indicating if the SecurityAssociation.setServer should be called on service startup.

getSecurityManagerClassName

String getSecurityManagerClassName()

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

setSecurityManagerClassName

void setSecurityManagerClassName(String className)
                                 throws ClassNotFoundException,
                                        ClassCastException

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

Throws:

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

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

getSecurityProxyFactoryClassName

String getSecurityProxyFactoryClassName()

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

setSecurityProxyFactoryClassName

void setSecurityProxyFactoryClassName(String className)
                                      throws ClassNotFoundException

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

Throws:

ClassNotFoundException

getCallbackHandlerClassName

String getCallbackHandlerClassName()

Get the default CallbackHandler implementation class name

Returns:

The fully qualified classname of the

setCallbackHandlerClassName

void setCallbackHandlerClassName(String className)
                                 throws ClassNotFoundException

Set the default CallbackHandler implementation class name

Throws:

ClassNotFoundException

See Also:

CallbackHandler

getAuthenticationCacheJndiName

String getAuthenticationCacheJndiName()

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

setAuthenticationCacheJndiName

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

int getDefaultCacheTimeout()

Get the default timed cache policy timeout.

Returns:

the default cache timeout in seconds.

setDefaultCacheTimeout

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

int getDefaultCacheResolution()

Get the default timed cache policy resolution.

setDefaultCacheResolution

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

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

void flushAuthenticationCache(String securityDomain)

Flush the authentication cache associated with the given securityDomain.

Parameters:

securityDomain - the name of the security domain cache

flushAuthenticationCache

void flushAuthenticationCache(String securityDomain,
                              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

List getAuthenticationCachePrincipals(String securityDomain)

The the list of active Principls for the given security domain

Parameters:

securityDomain -

Returns:

List of active users, may be null.

registerSecurityDomain

void registerSecurityDomain(String securityDomain,
                            SecurityDomain instance)

Register a SecurityDomain implmentation

getDefaultUnauthenticatedPrincipal

String getDefaultUnauthenticatedPrincipal()

Get the default unauthenticated principal.

Returns:

The principal name

setDefaultUnauthenticatedPrincipal

void setDefaultUnauthenticatedPrincipal(String principal)

Set the default unauthenticated principal.

Parameters:

principal - The principal name