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.common.signature;
18  
19  /**
20   * Factory for signature methods.
21   *
22   * @author Ryan Heaton
23   */
24  public interface OAuthSignatureMethodFactory {
25  
26    /**
27     * Get the signature method of the given name.
28     *
29     * @param methodName      The method name.
30     * @param signatureSecret The signature secret.
31     * @param tokenSecret     The token secret.
32     * @return the signature method.
33     * @throws UnsupportedSignatureMethodException
34     *          If the specified signature method name isn't recognized or supported.
35     */
36    OAuthSignatureMethod getSignatureMethod(String methodName, SignatureSecret signatureSecret, String tokenSecret) throws UnsupportedSignatureMethodException;
37  }