Oauth2 (Codename One API)

java.lang.Object
- com.codename1.io.Oauth2

```
public class Oauth2
extends Object
```
This is a utility class that allows Oauth2 authentication This utility uses the Codename One XHTML Component to display the authentication pages. http://tools.ietf.org/pdf/draft-ietf-oauth-v2-12.pdf

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class Oauth2.RefreshTokenRequest

Nested Classes
Modifier and Type	Class and Description
`class`	`Oauth2.RefreshTokenRequest`

Field Summary

Fields
Modifier and Type Field and Description

static String TOKEN

Fields
Modifier and Type	Field and Description
`static String`	`TOKEN`

Constructor Summary

Constructors
Constructor and Description
`Oauth2(String oauth2URL, String clientId, String redirectURI)` Simple constructor
`Oauth2(String oauth2URL, String clientId, String redirectURI, String scope)` Simple constructor
`Oauth2(String oauth2URL, String clientId, String redirectURI, String scope, String tokenRequestURL, String clientSecret)` Simple constructor
`Oauth2(String oauth2URL, String clientId, String redirectURI, String scope, String tokenRequestURL, String clientSecret, Hashtable additionalParams)` Simple constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`String`	`authenticate()` Deprecated. use createAuthComponent or showAuthentication which work asynchronously and adapt better to different platforms
`Component`	`createAuthComponent(ActionListener al)` This method creates a component which can authenticate.
`static Oauth2`	`fetchSerializedOauth2Request()`
`static String`	`getExpires()` Returns the expiry for the token received via oauth
`static boolean`	`handleRedirect(ActionListener callback)` When using the `setUseRedirectForWeb(boolean)` option you should call this method at the beginning of your app's `start()` method.
`protected void`	`handleRedirectURLParams(Map params)` Method that can be overridden by subclasses to intercept parameters extracted from the redirect URL when the login flow reaches the redirect URL.
`protected void`	`handleTokenRequestResponse(Map map)` Processes token request responses that are formatted as a JSON object.
`protected void`	`handleTokenRequestResponse(String t)` Processes token request responses that are formatted as HTTP query strings.
`static boolean`	`isBackToParent()` Enables going back to the parent form after login is completed
`boolean`	`isUseBrowserWindow()` Checks if this component will use an external web browser window for the login process.
`boolean`	`isUseRedirectForWeb()` Checks wither this Oauth component is configured to use a redirect for Oauth login when running on the web.
`Oauth2.RefreshTokenRequest`	`refreshToken(String refreshToken)`
`static void`	`setBackToParent(boolean aBackToParent)` Enables going back to the parent form after login is completed
`void`	`setUseBrowserWindow(boolean useBrowserWindow)` Set this OAuth2 object to use a `BrowserWindow` for the login process.
`void`	`setUseRedirectForWeb(boolean redirect)` Sets thisOAuth2 object to use a redirect for login instead of an iframe when running on the Web (via the Javascript port).
`void`	`showAuthentication(ActionListener al)` This method shows an authentication for login form

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - TOKEN
```
public static final String TOKEN
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Oauth2
```
public Oauth2(String oauth2URL,
              String clientId,
              String redirectURI)
```
    Simple constructor
    
    Parameters:
    
    oauth2URL - the authentication url of the service
    
    clientId - the client id that would like to use the service
    
    redirectURI - the redirect uri
  - Oauth2
```
public Oauth2(String oauth2URL,
              String clientId,
              String redirectURI,
              String scope)
```
    Simple constructor
    
    Parameters:
    
    oauth2URL - the authentication url of the service
    
    clientId - the client id that would like to use the service
    
    redirectURI - the redirect uri
    
    scope - the authentication scope
  - Oauth2
```
public Oauth2(String oauth2URL,
              String clientId,
              String redirectURI,
              String scope,
              String tokenRequestURL,
              String clientSecret)
```
    Simple constructor
    
    Parameters:
    
    oauth2URL - the authentication url of the service
    
    clientId - the client id that would like to use the service
    
    redirectURI - the redirect uri
    
    scope - the authentication scope
    
    clientSecret - the client secret
  - Oauth2
```
public Oauth2(String oauth2URL,
              String clientId,
              String redirectURI,
              String scope,
              String tokenRequestURL,
              String clientSecret,
              Hashtable additionalParams)
```
    Simple constructor
    
    Parameters:
    
    oauth2URL - the authentication url of the service
    
    clientId - the client id that would like to use the service
    
    redirectURI - the redirect uri
    
    scope - the authentication scope
    
    clientSecret - the client secret
    
    additionalParams - hashtable of additional parameters to the authentication request
- Method Detail
  - isBackToParent
```
public static boolean isBackToParent()
```
    Enables going back to the parent form after login is completed
    
    Returns:
    
    the backToParent
  - setBackToParent
```
public static void setBackToParent(boolean aBackToParent)
```
    Enables going back to the parent form after login is completed
    
    Parameters:
    
    aBackToParent - the backToParent to set
  - fetchSerializedOauth2Request
```
public static Oauth2 fetchSerializedOauth2Request()
```
  - getExpires
```
public static String getExpires()
```
    Returns the expiry for the token received via oauth
    
    Returns:
    
    the expires argument for the token
  - authenticate
```
public String authenticate()
```
    Deprecated. use createAuthComponent or showAuthentication which work asynchronously and adapt better to different platforms
    
    This method preforms the actual authentication, this method is a blocking method that will display the user the html authentication pages.
    
    Returns:
    
    the method if passes authentication will return the access token or null if authentication failed.
    
    Throws:
    
    IOException - the method will throw an IOException if something went wrong in the communication.
  - setUseBrowserWindow
```
public void setUseBrowserWindow(boolean useBrowserWindow)
```
    Set this OAuth2 object to use a BrowserWindow for the login process. You can set the global default via the "oauth2.useBrowserWindow" display property with either a "true" or "false" value.
    When this property is set, the login prompt will be displayed in a separate Window containing a web browser on the desktop. Platforms that don't have windows (e.g. iOS/Android) will fall back to a separate Form with a webview).
    
    Parameters:
    
    useBrowserWindow - True to use a browser window for the login process.
    
    Since:
    
    7.0
  - isUseBrowserWindow
```
public boolean isUseBrowserWindow()
```
    Checks if this component will use an external web browser window for the login process.
    
    Returns:
    
    True if this component will use an external web browser window.
    
    Since:
    
    7.0
  - setUseRedirectForWeb
```
public void setUseRedirectForWeb(boolean redirect)
```
    Sets thisOAuth2 object to use a redirect for login instead of an iframe when running on the Web (via the Javascript port). Some Oauth providers won't work inside an iframe.
    Using this option will cause the browser to navigate away from the app to go to the login page. The Oauth login will redirect back to the app after login is complete.
    
    Warning: If the user has unsaved changes in the app, navigating away from the app may cause them to lose their changes. You should provide a warning, or confirmation prompt for the user in such cases. The usual onbeforeunload handler is disabled when using this action so the user won't receive any warnings other than what you explicitly prompt.
    
    Parameters:
    
    redirect - Set to true to use a redirect for Oauth login instead of an iframe when running on the web.
    
    Since:
    
    7.0
    
    See Also:
    
    isUseRedirectForWeb(), handleRedirect(com.codename1.ui.events.ActionListener)
  - isUseRedirectForWeb
```
public boolean isUseRedirectForWeb()
```
    Checks wither this Oauth component is configured to use a redirect for Oauth login when running on the web.
    
    Returns:
    
    True if this component will use a redirect for Oauth login.
    
    Since:
    
    7.0
    
    See Also:
    
    setUseRedirectForWeb(boolean), handleRedirect(com.codename1.ui.events.ActionListener)
  - createAuthComponent
```
public Component createAuthComponent(ActionListener al)
```
    This method creates a component which can authenticate. You will receive either the authentication key or an Exception object within the ActionListener callback method.
    
    Parameters:
    
    al - a listener that will receive at its source either a token for the service or an exception in case of a failure
    
    Returns:
    
    a component that should be displayed to the user in order to perform the authentication
  - handleRedirect
```
public static boolean handleRedirect(ActionListener callback)
```
    When using the setUseRedirectForWeb(boolean) option you should call this method at the beginning of your app's start() method. If the app was loaded as a result of redirecting from an Oauth login, then this method will handle the login and will call the callback method on complete.
    
    Parameters:
    
    callback - a listener that will receive at its source either a token for the service or an exception in case of a failure
    
    Returns:
    
    True the redirect was handled. False if it was not handled. If this returns true, then you should just return from the start() method, and instead handle control flow in your callback.
    
    Since:
    
    7.0
    
    See Also:
    
    setUseRedirectForWeb(boolean), isUseRedirectForWeb()
  - showAuthentication
```
public void showAuthentication(ActionListener al)
```
    This method shows an authentication for login form
    
    Parameters:
    
    al - a listener that will receive at its source either a token for the service or an exception in case of a failure
  - handleTokenRequestResponse
```
protected void handleTokenRequestResponse(Map map)
```
    Processes token request responses that are formatted as a JSON object. May be overridden by subclasses, but subclass implementations should call super.handleTokenRequestResponse() so that the default implementation can parse out the token, expires, and refreshToken fields.
    
    Parameters:
    
    map - Parsed JSON object of response.
    
    Since:
    
    7.0
  - handleTokenRequestResponse
```
protected void handleTokenRequestResponse(String t)
```
    Processes token request responses that are formatted as HTTP query strings. May be overridden by subclass, but subclass implementations should call super.handleTokenRequestResponse() so that the default implementation can parse out the token, expires, and refreshToken fields.
    
    Parameters:
    
    t - The query string.
    
    Since:
    
    7.0
  - handleRedirectURLParams
```
protected void handleRedirectURLParams(Map params)
```
    Method that can be overridden by subclasses to intercept parameters extracted from the redirect URL when the login flow reaches the redirect URL. This will give subclasses an opportunity to parse out special information that the OAuth2 service provides in the callback.
    
    Parameters:
    
    params - Parsed query parameters passed to the redirect URL.
  - refreshToken
```
public Oauth2.RefreshTokenRequest refreshToken(String refreshToken)
```

Class Oauth2

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TOKEN

Constructor Detail

Oauth2

Oauth2

Oauth2

Oauth2

Method Detail

isBackToParent

setBackToParent

fetchSerializedOauth2Request

getExpires

authenticate

setUseBrowserWindow

isUseBrowserWindow

setUseRedirectForWeb

isUseRedirectForWeb

createAuthComponent

handleRedirect

showAuthentication

handleTokenRequestResponse

handleTokenRequestResponse

handleRedirectURLParams

refreshToken