Configuration (audiobox-jlib 1.0.4 API)

java.lang.Object
- fm.audiobox.core.config.Configuration

```
public class Configuration
extends java.lang.Object
```
Through this class you can control several behavior of the client such as HTTP client or JSON parser libraries.
Here a list of mandatory fields that must be set in order to set up the client:
Not configuring these parameters will result in a ConfigurationException.
TIP: Setter methods of this class are chainable.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Configuration.Channels
AudioBox channels

static class Configuration.Env
AudioBox environments.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Configuration.Channels` AudioBox channels
`static class`	`Configuration.Env` AudioBox environments.

Constructor Summary

Constructors
Constructor and Description

Configuration()
Initiates a new Configuration ready for production.

Configuration(Configuration.Env environment)
Initiates a new Configuration.

Constructors
Constructor and Description
`Configuration()` Initiates a new Configuration ready for production.
`Configuration(Configuration.Env environment)` Initiates a new Configuration.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`checkConfiguration()` Check configuration.
`java.lang.Class<? extends Albums>`	`getAlbumsWrapperClass()` Gets the albums wrapper class.
`java.lang.String`	`getApiKey()` Gets the API Consumer Key.
`java.lang.String`	`getApiSecret()` Gets the API Consumer Secret.
`java.lang.String`	`getApplicationName()` Gets the application name.
`java.lang.Class<? extends Artists>`	`getArtistsWrapperClass()` Gets the artists wrapper class.
`java.lang.String`	`getBaseUrl()` Gets API base url.
`java.lang.String`	`getBaseUrl(Configuration.Channels channel)` Gets env base url based on the queried channel.
`java.lang.String`	`getBaseUrl(Configuration.Channels channel, boolean secure)` Gets env base url based on the queried channel.
`CredentialDataStore`	`getCredentialDataStore()` Gets data store factory.
`java.lang.String`	`getEnvHost(Configuration.Channels channel)` Gets Env base hostname
`Configuration.Env`	`getEnvironment()` Gets the `environment`.
`com.typesafe.config.Config`	`getEnvironmentConfiguration(Configuration.Env environment)` Gets environment configuration.
`com.google.api.client.http.GenericUrl`	`getEnvTokenUrl()` Gets env token url.
`ExceptionHandler`	`getExceptionHandler()` Gets the configured `ExceptionHandler`
`java.lang.Class<? extends Genres>`	`getGenresWrapperClass()` Gets the genres wrapper class.
`com.google.api.client.http.HttpTransport`	`getHttpTransport()` Gets HTTP transport.
`com.google.api.client.json.JsonFactory`	`getJsonFactory()` Gets JSON factory.
`java.lang.Class<MediaFiles>`	`getMediaFilesWrapperClass()` Gets the media files wrapper class.
`java.lang.Class<? extends MediaFileWrapper>`	`getMediaFileWrapperClass()` Gets the media file class.
`com.google.api.client.auth.oauth2.CredentialRefreshListener`	`getRefreshListener()` Gets the credential refresh listener.
`java.lang.String`	`getUnsecureBaseUrl(Configuration.Channels channel)` Gets env base url based on the queried channel.
`java.lang.String`	`getUserAgent()` Gets the user agent.
`java.lang.String`	`getVersion()` Gets version.
`Configuration`	`setAlbumsWrapperClass(java.lang.Class<Albums> klass)` Sets the albums wrapper class.
`Configuration`	`setApiKey(java.lang.String apiKey)` Sets the API Consumer Key.
`Configuration`	`setApiSecret(java.lang.String apiSecret)` Sets the API Consumer Secret.
`Configuration`	`setApplicationName(java.lang.String applicationName)` Sets the application name.
`Configuration`	`setArtistsWrapperClass(java.lang.Class<Artists> klass)` Sets the artists wrapper class.
`Configuration`	`setCredentialDataStore(CredentialDataStore credentialDataStore)` Sets the data store factory.
`Configuration`	`setCredentialRefreshListener(com.google.api.client.auth.oauth2.CredentialRefreshListener refreshListener)` Sets the credential refresh listener for the OAuth dance.
`Configuration`	`setEnvironment(Configuration.Env environment)` Deprecated.
`void`	`setExceptionHandler(ExceptionHandler handler)` Sets a custom `ExceptionHandler`
`Configuration`	`setGenresWrapperClass(java.lang.Class<Genres> klass)` Sets the genres wrapper class.
`Configuration`	`setHttpTransport(com.google.api.client.http.HttpTransport httpTransport)` Sets the HTTP transport.
`Configuration`	`setJsonFactory(com.google.api.client.json.JsonFactory jsonFactory)` Sets the JSON factory.
`Configuration`	`setMediaFileClass(java.lang.Class<MediaFileWrapper> klass)` Sets the media file class.
`Configuration`	`setMediaFilesWrapperClass(java.lang.Class<MediaFiles> klass)` Sets the media files wrapper class.
`Configuration`	`setVersion(java.lang.String version)` Sets your application version.

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

- Constructor Detail
  - Configuration
```
public Configuration()
```
    Initiates a new Configuration ready for production.
  - Configuration
```
public Configuration(Configuration.Env environment)
```
    Initiates a new Configuration.
    
    Parameters:
    environment - the to use.
- Method Detail
  - setApiKey
```
public Configuration setApiKey(java.lang.String apiKey)
```
    Sets the API Consumer Key.
    To get one register your application here: https://audiobox.fm/oauth2/applications
    
    Parameters:
    apiKey - the API Consumer Key
    
    Returns:
    the Configuration
  - setApiSecret
```
public Configuration setApiSecret(java.lang.String apiSecret)
```
    Sets the API Consumer Secret.
    To get one register your application here: https://audiobox.fm/oauth2/applications
    
    Parameters:
    apiSecret - the API Consumer Secret
    
    Returns:
    the Configuration
  - setHttpTransport
```
public Configuration setHttpTransport(com.google.api.client.http.HttpTransport httpTransport)
```
    Sets the HTTP transport.
    Should be one of:
    - NetHttpTransport: based on HttpURLConnection that is found in all Java SDKs, and thus usually the simplest choice.
    - ApacheHttpTransport: based on the popular Apache HttpClient that allows for more customization.
    - UrlFetchTransport: based on URL Fetch Java API in the Google App Engine SDK
    Parameters:
    httpTransport - the http transport
    
    Returns:
    the Configuration
  - setJsonFactory
```
public Configuration setJsonFactory(com.google.api.client.json.JsonFactory jsonFactory)
```
    Sets the JSON factory.
    Should be one of:
    - JacksonFactory: based on the popular Jackson library which is considered the fastest in terms of parsing/serialization speed
    - GsonFactory: based on the Google GSON library which is a lighter-weight option (small size) that is pretty fast also (though not quite as fast as Jackson)
    - AndroidJsonFactory: based on the JSON library built-in to Android Honeycomb (SDK 3.0) or higher that is identical to the Google GSON library
    Parameters:
    jsonFactory - the json factory
    
    Returns:
    the Configuration
  - setCredentialDataStore
```
public Configuration setCredentialDataStore(CredentialDataStore credentialDataStore)
```
    Sets the data store factory.
    You should provide one like FileDataStoreFactory, MemoryDataStoreFactory or implementing one by extending the com.google.api.client.util.store.AbstractDataStoreFactory.
    
    Parameters:
    credentialDataStore - the data store factory
    
    Returns:
    the Configuration
  - setCredentialRefreshListener
```
public Configuration setCredentialRefreshListener(com.google.api.client.auth.oauth2.CredentialRefreshListener refreshListener)
```
    Sets the credential refresh listener for the OAuth dance.
    
    Parameters:
    refreshListener - the CredentialRefreshListener to set
    
    Returns:
    the Configuration
  - setMediaFilesWrapperClass
```
public Configuration setMediaFilesWrapperClass(java.lang.Class<MediaFiles> klass)
```
    Sets the media files wrapper class.
    Use this configuration method to set your own class to use as media files parser.
    Default is MediaFiles.
    
    Parameters:
    klass - the class to use for media files parsing.
    
    Returns:
    the Configuration
  - setAlbumsWrapperClass
```
public Configuration setAlbumsWrapperClass(java.lang.Class<Albums> klass)
```
    Sets the albums wrapper class.
    Use this configuration method to set your own class to use as albums parser.
    Default is Albums.
    
    Parameters:
    klass - the class to use for albums parsing.
    
    Returns:
    the Configuration
  - setGenresWrapperClass
```
public Configuration setGenresWrapperClass(java.lang.Class<Genres> klass)
```
    Sets the genres wrapper class.
    Use this configuration method to set your own class to use as genres parser.
    Default is Genres.
    
    Parameters:
    klass - the class to use for genres parsing.
    
    Returns:
    the Configuration
  - setArtistsWrapperClass
```
public Configuration setArtistsWrapperClass(java.lang.Class<Artists> klass)
```
    Sets the artists wrapper class.
    Use this configuration method to set your own class to use as artists parser.
    Default is Artists.
    
    Parameters:
    klass - the class to use for artists parsing.
    
    Returns:
    the Configuration
  - setMediaFileClass
```
public Configuration setMediaFileClass(java.lang.Class<MediaFileWrapper> klass)
```
    Sets the media file class.
    Use this configuration method to set your own class to use for media file parsing.
    Default is MediaFileWrapper.
    
    Parameters:
    klass - the class to use for artists parsing.
    
    Returns:
    the Configuration
  - setEnvironment
```
@Deprecated
public Configuration setEnvironment(Configuration.Env environment)
```
    Deprecated.
    
    Changes the AudioBox environment (only useful in API development mode).
    Do not use this method if you are working on a production application.
    
    Returns:
    the Configuration
  - setApplicationName
```
public Configuration setApplicationName(java.lang.String applicationName)
```
    Sets the application name.
    
    Parameters:
    applicationName - the application name
    
    Returns:
    the Configuration
  - setVersion
```
public Configuration setVersion(java.lang.String version)
```
    Sets your application version.
    
    Parameters:
    version - the version string
    
    Returns:
    the Configuration
  - setExceptionHandler
```
public void setExceptionHandler(ExceptionHandler handler)
```
    Sets a custom ExceptionHandler
    
    Parameters:
    handler - the ExceptionHandler to use for next (and subsequent) request.
  - getCredentialDataStore
```
public CredentialDataStore getCredentialDataStore()
```
    Gets data store factory.
    
    Returns:
    the data store factory
  - getRefreshListener
```
public com.google.api.client.auth.oauth2.CredentialRefreshListener getRefreshListener()
```
    Gets the credential refresh listener.
    
    Returns:
    the configured CredentialRefreshListener
  - getEnvironmentConfiguration
```
public com.typesafe.config.Config getEnvironmentConfiguration(Configuration.Env environment)
```
    Gets environment configuration.
    
    Parameters:
    environment - the environment
    
    Returns:
    the environment configuration
  - getBaseUrl
```
public java.lang.String getBaseUrl()
```
    Gets API base url.
    
    Returns:
    the env base url (no trailing slash)
  - getBaseUrl
```
public java.lang.String getBaseUrl(Configuration.Channels channel)
```
    Gets env base url based on the queried channel.
    
    Parameters:
    channel - the channel to query
    
    Returns:
    the env base url (no trailing slash)
  - getUnsecureBaseUrl
```
public java.lang.String getUnsecureBaseUrl(Configuration.Channels channel)
```
    Gets env base url based on the queried channel.
    
    Parameters:
    channel - the channel to query
    
    Returns:
    the env base url (no trailing slash)
  - getBaseUrl
```
public java.lang.String getBaseUrl(Configuration.Channels channel,
                          boolean secure)
```
    Gets env base url based on the queried channel.
    
    Parameters:
    channel - the channel to query
    secure - whether to serve SSL protocol (if available for configured Environment) or not.
    
    Returns:
    the env base url (no trailing slash)
  - getEnvHost
```
public java.lang.String getEnvHost(Configuration.Channels channel)
```
    Gets Env base hostname
    
    Parameters:
    channel - the channel to query
    
    Returns:
    the Env based host channel
  - getEnvTokenUrl
```
public com.google.api.client.http.GenericUrl getEnvTokenUrl()
```
    Gets env token url.
    
    Returns:
    the env token url
  - getApiKey
```
public java.lang.String getApiKey()
```
    Gets the API Consumer Key.
    
    Returns:
    the API Consumer Key
  - getApiSecret
```
public java.lang.String getApiSecret()
```
    Gets the API Consumer Secret.
    
    Returns:
    the API Consumer Secret
  - getEnvironment
```
public Configuration.Env getEnvironment()
```
    Gets the environment.
    
    Returns:
    the environment
  - getHttpTransport
```
public com.google.api.client.http.HttpTransport getHttpTransport()
```
    Gets HTTP transport.
    
    Returns:
    the HTTP transport
  - getJsonFactory
```
public com.google.api.client.json.JsonFactory getJsonFactory()
```
    Gets JSON factory.
    
    Returns:
    the JSON factory
  - getMediaFilesWrapperClass
```
public java.lang.Class<MediaFiles> getMediaFilesWrapperClass()
```
    Gets the media files wrapper class.
    
    Returns:
    the class to use for media files parsing.
  - getMediaFileWrapperClass
```
public java.lang.Class<? extends MediaFileWrapper> getMediaFileWrapperClass()
```
    Gets the media file class.
    
    Returns:
    the class to use for media file parsing.
  - getAlbumsWrapperClass
```
public java.lang.Class<? extends Albums> getAlbumsWrapperClass()
```
    Gets the albums wrapper class.
    
    Returns:
    the class to use for albums parsing.
  - getGenresWrapperClass
```
public java.lang.Class<? extends Genres> getGenresWrapperClass()
```
    Gets the genres wrapper class.
    
    Returns:
    the class to use for genres parsing.
  - getArtistsWrapperClass
```
public java.lang.Class<? extends Artists> getArtistsWrapperClass()
```
    Gets the artists wrapper class.
    
    Returns:
    the class to use for artists parsing.
  - getUserAgent
```
public java.lang.String getUserAgent()
```
    Gets the user agent.
    
    Returns:
    the user agent
  - getApplicationName
```
public java.lang.String getApplicationName()
```
    Gets the application name.
    
    Returns:
    the application name
  - getVersion
```
public java.lang.String getVersion()
```
    Gets version.
    
    Returns:
    the version
  - getExceptionHandler
```
public ExceptionHandler getExceptionHandler()
```
    Gets the configured ExceptionHandler
    
    Returns:
    the ExceptionHandler
  - checkConfiguration
```
public void checkConfiguration()
                        throws ConfigurationException
```
    Check configuration.
    
    Throws:
    
    ConfigurationException - the configuration exception

Class Configuration

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Configuration

Configuration

Method Detail

setApiKey

setApiSecret

setHttpTransport

setJsonFactory

setCredentialDataStore

setCredentialRefreshListener

setMediaFilesWrapperClass

setAlbumsWrapperClass

setGenresWrapperClass

setArtistsWrapperClass

setMediaFileClass

setEnvironment

setApplicationName

setVersion

setExceptionHandler

getCredentialDataStore

getRefreshListener

getEnvironmentConfiguration

getBaseUrl

getBaseUrl

getUnsecureBaseUrl

getBaseUrl

getEnvHost

getEnvTokenUrl

getApiKey

getApiSecret

getEnvironment

getHttpTransport

getJsonFactory

getMediaFilesWrapperClass

getMediaFileWrapperClass

getAlbumsWrapperClass

getGenresWrapperClass

getArtistsWrapperClass

getUserAgent

getApplicationName

getVersion

getExceptionHandler

checkConfiguration