facebook4j.auth.OAuthSupport Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of facebook4j-core Show documentation
A Java library for the Facebook Graph API
There is a newer version: 2.4.13
/*
 * Copyright 2012 Ryuji Yamashita
 *
 * 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 facebook4j.auth;

import facebook4j.FacebookException;

/**
 * @author Ryuji Yamashita - roundrop at gmail.com
 */
public interface OAuthSupport {
    /**
     * sets the OAuth AppID and App secret
     *
     * @param appId OAuth AppID
     * @param appSecret OAuth App secret
     * @throws IllegalStateException when OAuth AppId has already been set
     */
    void setOAuthAppId(String appId, String appSecret);

    /**
     * sets the permissions
     *
     * @param permissions comma-separated permission names
     * @see Permissions Reference
     */
    void setOAuthPermissions(String permissions);

    String getOAuthAuthorizationURL(String callbackURL);
    String getOAuthAuthorizationURL(String callbackURL, String state);
    String getOAuthAuthorizationURL(String callbackURL, AuthOption authOption);

    /**
     * Returns the URL that asks the person to re-authenticate unconditionally.
     * @param callbackURL callback url
     * @param nonce a completely arbitrary alphanumeric code that your app generates. see: The auth_nonce parameter
     * @return the url for re-authenticate
     * @see Re-authentication - Facebook Login
     */
    String getOAuthReAuthenticationURL(String callbackURL, String nonce);

    /**
     * Returns an access token associated with this instance.
     *
     * @return access token
     * @throws IllegalStateException when this instance has no access token
     * @see Server-Side Authentication
     */
    AccessToken getOAuthAccessToken();

    /**
     * Exchange the code for a User Access Token.
     *
     * @param oauthCode OAuth code.
     * @return User Access Token
     * @throws FacebookException when Facebook service or network is unavailable, or the user has not authorized
     * @see Server-Side Authentication
     */
    AccessToken getOAuthAccessToken(String oauthCode) throws FacebookException;

    /**
     * Exchange the code for a User Access Token.
     *
     * @param oauthCode OAuth code.
     * @param callbackURL callback URL
     * @return User Access Token
     * @throws FacebookException when Facebook service or network is unavailable, or the user has not authorized
     * @see Server-Side Authentication
     */
    AccessToken getOAuthAccessToken(String oauthCode, String callbackURL) throws FacebookException;

    /**
     * Returns an App Access Token.
     *
     * @return App Access Token
     * @throws FacebookException when Facebook service or network is unavailable, or the user has not authorized
     * @see Server-Side Authentication
     */
    AccessToken getOAuthAppAccessToken() throws FacebookException;

    /**
     * Returns a generated device code.
     *
     * @return Device code
     * @throws FacebookException when Facebook service or network is unavailable, or the user has not authorized
     * @see Facebook Login for Devices
     */
    DeviceCode getOAuthDeviceCode() throws FacebookException;

    /**
     * Returns a Device Access Token.
     *
     * @return Device Acceess Token
     * @throws FacebookException when Facebook service or network is unavailable, or the user has not authorized
     * @see Facebook Login for Devices
     */
    AccessToken getOAuthDeviceToken(DeviceCode deviceCode) throws FacebookException;

    /**
     * Sets the access token
     *
     * @param accessToken access token
     */
    void setOAuthAccessToken(AccessToken accessToken);

    /**
     * Sets the access token and callback URL
     * @return Callback URL
     */
    String getOAuthCallbackURL();

    /**
     * Sets the access token
     *
     * @param callbackURL Callback URL
     */
    void setOAuthCallbackURL(String callbackURL);


    /**
     * Extends the short-lived-token expiration.
     * @param shortLivedToken access token
     * @return extended access token
     * @throws FacebookException when Facebook service or network is unavailable, or the user has not authorized
     * @see Expiration and Extension of Access Tokens - Facebook Login
     */
    AccessToken extendTokenExpiration(String shortLivedToken) throws FacebookException;

    /**
     * Extends this instance's short-lived-token expiration.
     * @return extended access token
     * @throws FacebookException when Facebook service or network is unavailable, or the user has not authorized
     * @see Expiration and Extension of Access Tokens - Facebook Login
     */
    AccessToken extendTokenExpiration() throws FacebookException;

    /**
     * Returns the access token information.
     * @param accessToken access token
     * @return access token information
     * @throws FacebookException when Facebook service or network is unavailable, or the user has not authorized
     */
    AccessToken getOAuthAccessTokenInfo(String accessToken) throws FacebookException;

    /**
     * Returns the access token information.
     * @return access token information
     * @throws FacebookException when Facebook service or network is unavailable, or the user has not authorized
     */
    AccessToken getOAuthAccessTokenInfo() throws FacebookException;
}