org.springframework.security.openid.OpenIDAuthenticationToken Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2004, 2005, 2006 Acegi Technology Pty Limited
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.security.openid;

import java.util.ArrayList;
import java.util.Collection;
import java.util.List;

import org.springframework.security.authentication.AbstractAuthenticationToken;
import org.springframework.security.core.GrantedAuthority;
import org.springframework.security.core.SpringSecurityCoreVersion;

/**
 * OpenID Authentication Token
 *
 * @author Robin Bramley
 * @deprecated The OpenID 1.0 and 2.0 protocols have been deprecated and users are
 * encouraged to
 * migrate to OpenID Connect, which is
 * supported by spring-security-oauth2.
 */
@Deprecated
public class OpenIDAuthenticationToken extends AbstractAuthenticationToken {

	private static final long serialVersionUID = SpringSecurityCoreVersion.SERIAL_VERSION_UID;

	private final OpenIDAuthenticationStatus status;

	private final Object principal;

	private final String identityUrl;

	private final String message;

	private final List attributes;

	public OpenIDAuthenticationToken(OpenIDAuthenticationStatus status, String identityUrl, String message,
			List attributes) {
		super(new ArrayList<>(0));
		this.principal = identityUrl;
		this.status = status;
		this.identityUrl = identityUrl;
		this.message = message;
		this.attributes = attributes;
		setAuthenticated(false);
	}

	/**
	 * Created by the OpenIDAuthenticationProvider on successful authentication.
	 * @param principal usually the UserDetails returned by the configured
	 * UserDetailsService used by the OpenIDAuthenticationProvider.
	 */
	public OpenIDAuthenticationToken(Object principal, Collection authorities,
			String identityUrl, List attributes) {
		super(authorities);
		this.principal = principal;
		this.status = OpenIDAuthenticationStatus.SUCCESS;
		this.identityUrl = identityUrl;
		this.message = null;
		this.attributes = attributes;

		setAuthenticated(true);
	}

	/**
	 * Returns 'null' always, as no credentials are processed by the OpenID provider.
	 * @see org.springframework.security.core.Authentication#getCredentials()
	 */
	@Override
	public Object getCredentials() {
		return null;
	}

	public String getIdentityUrl() {
		return this.identityUrl;
	}

	public String getMessage() {
		return this.message;
	}

	/**
	 * Returns the principal value.
	 *
	 * @see org.springframework.security.core.Authentication#getPrincipal()
	 */
	@Override
	public Object getPrincipal() {
		return this.principal;
	}

	public OpenIDAuthenticationStatus getStatus() {
		return this.status;
	}

	public List getAttributes() {
		return this.attributes;
	}

	@Override
	public String toString() {
		return "[" + super.toString() + ", attributes : " + this.attributes + "]";
	}

}