com.dnsimple.endpoints.http

Class OauthEndpoint

java.lang.Object

com.dnsimple.endpoints.http.OauthEndpoint

All Implemented Interfaces:

Oauth

public class OauthEndpoint
extends Object
implements Oauth

Constructor Summary

Constructors

Constructor and Description
OauthEndpoint(HttpEndpointClient client)

Method Summary

Modifier and Type	Method and Description
String	authorizeUrl(String clientId) Gets the URL to authorize a user for an application via the OAuth2 flow.
String	authorizeUrl(String clientId, Map<Object,Object> options) Gets the URL to authorize a user for an application via the OAuth2 flow.
OauthToken	exchangeAuthorizationForToken(String code, String clientId, String clientSecret) Exchange the short-lived authorization code for an access token that is used to authenticate API calls.
OauthToken	exchangeAuthorizationForToken(String code, String clientId, String clientSecret, Map<String,Object> options) Exchange the short-lived authorization code for an access token that is used to authenticate API calls.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OauthEndpoint

public OauthEndpoint(HttpEndpointClient client)

Method Detail

exchangeAuthorizationForToken

public OauthToken exchangeAuthorizationForToken(String code,
                                                String clientId,
                                                String clientSecret)
                                         throws DnsimpleException,
                                                IOException

Description copied from interface: Oauth

Exchange the short-lived authorization code for an access token that is used to authenticate API calls.

Specified by:

exchangeAuthorizationForToken in interface Oauth

Parameters:

code - The authorization code

clientId - The client ID

clientSecret - The client secret

Returns:

The OauthToken instance

Throws:

DnsimpleException - Any API error

IOException - Any IO error

See Also:

https://developer.dnsimple.com/v2/oauth

exchangeAuthorizationForToken

public OauthToken exchangeAuthorizationForToken(String code,
                                                String clientId,
                                                String clientSecret,
                                                Map<String,Object> options)
                                         throws DnsimpleException,
                                                IOException

Description copied from interface: Oauth

Exchange the short-lived authorization code for an access token that is used to authenticate API calls.

Specified by:

exchangeAuthorizationForToken in interface Oauth

Parameters:

code - The authorization code

clientId - The client ID

clientSecret - The client secret

options - Map of options

Returns:

The OauthToken instance

Throws:

DnsimpleException - Any API error

IOException - Any IO error

See Also:

https://developer.dnsimple.com/v2/oauth

authorizeUrl

public String authorizeUrl(String clientId)

Description copied from interface: Oauth

Gets the URL to authorize a user for an application via the OAuth2 flow.

Specified by:

authorizeUrl in interface Oauth

Parameters:

clientId - The client ID of the OAuth app in DNSimple

Returns:

The authorize URL String

See Also:

https://developer.dnsimple.com/v2/oauth/

authorizeUrl

public String authorizeUrl(String clientId,
                           Map<Object,Object> options)

Description copied from interface: Oauth

Gets the URL to authorize a user for an application via the OAuth2 flow.

Specified by:

authorizeUrl in interface Oauth

Parameters:

clientId - The client ID of the OAuth app in DNSimple

options - A Map of options to include as parameters in the generated URL

Returns:

The authorize URL string

See Also:

https://developer.dnsimple.com/v2/oauth/