Module org.mule.sdk.api

Package org.mule.sdk.api.security

Interface Authentication

All Superinterfaces:

Serializable

@MinMuleVersion("4.5.0")
public interface Authentication
extends Serializable

Authentication represents an authentication request and contains authentication information if the request was successful.

Implementations must be immutable.

Since:

1.0

Method Summary

Modifier and Type	Method	Description
Object	getCredentials()
Object	getPrincipal()
Map<String,Object>	getProperties()
Authentication	setProperties(Map<String,Object> properties)	Makes a copy of this Authentication with the passed properties set.

Method Details

getCredentials

Object getCredentials()

Returns:

a representation of the credentials for this Authentication

getPrincipal

Object getPrincipal()

Returns:

the principal part of this Authentication (ie, the User for BasicAuth, the Subject for SAML, etc)

getProperties

Map<String,Object> getProperties()

Returns:

the properties of this Authentication

setProperties

Authentication setProperties(Map<String,Object> properties)

Makes a copy of this Authentication with the passed properties set.

Parameters:

properties - a group of properties available for the returned Authentication. MAy be null