com.stormpath.sdk.oauth.Oauth2AuthenticationRequestBuilder Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2015 Stormpath, Inc.
 *
 * 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
 *
 *     http://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 com.stormpath.sdk.oauth;

/**
 * Utility class used to build {@link Oauth2AuthenticationRequest Oauth2AuthenticationRequest} instances.
 *
 * @see PasswordGrantRequestBuilder
 * @see RefreshGrantRequestBuilder
 * @see JwtAuthenticationRequestBuilder
 *
 * @since 1.0.RC7
 */
public interface Oauth2AuthenticationRequestBuilder {

    /**
     * Builds a {@link Oauth2AuthenticationRequest Oauth2AuthenticationRequest} instance based on the current state of the builder.
     *
     * @return a {@link Oauth2AuthenticationRequest} instance.
     */
    T build();
}