OAuthConfig (socialauth 4.15 API)

java.lang.Object
- org.brickred.socialauth.util.OAuthConfig

All Implemented Interfaces:

Serializable
```
public class OAuthConfig
extends Object
implements Serializable
```
It contains the configuration of application like consumer key and consumer secret

Author:

tarunn@brickred.com

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`OAuthConfig(String consumerKey, String consumerSecret)`
`OAuthConfig(String consumerKey, String consumerSecret, String signatureMethod, String transportName)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`get_consumerKey()` Retrieves the consumer key
`String`	`get_consumerSecret()` Retrieves the consumer secret
`String`	`get_signatureMethod()` Retrieves the signature method
`String`	`get_transportName()` Retrieves the transport name
`String`	`getAccessTokenUrl()` Retrieves the access token url
`String`	`getAuthenticationUrl()` Retrieves the authentication url
`String`	`getCustomPermissions()` Retrieves custom permissions configured in properties file
`Map<String,String>`	`getCustomProperties()` Returns custom properties for the provider
`String`	`getId()` Retrieves the provider id
`List<String>`	`getPluginsScopes()` Retrieves the list of plugins scopes
`Class<?>`	`getProviderImplClass()` Retrieves the provider implementation class
`String[]`	`getRegisteredPlugins()` Retrieves the registered plugins of a provider configured in properties file.
`String`	`getRequestTokenUrl()` Retrieves the request token url
`boolean`	`isSaveRawResponse()` Returns status to save the raw response for profile and contacts.
`void`	`setAccessTokenUrl(String accessTokenUrl)` Updates the access token url
`void`	`setAuthenticationUrl(String authenticationUrl)` Updates the authentication url
`void`	`setCustomPermissions(String customPermissions)` Updates custom permissions configured in properties file
`void`	`setCustomProperties(Map<String,String> customProperties)` Updates the custom properties
`void`	`setId(String id)` Updates the provider id
`void`	`setPluginsScopes(List<String> pluginsScopes)` Updates the plugins scopes
`void`	`setProviderImplClass(Class<?> providerImplClass)` Updates the provider implementation class
`void`	`setRegisteredPlugins(String[] registeredPlugins)` Updates the registered plugins configured in properties file
`void`	`setRequestTokenUrl(String requestTokenUrl)` Updates the request token url
`void`	`setSaveRawResponse(boolean saveRawResponse)` Set this flag to True if raw response should be save for profile and contacts.
`String`	`toString()`

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

- Constructor Detail
  - OAuthConfig
```
public OAuthConfig(String consumerKey,
                   String consumerSecret,
                   String signatureMethod,
                   String transportName)
```
    Parameters:
    
    consumerKey - Application consumer key
    
    consumerSecret - Application consumer secret
    
    signatureMethod - Signature Method type
    
    transportName - Transport name
  - OAuthConfig
```
public OAuthConfig(String consumerKey,
                   String consumerSecret)
```
- Method Detail
  - get_consumerKey
```
public String get_consumerKey()
```
    Retrieves the consumer key
    
    Returns:
    
    the consumer key
  - get_consumerSecret
```
public String get_consumerSecret()
```
    Retrieves the consumer secret
    
    Returns:
    
    the consumer secret
  - get_signatureMethod
```
public String get_signatureMethod()
```
    Retrieves the signature method
    
    Returns:
    
    the signature method
  - get_transportName
```
public String get_transportName()
```
    Retrieves the transport name
    
    Returns:
    
    the transport name
  - getId
```
public String getId()
```
    Retrieves the provider id
    
    Returns:
    
    the provider id
  - setId
```
public void setId(String id)
```
    Updates the provider id
    
    Parameters:
    
    id - the provider id
  - getProviderImplClass
```
public Class<?> getProviderImplClass()
```
    Retrieves the provider implementation class
    
    Returns:
    
    the provider implementation class
  - setProviderImplClass
```
public void setProviderImplClass(Class<?> providerImplClass)
```
    Updates the provider implementation class
    
    Parameters:
    
    providerImplClass - the provider implementation class
  - getCustomPermissions
```
public String getCustomPermissions()
```
    Retrieves custom permissions configured in properties file
    
    Returns:
    
    String of custom permissions
  - setCustomPermissions
```
public void setCustomPermissions(String customPermissions)
```
    Updates custom permissions configured in properties file
    
    Parameters:
    
    customPermissions - String of comma seperated custom permissions
  - getAuthenticationUrl
```
public String getAuthenticationUrl()
```
    Retrieves the authentication url
    
    Returns:
    
    the authentication url string
  - setAuthenticationUrl
```
public void setAuthenticationUrl(String authenticationUrl)
```
    Updates the authentication url
    
    Parameters:
    
    authenticationUrl - the authentication url string
  - getAccessTokenUrl
```
public String getAccessTokenUrl()
```
    Retrieves the access token url
    
    Returns:
    
    the access token url string
  - setAccessTokenUrl
```
public void setAccessTokenUrl(String accessTokenUrl)
```
    Updates the access token url
    
    Parameters:
    
    accessTokenUrl - the access token url string
  - getRequestTokenUrl
```
public String getRequestTokenUrl()
```
    Retrieves the request token url
    
    Returns:
    
    the request token url string
  - setRequestTokenUrl
```
public void setRequestTokenUrl(String requestTokenUrl)
```
    Updates the request token url
    
    Parameters:
    
    requestTokenUrl - the request token url string
  - getRegisteredPlugins
```
public String[] getRegisteredPlugins()
```
    Retrieves the registered plugins of a provider configured in properties file. String contains the fully qualified plugin class name
    
    Returns:
    
    String array of registered plugins
  - setRegisteredPlugins
```
public void setRegisteredPlugins(String[] registeredPlugins)
```
    Updates the registered plugins configured in properties file
    
    Parameters:
    
    registeredPlugins - String array of plugins. String should contain fully qualified plugin class name
  - getPluginsScopes
```
public List<String> getPluginsScopes()
```
    Retrieves the list of plugins scopes
    
    Returns:
    
    list of plugins scope
  - setPluginsScopes
```
public void setPluginsScopes(List<String> pluginsScopes)
```
    Updates the plugins scopes
    
    Parameters:
    
    pluginsScopes - list of plugins scopes
  - isSaveRawResponse
```
public boolean isSaveRawResponse()
```
    Returns status to save the raw response for profile and contacts. Default value is False.
    
    Returns:
    
    True/False to check whether raw response should save or not.
  - setSaveRawResponse
```
public void setSaveRawResponse(boolean saveRawResponse)
```
    Set this flag to True if raw response should be save for profile and contacts. Default it is False.
    
    Parameters:
    
    saveRawResponse - flag to config whether raw response should be saved or not.
  - getCustomProperties
```
public Map<String,String> getCustomProperties()
```
    Returns custom properties for the provider
    
    Returns:
    
    map which contains custom properties
  - setCustomProperties
```
public void setCustomProperties(Map<String,String> customProperties)
```
    Updates the custom properties
    
    Parameters:
    
    customProperties - map which store the custom properties required for the provider except conumer key, secret and scopes
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class OAuthConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OAuthConfig

OAuthConfig

Method Detail

get_consumerKey

get_consumerSecret

get_signatureMethod

get_transportName

getId

setId

getProviderImplClass

setProviderImplClass

getCustomPermissions

setCustomPermissions

getAuthenticationUrl

setAuthenticationUrl

getAccessTokenUrl

setAccessTokenUrl

getRequestTokenUrl

setRequestTokenUrl

getRegisteredPlugins

setRegisteredPlugins

getPluginsScopes

setPluginsScopes

isSaveRawResponse

setSaveRawResponse

getCustomProperties

setCustomProperties

toString