com.belladati.sdk.auth.OAuthRequest Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sdk-api Show documentation

The BellaDati SDK allows accessing a BellaDati server from 3rd-party applications using Java. This project contains the SDK's interface definitions.

There is a newer version: 0.9.15.1

Show newest version

package com.belladati.sdk.auth;

import java.io.Serializable;
import java.net.URL;

import com.belladati.sdk.BellaDatiService;
import com.belladati.sdk.exception.auth.AuthorizationException;

/**
 * An ongoing OAuth authentication. To continue authentication, open the URL
 * obtained from {@link #getAuthorizationUrl()} in a browser and enter username
 * and password. After successful authentication, call {@link #requestAccess()}
 * to gain access to the server via SDK.
 * 
 * @author Chris Hennigfeld
 */
public interface OAuthRequest extends Serializable {

	/**
	 * Returns the URL to authorize this request. Open this URL in a web browser
	 * to allow the user to log in to BellaDati and grant access to your client
	 * application.
	 * 
	 * @return the URL to authorize this request
	 */
	URL getAuthorizationUrl();

	/**
	 * Requests an access token using this OAuth request. Call this method only
	 * after the user has authorized the request by logging in at the
	 * authorization URL.
	 * 
	 * @return a service instance accessing BellaDati as this request's user
	 * @throws AuthorizationException if something went wrong during
	 *             authentication; check
	 *             {@link AuthorizationException#getReason()} for details
	 */
	BellaDatiService requestAccess() throws AuthorizationException;
}