org.mule.sdk.api.security

Interface AuthenticationHandler

@NoImplement
 @MinMuleVersion(value="4.5.0")
public interface AuthenticationHandler

This handler allows to configure the current context's authentication, used for encryption and inbound authentication, based on a given Authentication request.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
Authentication	createAuthentication(Credentials credentials)
CredentialsBuilder	createCredentialsBuilder()
Optional<Authentication>	getAuthentication()
void	setAuthentication(Authentication authentication) Updates the current context with the given Authentication information.
void	setAuthentication(List<String> securityProviders, Authentication authentication) Updates the current context with the given Authentication information.

Method Detail

setAuthentication

void setAuthentication(Authentication authentication)
                throws org.mule.runtime.api.security.SecurityProviderNotFoundException,
                       org.mule.runtime.api.security.SecurityException,
                       org.mule.runtime.api.security.UnknownAuthenticationTypeException

Updates the current context with the given Authentication information.

Parameters:

authentication - the Authentication used for setting up the new security context

Throws:

org.mule.runtime.api.security.SecurityProviderNotFoundException - if no security provider able to authenticate the given authentication is found

org.mule.runtime.api.security.SecurityException - if an error occurs during the update of the security context

org.mule.runtime.api.security.UnknownAuthenticationTypeException - if no security provider able to handle the given authentication is found

setAuthentication

void setAuthentication(List<String> securityProviders,
                       Authentication authentication)
                throws org.mule.runtime.api.security.SecurityProviderNotFoundException,
                       org.mule.runtime.api.security.SecurityException,
                       org.mule.runtime.api.security.UnknownAuthenticationTypeException

Updates the current context with the given Authentication information.

Parameters:

securityProviders - the List of security providers that will be added to the SecurityManager

authentication - the Authentication used for setting up the new security context

Throws:

org.mule.runtime.api.security.SecurityProviderNotFoundException - if no security provider able to authenticate the given authentication is found

org.mule.runtime.api.security.SecurityException - if an error occurs during the update of the security context

org.mule.runtime.api.security.UnknownAuthenticationTypeException - if no security provider able to handle the given authentication is found

getAuthentication

Optional<Authentication> getAuthentication()

Returns:

the Authentication in the current context

createAuthentication

Authentication createAuthentication(Credentials credentials)

Parameters:

credentials - the Credentials to be used for this Authentication

Returns:

a new instance of a default implementation of Authentication

createCredentialsBuilder

CredentialsBuilder createCredentialsBuilder()

Returns:

a new CredentialsBuilder