Package de.ikor.sip.foundation.security.authentication.basic

Class SIPBasicAuthAuthenticationToken

java.lang.Object

de.ikor.sip.foundation.security.authentication.SIPAuthenticationToken<SIPBasicAuthAuthenticationToken>

de.ikor.sip.foundation.security.authentication.basic.SIPBasicAuthAuthenticationToken

All Implemented Interfaces:

Serializable, Principal, org.springframework.security.core.Authentication

public class SIPBasicAuthAuthenticationToken
extends SIPAuthenticationToken<SIPBasicAuthAuthenticationToken>

Container for username/password tokens in the sip authentication framework.

Author:

thomas.stieglmaier

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
SIPBasicAuthAuthenticationToken(@NonNull String principal, @NonNull String credentials, boolean authenticated)	Creates a basic auth token

Method Summary

Modifier and Type	Method	Description
Object	getCredentials()
Object	getPrincipal()
SIPBasicAuthAuthenticationToken	withAuthenticated(boolean authenticated)	Returns a new instance of the same authentication object, but with the specified value for the authenticated field.

Methods inherited from class de.ikor.sip.foundation.security.authentication.SIPAuthenticationToken

getAuthorities, 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

SIPBasicAuthAuthenticationToken

public SIPBasicAuthAuthenticationToken(@NonNull
                                       @NonNull String principal,
                                       @NonNull
                                       @NonNull String credentials,
                                       boolean authenticated)

Creates a basic auth token

Parameters:

principal - the username of the authorization header

credentials - the password of the authorization header

authenticated - indicates if the token is authenticated or not

Method Detail

getCredentials

public Object getCredentials()

Specified by:

getCredentials in interface org.springframework.security.core.Authentication

Overrides:

getCredentials in class SIPAuthenticationToken<SIPBasicAuthAuthenticationToken>

getPrincipal

public Object getPrincipal()

withAuthenticated

public SIPBasicAuthAuthenticationToken withAuthenticated(boolean authenticated)

Description copied from class: SIPAuthenticationToken

Returns a new instance of the same authentication object, but with the specified value for the authenticated field.

Specified by:

withAuthenticated in class SIPAuthenticationToken<SIPBasicAuthAuthenticationToken>

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