Configuration (amadeus-java 6.1.0 API)

java.lang.Object
- com.amadeus.Configuration

public class Configuration
extends java.lang.Object

The configuration for the Amadeus API client. To initialize, use the builder as follows:

 Amadeus amadeus =
     Amadeus.builder("REPLACE_BY_YOUR_API_KEY", "REPLACE_BY_YOUR_API_SECRET").build();

Or pass in environment variables directly:

 Amadeus.builder(System.getenv()).build();

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Amadeus`	`build()` Builds an Amadeus client with the provided credentials.
`java.lang.String`	`getClientId()` The client ID used to authenticate the API calls.
`java.lang.String`	`getClientSecret()` The client secret used to authenticate the API calls.
`java.lang.String`	`getCustomAppId()` An optional custom App ID to be passed in the User Agent to the server (Defaults to null).
`java.lang.String`	`getCustomAppVersion()` An optional custom App version to be passed in the User Agent to the server (Defaults to null).
`java.lang.String`	`getHost()` The optional custom host domain to use for API calls.
`java.lang.String`	`getHostname()` The the name of the server API calls are made to, 'production' or 'test'.
`java.util.logging.Logger`	`getLogger()` The logger that will be used to debug or warn to.
`java.lang.String`	`getLogLevel()` The log level.
`int`	`getPort()` The port to use.
`boolean`	`isSsl()` Wether to use SSL.
`Configuration`	`setCustomAppId(java.lang.String customAppId)` An optional custom App ID to be passed in the User Agent to the server (Defaults to null).
`Configuration`	`setCustomAppVersion(java.lang.String customAppVersion)` An optional custom App version to be passed in the User Agent to the server (Defaults to null).
`Configuration`	`setHost(java.lang.String host)` The optional custom host domain to use for API calls.
`Configuration`	`setHostname(java.lang.String hostname)` The the name of the server API calls are made to, 'production' or 'test'.
`Configuration`	`setLogger(java.util.logging.Logger logger)` The logger that will be used to debug or warn to.
`Configuration`	`setLogLevel(java.lang.String logLevel)` The log level.
`Configuration`	`setPort(int port)` The port to use.
`Configuration`	`setSsl(java.lang.Boolean ssl)` Whether to use SSL.
`java.lang.String`	`toString()`

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

- Method Detail
  - build
```
public Amadeus build()
              throws java.lang.NullPointerException
```
    Builds an Amadeus client with the provided credentials.
    
    Returns:
    
    an Amadeus client
    
    Throws:
    
    java.lang.NullPointerException - when a client ID or client secret is missing
  - setHostname
```
public Configuration setHostname(java.lang.String hostname)
```
    The the name of the server API calls are made to, 'production' or 'test'. Defaults to 'test'.
    
    Parameters:
    
    hostname - The name of the server API calls are made to
    
    Returns:
    
    The name of the server API calls are made to
  - setSsl
```
public Configuration setSsl(java.lang.Boolean ssl)
```
    Whether to use SSL. Defaults to True.
    
    Parameters:
    
    ssl - A boolean specifying if the connection should use SSL
    
    Returns:
    
    A boolean specifying if the connection should use SSL
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getClientId
```
public java.lang.String getClientId()
```
    The client ID used to authenticate the API calls.
    
    Returns:
    
    The client ID
  - getClientSecret
```
public java.lang.String getClientSecret()
```
    The client secret used to authenticate the API calls.
    
    Returns:
    
    The client secret
  - getLogger
```
public java.util.logging.Logger getLogger()
```
    The logger that will be used to debug or warn to.
    
    Returns:
    
    The logger object
  - setLogger
```
public Configuration setLogger(java.util.logging.Logger logger)
```
    The logger that will be used to debug or warn to.
    
    Parameters:
    
    logger - The logger object
    
    Returns:
    
    this.
  - getLogLevel
```
public java.lang.String getLogLevel()
```
    The log level. Can be 'silent', 'warn', or 'debug'. Defaults to 'silent'.
    
    Returns:
    
    The log level for the logger
  - setLogLevel
```
public Configuration setLogLevel(java.lang.String logLevel)
```
    The log level. Can be 'silent', 'warn', or 'debug'. Defaults to 'silent'.
    
    Parameters:
    
    logLevel - The log level for the logger
    
    Returns:
    
    this.
  - getHostname
```
public java.lang.String getHostname()
```
    The the name of the server API calls are made to, 'production' or 'test'. Defaults to 'test'
    
    Returns:
    
    The name of the server API calls are made to
  - getHost
```
public java.lang.String getHost()
```
    The optional custom host domain to use for API calls. Defaults to internal value for 'hostname'.
    
    Returns:
    
    The optional custom host domain to use for API calls.
  - setHost
```
public Configuration setHost(java.lang.String host)
```
    The optional custom host domain to use for API calls. Defaults to internal value for 'hostname'.
    
    Parameters:
    
    host - The optional custom host domain to use for API calls.
    
    Returns:
    
    this.
  - isSsl
```
public boolean isSsl()
```
    Wether to use SSL. Defaults to True
    
    Returns:
    
    A boolean specifying if the connection should use SSL
  - getPort
```
public int getPort()
```
    The port to use. Defaults to 443 for an SSL connection, and 80 for a non SSL connection.
    
    Returns:
    
    The port to use for the connection
  - setPort
```
public Configuration setPort(int port)
```
    The port to use. Defaults to 443 for an SSL connection, and 80 for a non SSL connection.
    
    Parameters:
    
    port - The port to use for the connection
    
    Returns:
    
    this.
  - getCustomAppId
```
public java.lang.String getCustomAppId()
```
    An optional custom App ID to be passed in the User Agent to the server (Defaults to null).
    
    Returns:
    
    The optional custom App ID
  - setCustomAppId
```
public Configuration setCustomAppId(java.lang.String customAppId)
```
    An optional custom App ID to be passed in the User Agent to the server (Defaults to null).
    
    Parameters:
    
    customAppId - An optional custom App ID
    
    Returns:
    
    this.
  - getCustomAppVersion
```
public java.lang.String getCustomAppVersion()
```
    An optional custom App version to be passed in the User Agent to the server (Defaults to null).
    
    Returns:
    
    The optional custom App version
  - setCustomAppVersion
```
public Configuration setCustomAppVersion(java.lang.String customAppVersion)
```
    An optional custom App version to be passed in the User Agent to the server (Defaults to null).
    
    Parameters:
    
    customAppVersion - An optional custom App version
    
    Returns:
    
    this.

Class Configuration

Method Summary

Methods inherited from class java.lang.Object

Method Detail

build

setHostname

setSsl

toString

getClientId

getClientSecret

getLogger

setLogger

getLogLevel

setLogLevel

getHostname

getHost

setHost

isSsl

getPort

setPort

getCustomAppId

setCustomAppId

getCustomAppVersion

setCustomAppVersion