View Javadoc
1   /*
2    * Copyright 2008 Web Cohesion
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *   https://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package org.springframework.security.oauth.provider;
18  
19  import javax.servlet.http.HttpServletRequest;
20  import java.util.Map;
21  
22  /**
23   * Support logic for OAuth providers.
24   * 
25   * @author Ryan Heaton
26   */
27  public interface OAuthProviderSupport {
28    
29    /**
30     * Parse the oauth consumer paramters from an HttpServletRequest. The parameters are to be decoded per the OAuth spec.
31     *
32     * @param request The servlet request.
33     * @return The parsed parameters.
34     */
35    Map<String, String> parseParameters(HttpServletRequest request);
36  
37    /**
38     * Get the signature base string for the specified request, per OAuth Core 1.0, 9.1
39     *
40     * @param request The request.
41     * @return The signature base string.
42     */
43    String getSignatureBaseString(HttpServletRequest request);
44  }