View Javadoc
1   /*
2    * Copyright 2006-2011 the original author or authors.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
5    * the License. You may obtain a copy of the License at
6    *
7    * https://www.apache.org/licenses/LICENSE-2.0
8    *
9    * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
10   * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
11   * specific language governing permissions and limitations under the License.
12   */
13  package org.springframework.security.oauth2.provider.token;
14  
15  import org.springframework.security.oauth2.common.OAuth2AccessToken;
16  import org.springframework.security.oauth2.provider.OAuth2Authentication;
17  
18  /**
19   * Strategy for enhancing an access token before it is stored by an {@link AuthorizationServerTokenServices}
20   * implementation.
21   * 
22   * @author Dave Syer
23   * 
24   */
25  public interface TokenEnhancer {
26  
27  	/**
28  	 * Provides an opportunity for customization of an access token (e.g. through its additional information map) during
29  	 * the process of creating a new token for use by a client.
30  	 * 
31  	 * @param accessToken the current access token with its expiration and refresh token
32  	 * @param authentication the current authentication including client and user details
33  	 * @return a new token enhanced with additional information
34  	 */
35  	OAuth2AccessToken enhance(OAuth2AccessToken accessToken, OAuth2Authentication authentication);
36  
37  }