LightningClientConfig (lightning-client 0.9.0 API)

java.lang.Object
- com.ebay.lightning.client.config.LightningClientConfig

public class LightningClientConfig
extends Object

Author:: shashukla

Constructor Summary

Constructors
Constructor and Description

LightningClientConfig()

Constructors
Constructor and Description
`LightningClientConfig()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAuditApiUrl()` Get the API URL template for audit data.
`String`	`getAuditJsonApiUrl()` Get the API URL template for audit data in JSON format.
`String`	`getAuditSummaryUrl()` Get the API URL template for audit summary data.
`List<String>`	`getCrossRegionSeeds()` Get the list of stand alone lightning core instances from different colocations.
`String`	`getLightningStatsUrl()` Get the API URL template to fetch lightning statistics.
`int`	`getMaxRetryAttempt()` Get the maximum retry attempt to make reservation with a seed.
`String`	`getPollApiUrl()` Get the API URL template for polling response.
`String`	`getReserveApiUrl()` Get the API URL template for Reservation.
`List<String>`	`getSeeds()` Get the list of stand alone lightning core instances aka seeds
`String`	`getSubmitApiUrl()` Get the API URL template for submit.
`String`	`getSystemConfigUpdateUrl()` Get the API URL template to update system configuration.
`String`	`getSystemConfigUrl()` Get the API URL template to get system configuration.
`boolean`	`isAllowCrossRegionInteraction()` Check if cross region interaction is enabled.\
`boolean`	`isEmbeddedMode()` Check if lightning core runs in embedded mode.
`void`	`setAllowCrossRegionInteraction(boolean allowCrossRegionInteraction)` Enable cross region interaction.
`void`	`setAuditApiUrl(String auditApiUrl)` Set the API URL template for audit data.
`void`	`setAuditJsonApiUrl(String auditJsonApiUrl)` Set the API URL template for audit data in JSON format.
`void`	`setAuditSummaryUrl(String auditSummaryUrl)` Set the API URL template for audit summary data.
`void`	`setCrossRegionSeeds(List<String> crossRegionSeeds)` Set the list of stand alone lightning core instances from different colocations.
`void`	`setEmbeddedMode(boolean embeddedMode)` Set the lightning core to run in embedded mode.
`void`	`setLightningStatsUrl(String lightningStatsUrl)` Set the API URL template to get lightning statistics.
`void`	`setMaxRetryAttempt(int maxRetryAttempt)` Set the maximum retry attempt to make reservation with a seed.
`void`	`setPollApiUrl(String pollApiUrl)` Set the API URL template for Polling.
`void`	`setReserveApiUrl(String reserveApiUrl)` Set the API URL template for Reservation.
`void`	`setSeeds(List<String> seeds)` Set the list of stand alone lightning core instances aka seeds.
`void`	`setSubmitApiUrl(String submitApiUrl)` Set the API URL template for submitting request.
`void`	`setSystemConfigUpdateUrl(String systemConfigUpdateUrl)` Set the API URL template to update system configuration.
`void`	`setSystemConfigUrl(String systemConfigUrl)` Set the API URL template to get system configuration.

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

- Constructor Detail
  - LightningClientConfig
```
public LightningClientConfig()
```
- Method Detail
  - getReserveApiUrl
```
public String getReserveApiUrl()
```
    Get the API URL template for Reservation.
    
    Returns:
    
    the API URL template for Reservation
  - setReserveApiUrl
```
public void setReserveApiUrl(String reserveApiUrl)
```
    Set the API URL template for Reservation.
    Format: http://{hostname}:[port]/[some/reservation/url]
    Example: http://{host}:8989/l/reserve
    
    Parameters:
    
    reserveApiUrl - the URL template for making reservation
  - getSubmitApiUrl
```
public String getSubmitApiUrl()
```
    Get the API URL template for submit.
    
    Returns:
    
    the API URL template for submit
  - setSubmitApiUrl
```
public void setSubmitApiUrl(String submitApiUrl)
```
    Set the API URL template for submitting request.
    Format: http://{hostname}:[port]/[some/submit/url]
    Example: http://{host}:8989/l/submit
    
    Parameters:
    
    submitApiUrl - the URL template for submitting tasks
  - getPollApiUrl
```
public String getPollApiUrl()
```
    Get the API URL template for polling response.
    
    Returns:
    
    the API URL template for polling response
  - setPollApiUrl
```
public void setPollApiUrl(String pollApiUrl)
```
    Set the API URL template for Polling.
    Format: http://{hostname}:[port]/[some/poll/url]
    Example: http://{host}:8989/l/poll
    
    Parameters:
    
    pollApiUrl - the URL template for polling response
  - getSeeds
```
public List<String> getSeeds()
```
    Get the list of stand alone lightning core instances aka seeds
    
    Returns:
    
    the list of seeds
  - setSeeds
```
public void setSeeds(List<String> seeds)
```
    Set the list of stand alone lightning core instances aka seeds. The seeds are considered only when embeddedMode is set to false.
    
    Parameters:
    
    seeds - the list of host names running lightning core
  - getAuditApiUrl
```
public String getAuditApiUrl()
```
    Get the API URL template for audit data.
    
    Returns:
    
    the API URL template for audit data
  - setAuditApiUrl
```
public void setAuditApiUrl(String auditApiUrl)
```
    Set the API URL template for audit data.
    Format: http://{hostname}:[port]/[some/audit/url]
    Example: http://{host}:8989/l/audit
    
    Parameters:
    
    auditApiUrl - the URL template to get compressed audit data
  - getLightningStatsUrl
```
public String getLightningStatsUrl()
```
    Get the API URL template to fetch lightning statistics.
    
    Returns:
    
    the API URL template to fetch lightning statistics
  - setLightningStatsUrl
```
public void setLightningStatsUrl(String lightningStatsUrl)
```
    Set the API URL template to get lightning statistics.
    Format: http://{hostname}:[port]/[lightningStatsUrl]
    Example: http://{host}:8989/l/lightningStats
    
    Parameters:
    
    lightningStatsUrl - the URL template to get lightning statistics
  - getAuditSummaryUrl
```
public String getAuditSummaryUrl()
```
    Get the API URL template for audit summary data.
    
    Returns:
    
    the API URL template for audit summary data
  - setAuditSummaryUrl
```
public void setAuditSummaryUrl(String auditSummaryUrl)
```
    Set the API URL template for audit summary data.
    Format: http://{hostname}:[port]/[some/auditSummary/url]
    Example: http://{host}:8989/l/auditSummary
    
    Parameters:
    
    auditSummaryUrl - the URL template to get audit summary data
  - getMaxRetryAttempt
```
public int getMaxRetryAttempt()
```
    Get the maximum retry attempt to make reservation with a seed.
    
    Returns:
    
    the maximum retry attempt to make reservation with a seed
  - setMaxRetryAttempt
```
public void setMaxRetryAttempt(int maxRetryAttempt)
```
    Set the maximum retry attempt to make reservation with a seed.
    
    Parameters:
    
    maxRetryAttempt - the maximum retry attempt
  - getSystemConfigUrl
```
public String getSystemConfigUrl()
```
    Get the API URL template to get system configuration.
    
    Returns:
    
    the API URL template to get system configuration
  - setSystemConfigUrl
```
public void setSystemConfigUrl(String systemConfigUrl)
```
    Set the API URL template to get system configuration.
    Format: http://{hostname}:[port]/[getSystemConfigUrl]
    Example: http://{host}:8989/l/getSystemConfig
    
    Parameters:
    
    systemConfigUrl - the URL template to get system configuration
  - getSystemConfigUpdateUrl
```
public String getSystemConfigUpdateUrl()
```
    Get the API URL template to update system configuration.
    
    Returns:
    
    the API URL template to update system configuration
  - setSystemConfigUpdateUrl
```
public void setSystemConfigUpdateUrl(String systemConfigUpdateUrl)
```
    Set the API URL template to update system configuration.
    Format: http://{hostname}:[port]/[updateSystemConfigUrl]
    Example: http://{host}:8989/l/updateSystemConfig
    
    Parameters:
    
    systemConfigUpdateUrl - the URL template to update system configuration
  - getAuditJsonApiUrl
```
public String getAuditJsonApiUrl()
```
    Get the API URL template for audit data in JSON format.
    
    Returns:
    
    the API URL template for audit data in JSON format
  - setAuditJsonApiUrl
```
public void setAuditJsonApiUrl(String auditJsonApiUrl)
```
    Set the API URL template for audit data in JSON format.
    Format: http://{hostname}:[port]/[some/audit/url]
    Example: http://{host}:8989/l/audit/json
    
    Parameters:
    
    auditJsonApiUrl - the URL template to get audit data in JSON format
  - isEmbeddedMode
```
public boolean isEmbeddedMode()
```
    Check if lightning core runs in embedded mode.
    
    Returns:
    
    true if the core runs in embedded mode
  - setEmbeddedMode
```
public void setEmbeddedMode(boolean embeddedMode)
```
    Set the lightning core to run in embedded mode. If set to true, the lightning core will run in embedded mode. If set to false, lightning core will run in standalone mode and has to be registered with client by calling setSeeds(List) method.
    
    Parameters:
    
    embeddedMode - to run lightning core in embedded mode or standalone mode
  - isAllowCrossRegionInteraction
```
public boolean isAllowCrossRegionInteraction()
```
    Check if cross region interaction is enabled.\
    
    Returns:
    
    true if cross region interaction is enabled
  - setAllowCrossRegionInteraction
```
public void setAllowCrossRegionInteraction(boolean allowCrossRegionInteraction)
```
    Enable cross region interaction. If set to false, tasks will only be submitted to lightning core running on the same colocation. If set to true, tasks will be submitted to lightning core running on different colocation, if all the lightning core instances running in the local colocations are busy.
    
    Parameters:
    
    allowCrossRegionInteraction - to allow submitting task to lightning core running on different colocation
  - getCrossRegionSeeds
```
public List<String> getCrossRegionSeeds()
```
    Get the list of stand alone lightning core instances from different colocations.
    
    Returns:
    
    the cross region seeds
  - setCrossRegionSeeds
```
public void setCrossRegionSeeds(List<String> crossRegionSeeds)
```
    Set the list of stand alone lightning core instances from different colocations. The cross region seeds are considered only when allowCrossRegionInteraction is set to true
    
    Parameters:
    
    crossRegionSeeds - the list of host names on different colocations running lightning core.

Class LightningClientConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LightningClientConfig

Method Detail

getReserveApiUrl

setReserveApiUrl

getSubmitApiUrl

setSubmitApiUrl

getPollApiUrl

setPollApiUrl

getSeeds

setSeeds

getAuditApiUrl

setAuditApiUrl

getLightningStatsUrl

setLightningStatsUrl

getAuditSummaryUrl

setAuditSummaryUrl

getMaxRetryAttempt

setMaxRetryAttempt

getSystemConfigUrl

setSystemConfigUrl

getSystemConfigUpdateUrl

setSystemConfigUpdateUrl

getAuditJsonApiUrl

setAuditJsonApiUrl

isEmbeddedMode

setEmbeddedMode

isAllowCrossRegionInteraction

setAllowCrossRegionInteraction

getCrossRegionSeeds

setCrossRegionSeeds