org.springframework.security.oauth2.provider.OAuth2Authentication Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spring-security-oauth
Module for providing OAuth support to Spring Security
The newest version!
package org.springframework.security.oauth2.provider;

import org.springframework.security.authentication.AbstractAuthenticationToken;
import org.springframework.security.core.Authentication;

/**
 * An OAuth 2 authentication token can contain multiple authentications: one for the client and one for
 * the user. Since some OAuth flows don't require user authentication, the user authentication may be null.
 *
 * @author Ryan Heaton
 */
public class OAuth2Authentication extends AbstractAuthenticationToken {

  private final Authentication clientAuthentication;
  private final Authentication userAuthentication;
  private String redirect;
  private String verificationCode;

  /**
   * Construct an OAuth 2 authentication. Since some OAuth flows don't require user authentication, the user authentication may be null.
   *
   * @param clientAuthentication The client authentication (may NOT be null).
   * @param userAuthentication The user authentication (may be null).
   */
  public OAuth2Authentication(Authentication clientAuthentication, Authentication userAuthentication) {
    super(userAuthentication == null ? clientAuthentication.getAuthorities() : userAuthentication.getAuthorities());
    this.clientAuthentication = clientAuthentication;
    this.userAuthentication = userAuthentication;
  }

  public Object getCredentials() {
    return this.userAuthentication == null ? this.clientAuthentication.getCredentials() : this.userAuthentication.getCredentials();
  }

  public Object getPrincipal() {
    return this.userAuthentication == null ? this.clientAuthentication.getPrincipal() : this.userAuthentication.getPrincipal();
  }

  public Authentication getClientAuthentication() {
    return clientAuthentication;
  }

  public Authentication getUserAuthentication() {
    return userAuthentication;
  }

  @Override
  public boolean isAuthenticated() {
    return this.clientAuthentication.isAuthenticated() && (this.userAuthentication == null || this.userAuthentication.isAuthenticated());
  }

  /**
   * The redirect for this authentication.
   *
   * @return The redirect for this authentication.
   */
  public String getRedirect() {
    return redirect;
  }

  /**
   * The redirect for this authentication.
   *
   * @param redirect The redirect for this authentication.
   */
  public void setRedirect(String redirect) {
    this.redirect = redirect;
  }

  /**
   * The verification code associated with this authentication (if any).
   *
   * @return The verification code associated with this authentication (if any).
   */
  public String getVerificationCode() {
    return verificationCode;
  }

  /**
   * The verification code associated with this authentication (if any).
   *
   * @param verificationCode The verification code associated with this authentication (if any).
   */
  public void setVerificationCode(String verificationCode) {
    this.verificationCode = verificationCode;
  }
}