Configuration (Infobip OneAPI Client 0.0.1 API)

java.lang.Object
- oneapi.config.Configuration

public class Configuration
extends Object

Constructor Summary

Constructors
Constructor and Description
`Configuration()` Initialize configuration object, Login have to be done after initialization
`Configuration(boolean loadFromFile)` Initialize Configuration object
`Configuration(String accessToken)` Initialize configuration object using the 'OAuth' Authentication
`Configuration(String username, String password)` Initialize configuration object using the 'IBSSO' Authentication credentials
`Configuration(String messagingBaseUrl, String versionOneAPISMS, String accessToken)` Initialize configuration object using the 'OAuth' Authentication
`Configuration(String messagingBaseUrl, String versionOneAPISMS, String username, String password)` Initialize configuration object using the 'IBSSO' Authentication credentials

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getApiUrl()` Base URL containing host name and port of the OneAPI SMS server
`Authentication`	`getAuthentication()` Object containing 'OneAPI' Authentication data
`int`	`getDlrRetrievingInterval()` Interval to automatically pool delivery reports in milliseconds
`int`	`getDlrStatusPushServerSimulatorPort()` Delivery Notification Status Push server port (default = 3000)
`int`	`getHlrPushServerSimulatorPort()` HLR Notifications Push server port (default = 3002)
`int`	`getInboundMessagesPushServerSimulatorPort()` Inbound Messages Notifications Push server port (default = 3001)
`int`	`getInboundMessagesRetrievingInterval()` Interval to automatically pool inbounds messages in milliseconds
`String`	`getVersionOneAPISMS()` Version of OneAPI SMS you are accessing (the default is the latest version supported by that server)
`void`	`load()` Load data from the configuration file
`void`	`save()` Save data to the configuration file
`void`	`setApiUrl(String apiUrl)` Base URL containing host name and port of the OneAPI SMS server
`void`	`setAuthentication(Authentication value)` Object containing 'OneAPI' Authentication data
`void`	`setDlrRetrievingInterval(int dlrRetrievingInterval)` Interval to automatically pool delivery reports in milliseconds
`void`	`setDlrStatusPushServerSimulatorPort(int dlrStatusPushServerSimulatorPort)` Delivery Notification Status Push server port (default = 3000)
`void`	`setHlrPushServerSimulatorPort(int hlrPushServerSimulatorPort)` HLR Notifications Push server port (default = 3002)
`void`	`setInboundMessagesPushServerSimulatorPort(int inboundMessagesPushServerSimulatorPort)` Inbound Messages Notifications Push server port (default = 3001)
`void`	`setInboundMessagesRetrievingInterval(int inboundMessagesRetrievingInterval)` Interval to automatically pool inbounds messages in milliseconds
`void`	`setVersionOneAPISMS(String versionOneAPISMS)` Version of OneAPI SMS you are accessing (the default is the latest version supported by that server)

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

- Constructor Detail
  - Configuration
```
public Configuration()
```
    Initialize configuration object, Login have to be done after initialization
  - Configuration
```
public Configuration(boolean loadFromFile)
```
    Initialize Configuration object
    
    Parameters:
    
    loadFromFile - determines if data will be loaded from the configuration file
  - Configuration
```
public Configuration(String username,
                     String password)
```
    Initialize configuration object using the 'IBSSO' Authentication credentials
    
    Parameters:
    
    username - - 'IBSSO' Authentication user name
    
    password - - 'IBSSO' Authentication password
  - Configuration
```
public Configuration(String accessToken)
```
    Initialize configuration object using the 'OAuth' Authentication
    
    Parameters:
    
    accessToken - - 'OAuth' Authentication Access Token
  - Configuration
```
public Configuration(String messagingBaseUrl,
                     String versionOneAPISMS,
                     String username,
                     String password)
```
    Initialize configuration object using the 'IBSSO' Authentication credentials
    
    Parameters:
    
    messagingBaseUrl - - Base URL containing host name and port of the OneAPI SMS server
    
    versionOneAPISMS - - Version of OneAPI SMS you are accessing (the default is the latest version supported by that server)
    
    username - - 'IBSSO' Authentication user name
    
    password - - 'IBSSO' Authentication password
  - Configuration
```
public Configuration(String messagingBaseUrl,
                     String versionOneAPISMS,
                     String accessToken)
```
    Initialize configuration object using the 'OAuth' Authentication
    
    Parameters:
    
    messagingBaseUrl - - Base URL containing host name and port of the OneAPI SMS server
    
    versionOneAPISMS - - Version of OneAPI SMS you are accessing (the default is the latest version supported by that server)
    
    accessToken - - 'OAuth' Authentication Access Token
- Method Detail
  - load
```
public void load()
```
    Load data from the configuration file
  - save
```
public void save()
```
    Save data to the configuration file
  - getAuthentication
```
public Authentication getAuthentication()
```
    Object containing 'OneAPI' Authentication data
    
    Returns:
    
    Authentication
  - setAuthentication
```
public void setAuthentication(Authentication value)
```
    Object containing 'OneAPI' Authentication data
  - getApiUrl
```
public String getApiUrl()
```
    Base URL containing host name and port of the OneAPI SMS server
    
    Returns:
    
    messagingBaseUrl
  - setApiUrl
```
public void setApiUrl(String apiUrl)
```
    Base URL containing host name and port of the OneAPI SMS server
  - getVersionOneAPISMS
```
public String getVersionOneAPISMS()
```
    Version of OneAPI SMS you are accessing (the default is the latest version supported by that server)
    
    Returns:
    
    versionOneAPISMS
  - setVersionOneAPISMS
```
public void setVersionOneAPISMS(String versionOneAPISMS)
```
    Version of OneAPI SMS you are accessing (the default is the latest version supported by that server)
  - getInboundMessagesRetrievingInterval
```
public int getInboundMessagesRetrievingInterval()
```
    Interval to automatically pool inbounds messages in milliseconds
    
    Returns:
    
    inboundMessagesRetrievingInterval
  - setInboundMessagesRetrievingInterval
```
public void setInboundMessagesRetrievingInterval(int inboundMessagesRetrievingInterval)
```
    Interval to automatically pool inbounds messages in milliseconds
  - getDlrRetrievingInterval
```
public int getDlrRetrievingInterval()
```
    Interval to automatically pool delivery reports in milliseconds
    
    Returns:
    
    dlrRetrievingInterval
  - setDlrRetrievingInterval
```
public void setDlrRetrievingInterval(int dlrRetrievingInterval)
```
    Interval to automatically pool delivery reports in milliseconds
  - getDlrStatusPushServerSimulatorPort
```
public int getDlrStatusPushServerSimulatorPort()
```
    Delivery Notification Status Push server port (default = 3000)
    
    Returns:
    
    dlrStatusPushServerSimulatorPort
  - setDlrStatusPushServerSimulatorPort
```
public void setDlrStatusPushServerSimulatorPort(int dlrStatusPushServerSimulatorPort)
```
    Delivery Notification Status Push server port (default = 3000)
  - getInboundMessagesPushServerSimulatorPort
```
public int getInboundMessagesPushServerSimulatorPort()
```
    Inbound Messages Notifications Push server port (default = 3001)
    
    Returns:
    
    inboundMessagesPushServerSimulatorPort
  - setInboundMessagesPushServerSimulatorPort
```
public void setInboundMessagesPushServerSimulatorPort(int inboundMessagesPushServerSimulatorPort)
```
    Inbound Messages Notifications Push server port (default = 3001)
  - getHlrPushServerSimulatorPort
```
public int getHlrPushServerSimulatorPort()
```
    HLR Notifications Push server port (default = 3002)
    
    Returns:
    
    hlrPushServerSimulatorPort
  - setHlrPushServerSimulatorPort
```
public void setHlrPushServerSimulatorPort(int hlrPushServerSimulatorPort)
```
    HLR Notifications Push server port (default = 3002)

Class Configuration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Configuration

Configuration

Configuration

Configuration

Configuration

Configuration

Method Detail

load

save

getAuthentication

setAuthentication

getApiUrl

setApiUrl

getVersionOneAPISMS

setVersionOneAPISMS

getInboundMessagesRetrievingInterval

setInboundMessagesRetrievingInterval

getDlrRetrievingInterval

setDlrRetrievingInterval

getDlrStatusPushServerSimulatorPort

setDlrStatusPushServerSimulatorPort

getInboundMessagesPushServerSimulatorPort

setInboundMessagesPushServerSimulatorPort

getHlrPushServerSimulatorPort

setHlrPushServerSimulatorPort