com.communote.server.core.security.authentication

Class AbstractCommunoteAuthenticationToken<T>

java.lang.Object

org.springframework.security.authentication.AbstractAuthenticationToken

com.communote.server.core.security.authentication.AbstractCommunoteAuthenticationToken<T>

Type Parameters:

T - the type of token it will hold

All Implemented Interfaces:

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

Direct Known Subclasses:

ConfluenceAuthenticationToken

public abstract class AbstractCommunoteAuthenticationToken<T>
extends org.springframework.security.authentication.AbstractAuthenticationToken

Base class for holding the token that is used in the Communote token authentication method.

Author:

Communote GmbH - http://www.communote.com/

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractCommunoteAuthenticationToken(Object principal, T token, Collection<org.springframework.security.core.GrantedAuthority> authorities) Allows the creation of a successful authentication.
AbstractCommunoteAuthenticationToken(T token) Creates a token for authentication against Confluence.

Method Summary

Modifier and Type	Method and Description
T	getCredentials() The credentials is the token retrieved
String	getName() Returns null because this principal (the token) has no name.
Object	getPrincipal()
void	setAuthenticated(boolean authenticated)

Methods inherited from class org.springframework.security.authentication.AbstractAuthenticationToken

equals, eraseCredentials, getAuthorities, getDetails, hashCode, isAuthenticated, setDetails, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.security.Principal

implies

Constructor Detail

AbstractCommunoteAuthenticationToken

public AbstractCommunoteAuthenticationToken(Object principal,
                                            T token,
                                            Collection<org.springframework.security.core.GrantedAuthority> authorities)

Allows the creation of a successful authentication. When the authorities are not null isAuthenticated will return true.

Parameters:

principal - the principal

token - a token for authenticating the user. The token is stored as credentials.

authorities - the granted authorities

AbstractCommunoteAuthenticationToken

public AbstractCommunoteAuthenticationToken(T token)

Creates a token for authentication against Confluence.

Parameters:

token - a token for authenticating the user. The token is stored as credentials.

Method Detail

getCredentials

public T getCredentials()

The credentials is the token retrieved

Returns:

the token

getName

public String getName()

Returns null because this principal (the token) has no name.

Specified by:

getName in interface Principal

Overrides:

getName in class org.springframework.security.authentication.AbstractAuthenticationToken

Returns:

null

See Also:

Principal.getName()

getPrincipal

public Object getPrincipal()

setAuthenticated

public void setAuthenticated(boolean authenticated)

Specified by:

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

Overrides:

setAuthenticated in class org.springframework.security.authentication.AbstractAuthenticationToken