org.springframework.security.oauth.common.signature.OAuthSignatureMethod.java Source code

Introduction

Here is the source code for org.springframework.security.oauth.common.signature.OAuthSignatureMethod.java

Source

/*
 * Copyright 2008 Web Cohesion
 *
 * 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
 *
 *   https://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.oauth.common.signature;

/**
 * @author Ryan Heaton
 */
public interface OAuthSignatureMethod {

    /**
     * The name of the OAuth signature method.
     *
     * @return The name of the OAuth signature method.
     */
    String getName();

    /**
     * Sign the signature base string.
     *
     * @param signatureBaseString The signature base string to sign.
     * @return The signature.
     */
    String sign(String signatureBaseString);

    /**
     * Verify the specified signature on the given signature base string.
     *
     * @param signatureBaseString The signature base string.
     * @param signature The signature.
     */
    void verify(String signatureBaseString, String signature) throws InvalidSignatureException;

}