org.springframework.security.oauth2.provider.approval.UserApprovalHandler Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of spring-security-oauth2 Show documentation

Module for providing OAuth2 support to Spring Security

There is a newer version: 2.5.2.RELEASE

Show newest version

package org.springframework.security.oauth2.provider.approval;

import java.util.Map;

import org.springframework.security.core.Authentication;
import org.springframework.security.oauth2.provider.AuthorizationRequest;

/**
 * Basic interface for determining whether a given client authentication request has been
 * approved by the current user.
 *
 * 
 * @deprecated See the OAuth 2.0 Migration Guide for Spring Security 5.
 *
 * @author Ryan Heaton
 * @author Dave Syer
 * @author Amanda Anganes
 */
@Deprecated
public interface UserApprovalHandler {

	/**
	 * 

	 * Tests whether the specified authorization request has been approved by the current
	 * user (if there is one).
	 * 
	 * 
	 * @param authorizationRequest the authorization request.
	 * @param userAuthentication the user authentication for the current user.
	 * @return true if the request has been approved, false otherwise
	 */
	boolean isApproved(AuthorizationRequest authorizationRequest,
			Authentication userAuthentication);

	/**
	 * 
	 * Provides a hook for allowing requests to be pre-approved (skipping the User
	 * Approval Page). Some implementations may allow users to store approval decisions so
	 * that they only have to approve a site once. This method is called in the
	 * AuthorizationEndpoint before sending the user to the Approval page. If this method
	 * sets oAuth2Request.approved to true, the Approval page will be skipped.
	 * 
	 * 
	 * @param authorizationRequest the authorization request.
	 * @param userAuthentication the user authentication
	 * @return the AuthorizationRequest, modified if necessary
	 */
	AuthorizationRequest checkForPreApproval(AuthorizationRequest authorizationRequest,
			Authentication userAuthentication);

	/**
	 * 
	 * Provides an opportunity to update the authorization request after the
	 * {@link AuthorizationRequest#setApprovalParameters(Map) approval parameters} are set
	 * but before it is checked for approval. Useful in cases where the incoming approval
	 * parameters contain richer information than just true/false (e.g. some scopes are
	 * approved, and others are rejected), implementations may need to be able to modify
	 * the {@link AuthorizationRequest} before a token is generated from it.
	 * 
	 * 
	 * @param authorizationRequest the authorization request.
	 * @param userAuthentication the user authentication
	 * @return the AuthorizationRequest, modified if necessary
	 */
	AuthorizationRequest updateAfterApproval(AuthorizationRequest authorizationRequest,
			Authentication userAuthentication);

	/**
	 * Generate a request for the authorization server to ask for the user's approval.
	 * Typically this will be rendered into a view (HTML etc.) to prompt for the approval,
	 * so it needs to contain information about the grant (scopes and client id for
	 * instance).
	 * 
	 * @param authorizationRequest the authorization request
	 * @param userAuthentication the user authentication
	 * @return a model map for rendering to the user to ask for approval
	 */
	Map getUserApprovalRequest(AuthorizationRequest authorizationRequest,
			Authentication userAuthentication);

}