CompositeAuthenticationToken (SIP Framework 2.4.0 API)

java.lang.Object
- de.ikor.sip.foundation.security.authentication.SIPAuthenticationToken<CompositeAuthenticationToken>
- - de.ikor.sip.foundation.security.authentication.CompositeAuthenticationToken

All Implemented Interfaces:

Serializable, Principal, org.springframework.security.core.Authentication
```
public class CompositeAuthenticationToken
extends SIPAuthenticationToken<CompositeAuthenticationToken>
```
Default Token set in the security context when using the sip authentication filter. It contains tokens of all responsible sip authentication providers, in case this needs to be inspected in a later part of the filter chain or e.g. a rest controller.

Author:

thomas.stieglmaier

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor	Description
`CompositeAuthenticationToken(List<SIPAuthenticationToken<?>> authTokens)`	Creates a composite authentication token, consisting of other sip auth tokens, and an aggregated isAuthenticated setting

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Object`	`getPrincipal()`
`CompositeAuthenticationToken`	`withAuthenticated(boolean authenticated)`	For composite auth tokens this method does nothing, its isAuthenticated state is always indicated by the contained auth tokens.

Methods inherited from class de.ikor.sip.foundation.security.authentication.SIPAuthenticationToken
getAuthorities, getCredentials, getDetails, getName, isAuthenticated, setAuthenticated

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.security.Principal
equals, hashCode, implies, toString

- Constructor Detail
  - CompositeAuthenticationToken
```
public CompositeAuthenticationToken(List<SIPAuthenticationToken<?>> authTokens)
```
    Creates a composite authentication token, consisting of other sip auth tokens, and an aggregated isAuthenticated setting
    
    Parameters:
    
    authTokens - the auth tokens to combine
- Method Detail
  - getPrincipal
```
public Object getPrincipal()
```
  - withAuthenticated
```
public CompositeAuthenticationToken withAuthenticated(boolean authenticated)
```
    For composite auth tokens this method does nothing, its isAuthenticated state is always indicated by the contained auth tokens.
    
    Specified by:
    
    withAuthenticated in class SIPAuthenticationToken<CompositeAuthenticationToken>
    
    Parameters:
    
    authenticated - indicates if the authentication object should be authenticated or not
    
    Returns:
    
    a copy of the caller authentication object with the specific value for authentication set