com.microsoft.bingads

Class OAuthDesktopMobileAuthCodeGrant

java.lang.Object

com.microsoft.bingads.Authentication

com.microsoft.bingads.internal.OAuthWithAuthorizationCode

com.microsoft.bingads.OAuthDesktopMobileAuthCodeGrant

public class OAuthDesktopMobileAuthCodeGrant
extends OAuthWithAuthorizationCode

Represents an OAuth authorization object implementing the authorization code grant flow for use in a desktop or mobile application.

Field Summary

Fields

Modifier and Type	Field and Description
protected ApiEnvironment	environment
protected OAuthTokens	oAuthTokens OAuth tokens received from live.com authorization service.

Constructor Summary

Constructors

Constructor and Description
OAuthDesktopMobileAuthCodeGrant(String clientId) Creates new instance of the class that can be used in the AuthorizationData object.
OAuthDesktopMobileAuthCodeGrant(String clientId, ApiEnvironment env) Creates new instance of the class that can be used in the AuthorizationData object.
OAuthDesktopMobileAuthCodeGrant(String clientId, ApiEnvironment env, OAuthScope oAuthScope)
OAuthDesktopMobileAuthCodeGrant(String clientId, OAuthService oAuthService, ApiEnvironment env, OAuthScope oAuthScope)
OAuthDesktopMobileAuthCodeGrant(String clientId, OAuthTokens oauthTokens) Creates new instance of the class that can be used in the AuthorizationData object.
OAuthDesktopMobileAuthCodeGrant(String clientId, OAuthTokens oauthTokens, ApiEnvironment env) Creates new instance of the class that can be used in the AuthorizationData object.
OAuthDesktopMobileAuthCodeGrant(String clientId, OAuthTokens oauthTokens, ApiEnvironment env, OAuthScope oAuthScope)
OAuthDesktopMobileAuthCodeGrant(String clientId, String refreshToken) Creates new instance of the class with the specified clientId and refreshToken.
OAuthDesktopMobileAuthCodeGrant(String clientId, String refreshToken, ApiEnvironment env) Creates new instance of the class with the specified clientId and refreshToken.
OAuthDesktopMobileAuthCodeGrant(String clientId, String refreshToken, ApiEnvironment env, OAuthScope oAuthScope)

Method Summary

Modifier and Type	Method and Description
void	addHeaders(HeadersImpl headersImplementation) Adds the AuthenticationToken header element for the corresponding bulk file upload operation.
String	getAuthenticationToken()
ApiEnvironment	getEnvironment()
OAuthTokens	getOAuthTokens() Gets information about OAuth access tokens received from the Microsoft Account authorization service.
String	getState()
String	getTenant()
void	setEnvironment(ApiEnvironment environment)
protected void	setOAuthTokens(OAuthTokens oAuthTokens) Sets information about OAuth access tokens received from the Microsoft Account authorization service.
void	setState(String state)
void	setTenant(String tenant)

Methods inherited from class com.microsoft.bingads.internal.OAuthWithAuthorizationCode

getAuthorizationEndpoint, getClientId, getClientSecret, getNewTokensListener, getOAuthScope, refreshTokensIfNeeded, requestAccessAndRefreshTokens, requestAccessAndRefreshTokens, requestAccessAndRefreshTokens, setNewTokensListener

Methods inherited from class java.lang.Object

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

Field Detail

oAuthTokens

protected OAuthTokens oAuthTokens

OAuth tokens received from live.com authorization service. Populated by derived classes OAuthDesktopMobileImplicitGrant and OAuthWithAuthorizationCode

environment

protected ApiEnvironment environment

Constructor Detail

OAuthDesktopMobileAuthCodeGrant

public OAuthDesktopMobileAuthCodeGrant(String clientId,
                                       String refreshToken)

Creates new instance of the class with the specified clientId and refreshToken. This class implements the authorization code grant flow for Managing User Authentication with OAuth documented at http://go.microsoft.com/fwlink/?LinkID=511609. This is a standard OAuth 2.0 flow and is defined in detail in the Authorization Code Grant section of the OAuth 2.0 spec at http://go.microsoft.com/fwlink/?LinkID=511609. For more information about registering a Bing Ads application, see http://go.microsoft.com/fwlink/?LinkID=511607

Parameters:

clientId - the client identifier corresponding to your registered application

refreshToken - the refresh token that should be used to request an access token

See Also:

https://tools.ietf.org/html/rfc6749#section-4.1

OAuthDesktopMobileAuthCodeGrant

public OAuthDesktopMobileAuthCodeGrant(String clientId,
                                       String refreshToken,
                                       ApiEnvironment env)

Creates new instance of the class with the specified clientId and refreshToken. This class implements the authorization code grant flow for Managing User Authentication with OAuth documented at http://go.microsoft.com/fwlink/?LinkID=511609. This is a standard OAuth 2.0 flow and is defined in detail in the Authorization Code Grant section of the OAuth 2.0 spec at http://go.microsoft.com/fwlink/?LinkID=511609. For more information about registering a Bing Ads application, see http://go.microsoft.com/fwlink/?LinkID=511607

Parameters:

clientId - the client identifier corresponding to your registered application

refreshToken - the refresh token that should be used to request an access token

env - Bing Ads Environment

See Also:

http://tools.ietf.org/html/draft-ietf-oauth-v2-15#section-3.1

OAuthDesktopMobileAuthCodeGrant

public OAuthDesktopMobileAuthCodeGrant(String clientId)

Creates new instance of the class that can be used in the AuthorizationData object. See this page for additional information: https://docs.microsoft.com/en-us/bingads/guides/authentication-oauth?view=bingads-12

Parameters:

clientId - the client identifier corresponding to your registered application

See Also:

http://tools.ietf.org/html/draft-ietf-oauth-v2-15#section-3.1

OAuthDesktopMobileAuthCodeGrant

public OAuthDesktopMobileAuthCodeGrant(String clientId,
                                       ApiEnvironment env)

Creates new instance of the class that can be used in the AuthorizationData object. See this page for additional information: https://docs.microsoft.com/en-us/bingads/guides/authentication-oauth?view=bingads-12

Parameters:

clientId - the client identifier corresponding to your registered application

env - Bing Ads Environment

See Also:

http://tools.ietf.org/html/draft-ietf-oauth-v2-15#section-3.1

OAuthDesktopMobileAuthCodeGrant

public OAuthDesktopMobileAuthCodeGrant(String clientId,
                                       OAuthTokens oauthTokens)

Creates new instance of the class that can be used in the AuthorizationData object. See this page for additional information: https://docs.microsoft.com/en-us/bingads/guides/authentication-oauth?view=bingads-12

Parameters:

clientId - the client identifier corresponding to your registered application

oauthTokens - contains information about OAuth access tokens received from the Microsoft Account authorization service

See Also:

http://tools.ietf.org/html/draft-ietf-oauth-v2-15#section-3.1

OAuthDesktopMobileAuthCodeGrant

public OAuthDesktopMobileAuthCodeGrant(String clientId,
                                       OAuthTokens oauthTokens,
                                       ApiEnvironment env)

Creates new instance of the class that can be used in the AuthorizationData object. See this page for additional information: https://docs.microsoft.com/en-us/bingads/guides/authentication-oauth?view=bingads-12

Parameters:

clientId - the client identifier corresponding to your registered application

oauthTokens - contains information about OAuth access tokens received from the Microsoft Account authorization service

See Also:

http://tools.ietf.org/html/draft-ietf-oauth-v2-15#section-3.1

OAuthDesktopMobileAuthCodeGrant

public OAuthDesktopMobileAuthCodeGrant(String clientId,
                                       OAuthService oAuthService,
                                       ApiEnvironment env,
                                       OAuthScope oAuthScope)

OAuthDesktopMobileAuthCodeGrant

public OAuthDesktopMobileAuthCodeGrant(String clientId,
                                       String refreshToken,
                                       ApiEnvironment env,
                                       OAuthScope oAuthScope)

OAuthDesktopMobileAuthCodeGrant

public OAuthDesktopMobileAuthCodeGrant(String clientId,
                                       OAuthTokens oauthTokens,
                                       ApiEnvironment env,
                                       OAuthScope oAuthScope)

OAuthDesktopMobileAuthCodeGrant

public OAuthDesktopMobileAuthCodeGrant(String clientId,
                                       ApiEnvironment env,
                                       OAuthScope oAuthScope)

Method Detail

setTenant

public void setTenant(String tenant)

getTenant

public String getTenant()

setState

public void setState(String state)

getState

public String getState()

getOAuthTokens

public OAuthTokens getOAuthTokens()

Gets information about OAuth access tokens received from the Microsoft Account authorization service.

setOAuthTokens

protected void setOAuthTokens(OAuthTokens oAuthTokens)

Sets information about OAuth access tokens received from the Microsoft Account authorization service.

getAuthenticationToken

public String getAuthenticationToken()

addHeaders

public void addHeaders(HeadersImpl headersImplementation)

Adds the AuthenticationToken header element for the corresponding bulk file upload operation.

Specified by:

addHeaders in class Authentication

Parameters:

headersImplementation - the headers collection to which authentication requests should be added

getEnvironment

public ApiEnvironment getEnvironment()

Overrides:

getEnvironment in class Authentication

setEnvironment

public void setEnvironment(ApiEnvironment environment)