twitter4j.auth.OAuth2Support Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of twitter4j-core Show documentation

A Java library for the Twitter API

There is a newer version: 4.1.2

/*
 * Copyright 2007 Yusuke Yamamoto
 *
 * 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 twitter4j.auth;

import twitter4j.TwitterException;

/**
 * @author KOMIYA Atsushi - komiya.atsushi at gmail.com
 * @see Application-only authentication | Twitter Developers
 */
public interface OAuth2Support {
    /**
     * Sets the OAuth consumer key and consumer secret.
     *
     * @param consumerKey    OAuth consumer key
     * @param consumerSecret OAuth consumer secret
     * @throws IllegalStateException when OAuth consumer has already been set, or the instance is using basic authorization.
     */
    void setOAuthConsumer(String consumerKey, String consumerSecret);

    /**
     * Obtains an OAuth 2 Bearer token.
     *
     * @return OAuth 2 Bearer token
     * @throws TwitterException      when Twitter service or network is unavailable, or connecting non-SSL endpoints.
     * @throws IllegalStateException when Bearer token is already available, or OAuth consumer is not available.
     * @see POST oauth2/token | Twitter Developers
     */
    OAuth2Token getOAuth2Token() throws TwitterException;

    /**
     * Sets the OAuth 2 Bearer token.
     *
     * @param oauth2Token OAuth 2 Bearer token
     */
    void setOAuth2Token(OAuth2Token oauth2Token);

    /**
     * Revokes an issued OAuth 2 Bearer Token.
     *
     * @throws TwitterException      when Twitter service or network is unavailable, or connecting non-SSL endpoints.
     * @throws IllegalStateException when Bearer token is not available.
     */
    void invalidateOAuth2Token() throws TwitterException;
}