IdentityProviderBuilder (Microfocus Android Mobile Native Application SDK Library)

```
public interface IdentityProviderBuilder
```
A builder that enables construction of IdentityProvider instances.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`IdentityProvider`	`build()` Construct an Identity Provider using the settings currently contained in this builder instance.
`IdentityProviderBuilder`	`setAuthorizationEndPoint(java.lang.String authorizationEndPoint)` Set the OAuth2 authorization end point URL.
`IdentityProviderBuilder`	`setDiscoveryEndPoint(java.lang.String discoveryEndPoint)` Set the OAuth2 Identity Provider configuration discovery end point URL.
`IdentityProviderBuilder`	`setLogoutEndPoint(java.lang.String logoutEndPoint)` Set the Identity Provider Un-Authenticate (logout) end point URL.
`IdentityProviderBuilder`	`setRegistrationEndPoint(java.lang.String registrationEndPoint)` Set the OAuth2 client registration end point URL.
`IdentityProviderBuilder`	`setScope(java.lang.String scope)` Set the OAuth2 scope.
`IdentityProviderBuilder`	`setTokenEndPoint(java.lang.String tokenEndPoint)` Set the OAuth2 token end point URL.
`IdentityProviderBuilder`	`setTokenRevocationEndPoint(java.lang.String tokenRevocationEndPoint)` Set the refresh token revocation end point url.
`IdentityProviderBuilder`	`setTokenRevocationMethod(java.lang.String tokenRevocationMethod)` Set the refresh token revocation HTTP method: "POST" or "GET".
`IdentityProviderBuilder`	`setTokenRevocationParameterFormatString(java.lang.String tokenRevocationParameterFormatString)` Set the refresh token revocation parameter format string.
`IdentityProviderBuilder`	`setUserInfoEndPoint(java.lang.String userInfoEndPoint)` Set the OAuth2 user information end point URL.

- Method Detail
  - setScope
```
IdentityProviderBuilder setScope(java.lang.String scope)
```
    Set the OAuth2 scope. By specification this is a space delimited string.
    
    Parameters:
    
    scope - The OAuth2 scope.
    
    Returns:
    
    The 'this' IdentityProviderBuilder reference. Will never return null.
  - setDiscoveryEndPoint
```
IdentityProviderBuilder setDiscoveryEndPoint(java.lang.String discoveryEndPoint)
```
    Set the OAuth2 Identity Provider configuration discovery end point URL.
    
    Parameters:
    
    discoveryEndPoint - The Identity Provider configuration discovery end point URL. This value may be a full URL in which the leftmost part is equal to the Provider URL. Or, it can be a partial URL that will be appended to the end of the Provider URL. In the case of a partial URL, if it does not begin with a slash, a single slash character will be inserted between the Root URL and the partial URL. May be nullif the end point will not be defined. If it is the empty string, then it is equivalent to a slash character.
    
    Returns:
    
    The 'this' IdentityProviderBuilder reference. Will never return null.
  - setAuthorizationEndPoint
```
IdentityProviderBuilder setAuthorizationEndPoint(java.lang.String authorizationEndPoint)
```
    Set the OAuth2 authorization end point URL.
    
    Parameters:
    
    authorizationEndPoint - The authorization end point URL. This value may be a full URL in which the leftmost part is equal to the Provider URL. Or, it can be a partial URL that will be appended to the end of the Provider URL. In the case of a partial URL, if it does not begin with a slash, a single slash character will be inserted between the Provider URL and the partial URL. May be null if the end point will not be defined. If it is the empty string, then it is equivalent to a slash character.
    
    Returns:
    
    The 'this' IdentityProviderBuilder reference. Will never return null.
  - setTokenEndPoint
```
IdentityProviderBuilder setTokenEndPoint(java.lang.String tokenEndPoint)
```
    Set the OAuth2 token end point URL.
    
    Parameters:
    
    tokenEndPoint - The token end point URL. This value may be a full URL in which the leftmost part is equal to the Provider URL. Or, it can be a partial URL that will be appended to the end of the Provider URL. In the case of a partial URL, if it does not begin with a slash, a single slash character will be inserted between the Provider URL and the partial URL. May be null if the end point will not be defined. If it is the empty string, then it is equivalent to a slash character.
    
    Returns:
    
    The 'this' IdentityProviderBuilder reference. Will never return null.
  - setRegistrationEndPoint
```
IdentityProviderBuilder setRegistrationEndPoint(java.lang.String registrationEndPoint)
```
    Set the OAuth2 client registration end point URL.
    
    Parameters:
    
    registrationEndPoint - The client registration end point URL. This value may be a full URL in which the leftmost part is equal to the Provider URL. Or, it can be a partial URL that will be appended to the end of the Provider URL. In the case of a partial URL, if it does not begin with a slash, a single slash character will be inserted between the Provider URL and the partial URL. May be null if the end point will not be defined. If it is the empty string, then it is equivalent to a slash character.
    
    Returns:
    
    The 'this' IdentityProviderBuilder reference. Will never return null.
  - setUserInfoEndPoint
```
IdentityProviderBuilder setUserInfoEndPoint(java.lang.String userInfoEndPoint)
```
    Set the OAuth2 user information end point URL.
    
    Parameters:
    
    userInfoEndPoint - The user information end point URL. This value may be a full URL in which the leftmost part is equal to the Provider URL. Or, it can be a partial URL that will be appended to the end of the Provider URL. In the case of a partial URL, if it does not begin with a slash, a single slash character will be inserted between the Provider URL and the partial URL. May be null if the end point will not be defined. If it is the empty string, then it is equivalent to a slash character.
    
    Returns:
    
    The 'this' IdentityProviderBuilder reference. Will never return null.
  - setLogoutEndPoint
```
IdentityProviderBuilder setLogoutEndPoint(java.lang.String logoutEndPoint)
```
    Set the Identity Provider Un-Authenticate (logout) end point URL.
    
    Parameters:
    
    logoutEndPoint - The logout end point URL. This value may be a full URL in which the leftmost part is equal to the Provider URL. Or, it can be a partial URL that will be appended to the end of the Provider URL. In the case of a partial URL, if it does not begin with a slash, a single slash character will be inserted between the Provider URL and the partial URL. May be null if the end point will not be defined. If it is the empty string, then it is equivalent to a slash character.
    
    Returns:
    
    The 'this' IdentityProviderBuilder reference. Will never return null.
  - setTokenRevocationEndPoint
```
IdentityProviderBuilder setTokenRevocationEndPoint(java.lang.String tokenRevocationEndPoint)
```
    Set the refresh token revocation end point url.
    
    Parameters:
    
    tokenRevocationEndPoint - The token revocation end point URL. This value may be a full URL in which the leftmost part is equal to the Provider URL. Or, it can be a partial URL that will be appended to the end of the Provider URL. In the case of a partial URL, if it does not begin with a slash, a single slash character will be inserted between the Provider URL and the partial URL. May be null if the end point will not be defined. If it is the empty string, then it is equivalent to a slash character.
    
    Returns:
    
    The 'this' IdentityProviderBuilder reference. Will never return null.
  - setTokenRevocationMethod
```
IdentityProviderBuilder setTokenRevocationMethod(java.lang.String tokenRevocationMethod)
```
    Set the refresh token revocation HTTP method: "POST" or "GET".
    
    Parameters:
    
    tokenRevocationMethod - The token revocation HTTP method. This value may be one of two string values: "POST" or "GET".
    
    Returns:
    
    The 'this' IdentityProviderBuilder reference. Will never return null.
  - setTokenRevocationParameterFormatString
```
IdentityProviderBuilder setTokenRevocationParameterFormatString(java.lang.String tokenRevocationParameterFormatString)
```
    Set the refresh token revocation parameter format string.
    
    Parameters:
    
    tokenRevocationParameterFormatString - The token revocation parameter format string.
    
    Returns:
    
    The 'this' IdentityProviderBuilder reference. Will never return null.
  - build
```
IdentityProvider build()
                throws AuthenticatorException
```
    Construct an Identity Provider using the settings currently contained in this builder instance.
    
    Returns:
    
    A newly created Identity Provider.
    
    Throws:
    
    AuthenticatorException - on any attempt to create an Identity Provider with an invalid configuration.

Interface IdentityProviderBuilder

Method Summary

Method Detail

setScope

setDiscoveryEndPoint

setAuthorizationEndPoint

setTokenEndPoint

setRegistrationEndPoint

setUserInfoEndPoint

setLogoutEndPoint

setTokenRevocationEndPoint

setTokenRevocationMethod

setTokenRevocationParameterFormatString

build