org.mule.runtime.core.security

Class DefaultMuleSecurityManager

java.lang.Object

org.mule.runtime.core.security.DefaultMuleSecurityManager

All Implemented Interfaces:

org.mule.runtime.api.lifecycle.Initialisable, SecurityManager

public class DefaultMuleSecurityManager
extends Object
implements SecurityManager

DefaultMuleSecurityManager is a default implementation of a SecurityManager for a Mule instance.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	LOGGER logger used by this class

Fields inherited from interface org.mule.runtime.api.lifecycle.Initialisable

PHASE_NAME

Constructor Summary

Constructors

Constructor and Description
DefaultMuleSecurityManager()

Method Summary

Modifier and Type	Method and Description
void	addEncryptionStrategy(EncryptionStrategy strategy) Adds the EncryptionStrategy to the ones available from this SecurityManager
void	addProvider(SecurityProvider provider) Adds a SecurityProvider to the set of available providers for authentication.
org.mule.runtime.api.security.Authentication	authenticate(org.mule.runtime.api.security.Authentication authentication) Performs the authentication of a security request using one of the available SecurityProviders
SecurityContext	createSecurityContext(org.mule.runtime.api.security.Authentication authentication) Uses one of the available SecurityProviders that SecurityProvider.supports(java.lang.Class<?>) the given Authentication to create a new security context.
Collection<EncryptionStrategy>	getEncryptionStrategies()
EncryptionStrategy	getEncryptionStrategy(String name)
SecurityProvider	getProvider(String name)
Collection<SecurityProvider>	getProviders()
void	initialise()
EncryptionStrategy	removeEncryptionStrategy(String name) Removes the EncryptionStrategy with the given name from the set of managed EncryptionStrategys
SecurityProvider	removeProvider(String name) Removes the SecurityProvider with the given name from the pool of managed SecurityProviders
void	setEncryptionStrategies(Collection<EncryptionStrategy> strategies) Sets the available encryption strategies for this SecurityManager.
void	setProviders(Collection<SecurityProvider> providers) Sets the available SecurityProviders for authentication.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOGGER

protected static final org.slf4j.Logger LOGGER

logger used by this class

Constructor Detail

DefaultMuleSecurityManager

public DefaultMuleSecurityManager()

Method Detail

initialise

public void initialise()
                throws org.mule.runtime.api.lifecycle.InitialisationException

Specified by:

initialise in interface org.mule.runtime.api.lifecycle.Initialisable

Throws:

org.mule.runtime.api.lifecycle.InitialisationException

authenticate

public org.mule.runtime.api.security.Authentication authenticate(org.mule.runtime.api.security.Authentication authentication)
                                                          throws org.mule.runtime.api.security.SecurityException,
                                                                 org.mule.runtime.api.security.SecurityProviderNotFoundException

Performs the authentication of a security request using one of the available SecurityProviders

Specified by:

authenticate in interface SecurityManager

Parameters:

authentication - The Authentication request

Returns:

The authenticated response

Throws:

org.mule.runtime.api.security.SecurityException - In case authentication fails

org.mule.runtime.api.security.SecurityProviderNotFoundException

See Also:

SecurityProvider.authenticate(Authentication), Authentication.isAuthenticated()

addProvider

public void addProvider(SecurityProvider provider)

Adds a SecurityProvider to the set of available providers for authentication.

Specified by:

addProvider in interface SecurityManager

Parameters:

provider - the new SecurityProvider

getProvider

public SecurityProvider getProvider(String name)

Specified by:

getProvider in interface SecurityManager

Returns:

a SecurityProvider managed by this SecurityManager with the given name or null if none was found

See Also:

NamedObject.getName()

removeProvider

public SecurityProvider removeProvider(String name)

Removes the SecurityProvider with the given name from the pool of managed SecurityProviders

Specified by:

removeProvider in interface SecurityManager

Parameters:

name - the NamedObject.getName() to remove

Returns:

the SecurityProvider with the given name, or null if none was found

getProviders

public Collection<SecurityProvider> getProviders()

Specified by:

getProviders in interface SecurityManager

Returns:

all the SecurityProviders managed by this SecurityManager

setProviders

public void setProviders(Collection<SecurityProvider> providers)

Sets the available SecurityProviders for authentication.

Specified by:

setProviders in interface SecurityManager

Parameters:

providers - the providers available for this SecurityManager

createSecurityContext

public SecurityContext createSecurityContext(org.mule.runtime.api.security.Authentication authentication)
                                      throws org.mule.runtime.api.security.UnknownAuthenticationTypeException

Uses one of the available SecurityProviders that SecurityProvider.supports(java.lang.Class<?>) the given Authentication to create a new security context.

Specified by:

createSecurityContext in interface SecurityManager

Parameters:

authentication - the Authentication used to create the new SecurityContext

Returns:

a new SecurityContext created by the SecurityProvider with the given authentication

Throws:

org.mule.runtime.api.security.UnknownAuthenticationTypeException - if no SecurityProvider is found that SecurityProvider.supports(java.lang.Class<?>) the given authentication

getEncryptionStrategy

public EncryptionStrategy getEncryptionStrategy(String name)

Specified by:

getEncryptionStrategy in interface SecurityManager

Parameters:

name - the name of the EncryptionStrategy that needs to be retrieved.

Returns:

the EncryptionStrategy with the given name, from the ones available in this SecurityManager

addEncryptionStrategy

public void addEncryptionStrategy(EncryptionStrategy strategy)

Adds the EncryptionStrategy to the ones available from this SecurityManager

Specified by:

addEncryptionStrategy in interface SecurityManager

Parameters:

strategy - the EncryptionStrategy to be added

removeEncryptionStrategy

public EncryptionStrategy removeEncryptionStrategy(String name)

Removes the EncryptionStrategy with the given name from the set of managed EncryptionStrategys

Specified by:

removeEncryptionStrategy in interface SecurityManager

Parameters:

name - the NamedObject.getName() to remove

Returns:

the EncryptionStrategy with the given name, or null if none was found

getEncryptionStrategies

public Collection<EncryptionStrategy> getEncryptionStrategies()

Specified by:

getEncryptionStrategies in interface SecurityManager

Returns:

all the EncryptionStrategys managed by this SecurityManager

setEncryptionStrategies

public void setEncryptionStrategies(Collection<EncryptionStrategy> strategies)

Sets the available encryption strategies for this SecurityManager.

Specified by:

setEncryptionStrategies in interface SecurityManager

Parameters:

strategies - the prstrategiesoviders available for this EncryptionStrategy