org.mule.runtime.core.api.security

Interface SecurityProvider

All Superinterfaces:

org.mule.runtime.api.meta.NameableObject, org.mule.runtime.api.meta.NamedObject

public interface SecurityProvider
extends org.mule.runtime.api.meta.NameableObject

SecurityProvider is a target security provider that actually does the work of authenticating credentials and populating the Authentication object.

Since:

4.0

Method Summary

Modifier and Type	Method and Description
org.mule.runtime.api.security.Authentication	authenticate(org.mule.runtime.api.security.Authentication authentication) Performs the authentication of a security request based either on the security realm configured in the Authentication request or the default realm for the current context
org.mule.runtime.api.security.SecurityContext	createSecurityContext(org.mule.runtime.api.security.Authentication auth) Creates the security context for this security provider
boolean	supports(Class<?> aClass) Checks if the class of authentication is supported by this security provider

Methods inherited from interface org.mule.runtime.api.meta.NameableObject

setName

Methods inherited from interface org.mule.runtime.api.meta.NamedObject

getName

Method Detail

authenticate

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

Performs the authentication of a security request based either on the security realm configured in the Authentication request or the default realm for the current context

Parameters:

authentication - The Authentication request

Returns:

The authenticated response

Throws:

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

See Also:

authenticate(Authentication)

supports

boolean supports(Class<?> aClass)

Checks if the class of authentication is supported by this security provider

Parameters:

aClass - The class to verify

Returns:

Whether this class is supported

createSecurityContext

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

Creates the security context for this security provider

Parameters:

auth - The Authentication object

Returns:

The SecurityContext for this provider

Throws:

org.mule.runtime.api.security.UnknownAuthenticationTypeException - In case the authentication type is not known.

See Also:

createSecurityContext(Authentication)