OpenIDAuthenticationStatus.java

/*
 * 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
 *
 *      http://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;

/**
 * Authentication status codes, based on JanRain status codes
 *
 * @author JanRain Inc.
 * @author Robin Bramley, Opsera Ltd
 * @author Luke Taylor
 */
public enum OpenIDAuthenticationStatus {

	/** This code indicates a successful authentication request */
	SUCCESS("success"),

	/** This code indicates a failed authentication request */
	FAILURE("failure"),

	/** This code indicates the server reported an error */
	ERROR("error"),

	/**
	 * This code indicates that the user needs to do additional work to prove their
	 * identity
	 */
	SETUP_NEEDED("setup needed"),

	/** This code indicates that the user cancelled their login request */
	CANCELLED("cancelled");

	private final String name;

	// ~ Constructors
	// ===================================================================================================

	private OpenIDAuthenticationStatus(String name) {
		this.name = name;
	}

	public String toString() {
		return name;
	}
}