com.microsoft.bingads

Class OAuthWebAuthCodeGrant

java.lang.Object

com.microsoft.bingads.Authentication

com.microsoft.bingads.internal.OAuthWithAuthorizationCode

com.microsoft.bingads.OAuthWebAuthCodeGrant

public class OAuthWebAuthCodeGrant
extends OAuthWithAuthorizationCode

Represents an OAuth authorization object implementing the authorization code grant flow for use in a web 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
OAuthWebAuthCodeGrant(String clientId, String clientSecret, URL redirectionUrl) Creates new instance of the class that can be used in the AuthorizationData object.
OAuthWebAuthCodeGrant(String clientId, String clientSecret, URL redirectionUrl, ApiEnvironment env) Creates new instance of the class that can be used in the AuthorizationData object.
OAuthWebAuthCodeGrant(String clientId, String clientSecret, URL redirectionUrl, ApiEnvironment env, OAuthScope oAuthScope) Creates new instance of the class that can be used in the AuthorizationData object.
OAuthWebAuthCodeGrant(String clientId, String clientSecret, URL redirectionUri, OAuthService oAuthService, ApiEnvironment env, OAuthScope oAuthScope) Creates new instance of the class with a specified OAuthService object.
OAuthWebAuthCodeGrant(String clientId, String clientSecret, URL redirectionUri, OAuthService oAuthService, OAuthScope oAuthScope) Creates new instance of the class with a specified OAuthService object.
OAuthWebAuthCodeGrant(String clientId, String clientSecret, URL redirectionUrl, OAuthTokens oauthTokens) Creates new instance of the class that can be used in the AuthorizationData object.
OAuthWebAuthCodeGrant(String clientId, String clientSecret, URL redirectionUrl, OAuthTokens oauthTokens, ApiEnvironment env) Creates new instance of the class that can be used in the AuthorizationData object.
OAuthWebAuthCodeGrant(String clientId, String clientSecret, URL redirectionUrl, OAuthTokens oauthTokens, ApiEnvironment env, OAuthScope oAuthScope)
OAuthWebAuthCodeGrant(String clientId, String clientSecret, URL redirectionUrl, String refreshToken)
OAuthWebAuthCodeGrant(String clientId, String clientSecret, URL redirectionUrl, String refreshToken, ApiEnvironment env)
OAuthWebAuthCodeGrant(String clientId, String clientSecret, URL redirectionUrl, 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

OAuthWebAuthCodeGrant

public OAuthWebAuthCodeGrant(String clientId,
                             String clientSecret,
                             URL redirectionUrl,
                             String refreshToken)

OAuthWebAuthCodeGrant

public OAuthWebAuthCodeGrant(String clientId,
                             String clientSecret,
                             URL redirectionUrl,
                             String refreshToken,
                             ApiEnvironment env)

OAuthWebAuthCodeGrant

public OAuthWebAuthCodeGrant(String clientId,
                             String clientSecret,
                             URL redirectionUrl,
                             String refreshToken,
                             ApiEnvironment env,
                             OAuthScope oAuthScope)

OAuthWebAuthCodeGrant

public OAuthWebAuthCodeGrant(String clientId,
                             String clientSecret,
                             URL redirectionUrl)

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

Parameters:

clientId - client id

clientSecret - client secret

redirectionUrl - redirect URL

See Also:

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

OAuthWebAuthCodeGrant

public OAuthWebAuthCodeGrant(String clientId,
                             String clientSecret,
                             URL redirectionUrl,
                             ApiEnvironment env)

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

Parameters:

clientId - client id

clientSecret - client secret

redirectionUrl - redirect URL

env - Bing Ads Environment

See Also:

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

OAuthWebAuthCodeGrant

public OAuthWebAuthCodeGrant(String clientId,
                             String clientSecret,
                             URL redirectionUrl,
                             ApiEnvironment env,
                             OAuthScope oAuthScope)

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

Parameters:

clientId - client id

clientSecret - client secret

redirectionUrl - redirect URL

env - Bing Ads Environment

oAuthScope - OAuth Scope

See Also:

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

OAuthWebAuthCodeGrant

public OAuthWebAuthCodeGrant(String clientId,
                             String clientSecret,
                             URL redirectionUrl,
                             OAuthTokens oauthTokens)

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

Parameters:

clientId - client id

clientSecret - client secret

redirectionUrl - redirect URL

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, http://tools.ietf.org/html/draft-ietf-oauth-v2-15#section-2.1.1

OAuthWebAuthCodeGrant

public OAuthWebAuthCodeGrant(String clientId,
                             String clientSecret,
                             URL redirectionUrl,
                             OAuthTokens oauthTokens,
                             ApiEnvironment env)

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

Parameters:

clientId - client id

clientSecret - client secret

redirectionUrl - redirect URL

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

env - Bing Ads Environment

See Also:

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

OAuthWebAuthCodeGrant

public OAuthWebAuthCodeGrant(String clientId,
                             String clientSecret,
                             URL redirectionUrl,
                             OAuthTokens oauthTokens,
                             ApiEnvironment env,
                             OAuthScope oAuthScope)

OAuthWebAuthCodeGrant

public OAuthWebAuthCodeGrant(String clientId,
                             String clientSecret,
                             URL redirectionUri,
                             OAuthService oAuthService,
                             OAuthScope oAuthScope)

Creates new instance of the class with a specified OAuthService object. See this page for additional information on these values: https://docs.microsoft.com/en-us/bingads/guides/authentication-oauth?view=bingads-12

Parameters:

clientId - client id

clientSecret - client secret

redirectionUri - redirect URL

oAuthService - custom OAuthService object

oAuthScope - OAuth Scope

See Also:

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

OAuthWebAuthCodeGrant

public OAuthWebAuthCodeGrant(String clientId,
                             String clientSecret,
                             URL redirectionUri,
                             OAuthService oAuthService,
                             ApiEnvironment env,
                             OAuthScope oAuthScope)

Creates new instance of the class with a specified OAuthService object. See this page for additional information on these values: https://docs.microsoft.com/en-us/bingads/guides/authentication-oauth?view=bingads-12

Parameters:

clientId - client id

clientSecret - client secret

redirectionUri - redirect URL

oAuthService - custom OAuthService object

env - Bing Ads Environment

oAuthScope - OAuth Scope

See Also:

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

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)