org.mule.runtime.core.api.security

Interface SecurityManager

All Superinterfaces:

org.mule.runtime.api.lifecycle.Initialisable

All Known Implementing Classes:

DefaultMuleSecurityManager

public interface SecurityManager
extends org.mule.runtime.api.lifecycle.Initialisable

SecurityManager is responsible for managing one or more SecurityProviders.

Since:

4.0

Field Summary

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

PHASE_NAME

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()
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 interface org.mule.runtime.api.lifecycle.Initialisable

initialise

Method Detail

authenticate

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

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

void addProvider(SecurityProvider provider)

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

Parameters:

provider - the new SecurityProvider

getProvider

SecurityProvider getProvider(String name)

Returns:

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

See Also:

NamedObject.getName()

removeProvider

SecurityProvider removeProvider(String name)

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

Parameters:

name - the NamedObject.getName() to remove

Returns:

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

getProviders

Collection<SecurityProvider> getProviders()

Returns:

all the SecurityProviders managed by this SecurityManager

setProviders

void setProviders(Collection<SecurityProvider> providers)

Sets the available SecurityProviders for authentication.

Parameters:

providers - the providers available for this SecurityManager

createSecurityContext

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.

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

EncryptionStrategy getEncryptionStrategy(String name)

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

void addEncryptionStrategy(EncryptionStrategy strategy)

Adds the EncryptionStrategy to the ones available from this SecurityManager

Parameters:

strategy - the EncryptionStrategy to be added

removeEncryptionStrategy

EncryptionStrategy removeEncryptionStrategy(String name)

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

Parameters:

name - the NamedObject.getName() to remove

Returns:

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

getEncryptionStrategies

Collection<EncryptionStrategy> getEncryptionStrategies()

Returns:

all the EncryptionStrategys managed by this SecurityManager

setEncryptionStrategies

void setEncryptionStrategies(Collection<EncryptionStrategy> strategies)

Sets the available encryption strategies for this SecurityManager.

Parameters:

strategies - the prstrategiesoviders available for this EncryptionStrategy