engineer.nightowl.sonos.api.resource

Class AuthorizeResource

java.lang.Object

engineer.nightowl.sonos.api.resource.AuthorizeResource

public class AuthorizeResource
extends Object

The Authorization flow is dependent on sending your user back to a pre-registered, and user-accessible web service address.

See Also:

Sonos docs

Constructor Summary

Constructors

Constructor and Description
AuthorizeResource(SonosApiClient apiClient) Constructor for AuthorizeResource.

Method Summary

Modifier and Type	Method and Description
SonosToken	createToken(String redirectUri, String authorizeCode) Generate a token from an authorization code (see getAuthorizeCode methods in the same class)
String	generateStateValue() Noddy implementation for generating a random state value.
URI	getAuthorizeCodeUri(String redirectUri) Return the URI that a user needs to visit, in order to begin the OAuth process
URI	getAuthorizeCodeUri(String redirectUri, String state) Return the URI that a user needs to visit, in order to begin the OAuth process
SonosToken	refreshToken(String refreshToken) Generate a token from a previously issued refresh token

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthorizeResource

public AuthorizeResource(SonosApiClient apiClient)

Constructor for AuthorizeResource.

Parameters:

apiClient - a SonosApiClient object.

Method Detail

getAuthorizeCodeUri

public URI getAuthorizeCodeUri(String redirectUri,
                               String state)
                        throws URISyntaxException

Return the URI that a user needs to visit, in order to begin the OAuth process

Parameters:

redirectUri - - the URI (registered with Sonos in the developer portal) to redirect the user to

state - - strongly recommended, but ultimately optional, state value to pass to Sonos to reduce chance of CSRF

Returns:

URI that you should send the user to

Throws:

URISyntaxException - if you've passed something in that's invalid

See Also:

Sonos docs

getAuthorizeCodeUri

public URI getAuthorizeCodeUri(String redirectUri)
                        throws URISyntaxException

Return the URI that a user needs to visit, in order to begin the OAuth process

Parameters:

redirectUri - - the URI (registered with Sonos in the developer portal) to redirect the user to

Returns:

URI that you should send the user to

Throws:

URISyntaxException - if you've passed something in that's invalid

See Also:

Sonos docs

createToken

public SonosToken createToken(String redirectUri,
                              String authorizeCode)
                       throws SonosApiClientException,
                              SonosApiError

Generate a token from an authorization code (see getAuthorizeCode methods in the same class)

Parameters:

redirectUri - - the user-accessible web service URI that Sonos will redirect back to

authorizeCode - - an authorization code obtained before calling this method

Returns:

a SonosToken object containing the user's token information

Throws:

SonosApiClientException - if unable to build the request due to invalid content

SonosApiError - if there is an error generating the token (from Sonos)

See Also:

Sonos docs

refreshToken

public SonosToken refreshToken(String refreshToken)
                        throws SonosApiClientException,
                               SonosApiError

Generate a token from a previously issued refresh token

Parameters:

refreshToken - - the refresh token to use

Returns:

a SonosToken object containing the user's token information

Throws:

SonosApiClientException - if unable to build the request due to invalid content or the call fails

SonosApiError - if there is an error generating the token (from Sonos)

See Also:

Sonos docs

generateStateValue

public String generateStateValue()

Noddy implementation for generating a random state value.

Returns:

a random string to be used to reduce CSRF