com.belladati.sdk

Interface BellaDatiConnection

All Superinterfaces:

Serializable

public interface BellaDatiConnection
extends Serializable

A connection to one specific BellaDati server. Use this connection to authenticate via OAuth or xAuth and obtain a BellaDatiService instance.

The same connection may be used to log in as multiple users, even in parallel.

Connection instances may be serialized, saved, and restored for later use with the same server. This will instantiate a new HTTP client.

Author:

Chris Hennigfeld

Method Summary

Methods

Modifier and Type	Method and Description
OAuthRequest	oAuth(String consumerKey, String consumerSecret) Initiates OAuth authentication by requesting a request token from the BellaDati server.
OAuthRequest	oAuth(String consumerKey, String consumerSecret, String redirectUrl) Initiates OAuth authentication by requesting a request token from the BellaDati server.
BellaDatiService	xAuth(String consumerKey, String consumerSecret, String username, String password) Authenticates to the BellaDati server using xAuth.

Method Detail

oAuth

OAuthRequest oAuth(String consumerKey,
                 String consumerSecret)
                   throws ConnectionException,
                          AuthorizationException

Initiates OAuth authentication by requesting a request token from the BellaDati server.

Parameters:

consumerKey - the consumer key configured in your BellaDati domain

consumerSecret - the consumer secret configured in your BellaDati domain

Returns:

the ongoing OAuth authentication

Throws:

ConnectionException - if connection to the server fails

AuthorizationException - if something went wrong during authentication, check AuthorizationException.getReason() for details

oAuth

OAuthRequest oAuth(String consumerKey,
                 String consumerSecret,
                 String redirectUrl)
                   throws IllegalArgumentException,
                          ConnectionException,
                          AuthorizationException

Initiates OAuth authentication by requesting a request token from the BellaDati server.

After authorization, BellaDati redirects the user to the given URL. This needs to be a valid URL.

Parameters:

consumerKey - the consumer key configured in your BellaDati domain

consumerSecret - the consumer secret configured in your BellaDati domain

redirectUrl - BellaDati will redirect the user to this URL after successful authorization

Returns:

the ongoing OAuth authentication

Throws:

IllegalArgumentException - if the redirect URL is not a valid URL

ConnectionException - if connection to the server fails

AuthorizationException - if something went wrong during authentication, check AuthorizationException.getReason() for details

xAuth

BellaDatiService xAuth(String consumerKey,
                     String consumerSecret,
                     String username,
                     String password)
                       throws ConnectionException,
                              AuthorizationException

Authenticates to the BellaDati server using xAuth. To use xAuth, it must be enabled in your domain.

Warning: For security reasons, we recommend using OAuth for authentication. Use xAuth only if it is not possible to use a web browser for authentication in your workflow.

Parameters:

consumerKey - the consumer key configured in your BellaDati domain

consumerSecret - the consumer secret configured in your BellaDati domain

username - username of the user logging in

password - password of the user logging in

Returns:

a service instance accessing BellaDati as the user with the given credentials

Throws:

ConnectionException - if connection to the server fails

AuthorizationException - if something went wrong during authentication, check AuthorizationException.getReason() for details