LeoProperties (Leo Parent Project 2018.01.0 API)

java.lang.Object
- gov.va.vinci.leo.tools.LeoProperties

Direct Known Subclasses:

Client, Service
```
public abstract class LeoProperties
extends Object
```
Handles loading Properties from the leo.properties file including setting defaults initially and storing values we expect from that properties file.

Author:

thomasginter

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`BROKERURL_DEFAULT` Default value for the Broker URL.
`static String`	`ENDPOINT_DEFAULT` Default value for the Endpoint Queue Name, Queue name should be unique for each application.
`static org.apache.log4j.Logger`	`LOG` Logging object of output.
`protected String`	`mAggregateDescriptorFile` File path to the aggregate descriptor.
`protected String`	`mBrokerURL` Broker URL for the remote service.
`protected int`	`mCasPoolSize` CAS pool size determines the max number of requests that can be outstanding.
`protected int`	`mCCTimeout` CAS complete timeout in seconds.
`protected boolean`	`mDeleteOnExit` Should the generated XML descriptors be deleted on program exit? Default is true.
`protected String`	`mDeploymentDescriptorFile` File path to the deployment descriptor for the AS service that will be deployed.
`protected String`	`mDescriptorDirectory` The path to the directory where descriptors will be generated.
`protected String`	`mEndpoint` Endpoint or Input Queue Name for the service.
`protected int`	`mFSHeapSize` FS heap size in bytes of each CAS in the pool.
`protected int`	`mInitTimeout` Initialization timeout period in seconds.
`protected int`	`mJamJmxPort` If registering with JAM, this is the port the local JMX Server will listen on.
`protected int`	`mJamQueryIntervalInSeconds` If registering with JAM, what is the monitor query interval in seconds.
`protected boolean`	`mJamResetStatisticsAfterQuery` If registering with JAM, should statistics be reset after each gather? Default is true.
`protected String`	`mJamServerBaseUrl` The base url for the Jam (JMX Analytics Monitoring) server if available.
`protected String`	`mPropertiesFile` Name and location of the properties file.
`protected String`	`mServiceName` Name of the service for deployment.
`protected int`	`mTimeout` Timeout period in seconds.
`static String`	`PROPERTIES_DEFAULT` Default value for the Properties File path.

Constructor Summary

Constructors
Constructor and Description

LeoProperties()

Constructors
Constructor and Description
`LeoProperties()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAggregateDescriptorFile()` File path to the aggregate descriptor.
`String`	`getBrokerURL()` Get the broker url.
`int`	`getCasPoolSize()` get the cas pool size.
`int`	`getCCTimeout()` Get the CCTimeout.
`String`	`getDeploymentDescriptorFile()` The deployment descriptor file path and name.
`String`	`getDescriptorDirectory()` Get the path to the directory where descriptors will be generated.
`String`	`getEndpoint()` get the endpoint.
`int`	`getFSHeapSize()` Get FS Heap Size.
`int`	`getInitTimeout()` Get the init timeout.
`String`	`getInputQueueName()` Get the input queue name.
`int`	`getJamJmxPort()` If registering with JAM, this is the port the local JMX Server will listen on.
`int`	`getJamQueryIntervalInSeconds()` Get the JAM Query Interval in seconds.
`String`	`getJamServerBaseUrl()` Get the Jam Server Base URL.
`String`	`getServiceName()` Get the service name.
`int`	`getTimeout()` Set timeout.
`boolean`	`isDeleteOnExit()` TRUE if generated descriptors will be deleted when the program exits, FALSE otherwise.
`boolean`	`isJamResetStatisticsAfterQuery()` Reset statistics after jam query.
`protected void`	`loadDefaults()` Load default values for required parameters.
`protected void`	`loadProperties(Properties properties)` Load the properties from a properties object.
`protected void`	`loadprops()` Load the properties from the properties file that will be used for execution.
`void`	`loadprops(String propertiesFile)` Load the properties file specified by the user.
`void`	`setAggregateDescriptorFile(String mAggregateDescriptorFile)` Set the file path to the aggregate descriptor.
`<T extends LeoProperties> T`	`setBrokerURL(String mBrokerURL)` set the broker url.
`<T extends LeoProperties> T`	`setCasPoolSize(Integer mCasPoolSize)` Set the size of the CAS pool.
`<T extends LeoProperties> T`	`setCCTimeout(Integer mCCTimeout)` CAS complete timeout in seconds.
`<T extends LeoProperties> T`	`setDeleteOnExit(boolean mDeleteOnExit)` Set the flag to TRUE if generated descriptors should be deleted on program exit.
`<T extends LeoProperties> T`	`setDeploymentDescriptorFile(String mDeploymentDescriptorFile)` Set the existing Deployment Descriptor file to use.
`<T extends LeoProperties> T`	`setDescriptorDirectory(String mDescriptorDirectory)` Set the directory path where generated descriptors will be generated.
`<T extends LeoProperties> T`	`setEndpoint(String mEndpoint)` Set the "InputQueueName" for this service.
`<T extends LeoProperties> T`	`setFSHeapSize(int mFSHeapSize)` Size of the FS heap in bytes of each CAS in the pool.
`<T extends LeoProperties> T`	`setInitTimeout(int mInitTimeout)` Initialization timeout period in seconds.
`<T extends LeoProperties> T`	`setInputQueueName(String mInputQueueName)` Set the "InputQueueName" for this service.
`<T extends LeoProperties> T`	`setJamJmxPort(Integer port)` If registering with JAM, this is the port the local JMX Server will listen on.
`<T extends LeoProperties> T`	`setJamQueryIntervalInSeconds(Integer mJamQueryIntervalInSeconds)` If registering with JAM, the monitor query interval in seconds.
`<T extends LeoProperties> T`	`setJamResetStatisticsAfterQuery(Boolean mJamResetStatisticsAfterQuery)` If registering with JAM, should statistics be reset after each gather? Default is true.
`<T extends LeoProperties> T`	`setJamServerBaseUrl(String mJamServerBaseUrl)` The base URL for the JAM (JMX Analytics Monitoring) server if available.
`<T extends LeoProperties> T`	`setServiceName(String mServiceName)` Optional, name of the service to deploy.
`<T extends LeoProperties> T`	`setTimeout(int mTimeout)` Timeout period in seconds.

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

- Field Detail
  - mPropertiesFile
```
protected String mPropertiesFile
```
    Name and location of the properties file.
  - mDeploymentDescriptorFile
```
protected String mDeploymentDescriptorFile
```
    File path to the deployment descriptor for the AS service that will be deployed.
  - mServiceName
```
protected String mServiceName
```
    Name of the service for deployment.
  - mAggregateDescriptorFile
```
protected String mAggregateDescriptorFile
```
    File path to the aggregate descriptor.
  - mBrokerURL
```
protected String mBrokerURL
```
    Broker URL for the remote service.
  - mEndpoint
```
protected String mEndpoint
```
    Endpoint or Input Queue Name for the service.
  - mDescriptorDirectory
```
protected String mDescriptorDirectory
```
    The path to the directory where descriptors will be generated. By default this path is null as descriptors are generated in the tmp directory of the system.
  - mCasPoolSize
```
protected int mCasPoolSize
```
    CAS pool size determines the max number of requests that can be outstanding.
  - mFSHeapSize
```
protected int mFSHeapSize
```
    FS heap size in bytes of each CAS in the pool.
  - mTimeout
```
protected int mTimeout
```
    Timeout period in seconds. If a CAS does not return within this time period it is considered an error. Default is wait forever.
  - mInitTimeout
```
protected int mInitTimeout
```
    Initialization timeout period in seconds. If initialization request does not return within this time it is considered an error. Default is 60 seconds
  - mCCTimeout
```
protected int mCCTimeout
```
    CAS complete timeout in seconds. Once all CAS requests are complete a collection process complete command is sent. Default is wait forever
  - mJamServerBaseUrl
```
protected String mJamServerBaseUrl
```
    The base url for the Jam (JMX Analytics Monitoring) server if available.
  - mJamQueryIntervalInSeconds
```
protected int mJamQueryIntervalInSeconds
```
    If registering with JAM, what is the monitor query interval in seconds. default is 60*60 (1 hour)
  - mJamResetStatisticsAfterQuery
```
protected boolean mJamResetStatisticsAfterQuery
```
    If registering with JAM, should statistics be reset after each gather? Default is true.
  - mJamJmxPort
```
protected int mJamJmxPort
```
    If registering with JAM, this is the port the local JMX Server will listen on. If this is -1, the service will find and use a local open port.
  - mDeleteOnExit
```
protected boolean mDeleteOnExit
```
    Should the generated XML descriptors be deleted on program exit? Default is true.
  - LOG
```
public static final org.apache.log4j.Logger LOG
```
    Logging object of output.
  - BROKERURL_DEFAULT
```
public static final String BROKERURL_DEFAULT
```
    Default value for the Broker URL.
    
    See Also:
    
    Constant Field Values
  - ENDPOINT_DEFAULT
```
public static final String ENDPOINT_DEFAULT
```
    Default value for the Endpoint Queue Name, Queue name should be unique for each application.
    
    See Also:
    
    Constant Field Values
  - PROPERTIES_DEFAULT
```
public static final String PROPERTIES_DEFAULT
```
    Default value for the Properties File path.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - LeoProperties
```
public LeoProperties()
```
- Method Detail
  - loadDefaults
```
protected void loadDefaults()
```
    Load default values for required parameters.
  - loadprops
```
public void loadprops(String propertiesFile)
               throws Exception
```
    Load the properties file specified by the user. Supported properties: brokerURL casPoolSize ccTimeout deleteOnExit deploymentDescriptor descriptorPath endpoint fsHeapSize initTimeout jamJmxPort jamQueryIntervalInSeconds jamResetStatisticsAfterQuery jamServerBaseUrl serviceName timeout
    
    Parameters:
    
    propertiesFile - Path to the properties file to be loaded
    
    Throws:
    
    Exception - If unable to load the properties file
  - loadprops
```
protected void loadprops()
                  throws Exception
```
    Load the properties from the properties file that will be used for execution.
    
    Throws:
    
    Exception - if the properties file cannot be found or loaded.
  - loadProperties
```
protected void loadProperties(Properties properties)
                       throws FileNotFoundException
```
    Load the properties from a properties object. Note, properties that are in the properties object, but not one of the below, are just ignored. Supported properties: brokerURL casPoolSize ccTimeout deleteOnExit deploymentDescriptor descriptorPath endpoint fsHeapSize initTimeout jamJmxPort jamQueryIntervalInSeconds jamResetStatisticsAfterQuery jamServerBaseUrl serviceName timeout
    
    Parameters:
    
    properties - The properties object to get properties from.
    
    Throws:
    
    Exception - if the properties file cannot be found or loaded.
    
    FileNotFoundException
  - getDeploymentDescriptorFile
```
public String getDeploymentDescriptorFile()
```
    The deployment descriptor file path and name.
    
    Returns:
    
    the DeploymentDescriptorFile
  - setDeploymentDescriptorFile
```
public <T extends LeoProperties> T setDeploymentDescriptorFile(String mDeploymentDescriptorFile)
```
    Set the existing Deployment Descriptor file to use.
    
    Parameters:
    
    mDeploymentDescriptorFile - the DeploymentDescriptorFile to set
    
    Returns:
    
    reference to this instance
  - getServiceName
```
public String getServiceName()
```
    Get the service name.
    
    Returns:
    
    the ServiceName
  - setServiceName
```
public <T extends LeoProperties> T setServiceName(String mServiceName)
```
    Optional, name of the service to deploy.
    
    Parameters:
    
    mServiceName - the ServiceName to set
    
    Returns:
    
    reference to this instance
  - getBrokerURL
```
public String getBrokerURL()
```
    Get the broker url.
    
    Returns:
    
    the BrokerURL
  - setBrokerURL
```
public <T extends LeoProperties> T setBrokerURL(String mBrokerURL)
```
    set the broker url.
    
    Parameters:
    
    mBrokerURL - the BrokerURL to set
    
    Returns:
    
    reference to this instance
  - getEndpoint
```
public String getEndpoint()
```
    get the endpoint.
    
    Returns:
    
    the Endpoint
  - setEndpoint
```
public <T extends LeoProperties> T setEndpoint(String mEndpoint)
```
    Set the "InputQueueName" for this service.
    
    Parameters:
    
    mEndpoint - the Endpoint to set
    
    Returns:
    
    reference to this instance
  - getInputQueueName
```
public String getInputQueueName()
```
    Get the input queue name.
    
    Returns:
    
    the InputQueueName
  - setInputQueueName
```
public <T extends LeoProperties> T setInputQueueName(String mInputQueueName)
```
    Set the "InputQueueName" for this service.
    
    Parameters:
    
    mInputQueueName - the input queue name for this service.
    
    Returns:
    
    reference to this instance
  - getCasPoolSize
```
public int getCasPoolSize()
```
    get the cas pool size.
    
    Returns:
    
    the mCasPoolSize
  - setCasPoolSize
```
public <T extends LeoProperties> T setCasPoolSize(Integer mCasPoolSize)
```
    Set the size of the CAS pool. This figure is auto-increased by Leo to match the largest number of replicated objects in the service definition.
    
    Parameters:
    
    mCasPoolSize - the CasPoolSize to set
    
    Returns:
    
    reference to this instance
  - getFSHeapSize
```
public int getFSHeapSize()
```
    Get FS Heap Size.
    
    Returns:
    
    the FSHeapSize
  - setFSHeapSize
```
public <T extends LeoProperties> T setFSHeapSize(int mFSHeapSize)
```
    Size of the FS heap in bytes of each CAS in the pool.
    
    Parameters:
    
    mFSHeapSize - the FSHeapSize to set
    
    Returns:
    
    reference to this instance
  - getTimeout
```
public int getTimeout()
```
    Set timeout.
    
    Returns:
    
    the Timeout
  - setTimeout
```
public <T extends LeoProperties> T setTimeout(int mTimeout)
```
    Timeout period in seconds. If a CAS does not return within this period it is considered an error. Default is wait forever.
    
    Parameters:
    
    mTimeout - the Timeout to set
    
    Returns:
    
    reference to this instance
  - getInitTimeout
```
public int getInitTimeout()
```
    Get the init timeout.
    
    Returns:
    
    the InitTimeout
  - setInitTimeout
```
public <T extends LeoProperties> T setInitTimeout(int mInitTimeout)
```
    Initialization timeout period in seconds. If initialization request does not return within this time it is considered an error. Default is 60 seconds.
    
    Parameters:
    
    mInitTimeout - the InitTimeout to set
    
    Returns:
    
    reference to this instance
  - getCCTimeout
```
public int getCCTimeout()
```
    Get the CCTimeout.
    
    Returns:
    
    the CCTimeout
  - setCCTimeout
```
public <T extends LeoProperties> T setCCTimeout(Integer mCCTimeout)
```
    CAS complete timeout in seconds. Once all CAS requests are complete a collection process complete event is thrown. Default is wait forever.
    
    Parameters:
    
    mCCTimeout - the CCTimeout to set
    
    Returns:
    
    reference to this instance
  - getJamServerBaseUrl
```
public String getJamServerBaseUrl()
```
    Get the Jam Server Base URL.
    
    Returns:
    
    the JamServerBaseUrl
  - setJamServerBaseUrl
```
public <T extends LeoProperties> T setJamServerBaseUrl(String mJamServerBaseUrl)
```
    The base URL for the JAM (JMX Analytics Monitoring) server if available.
    
    Parameters:
    
    mJamServerBaseUrl - the JamServerBaseUrl to set
    
    Returns:
    
    reference to this instance
  - getJamQueryIntervalInSeconds
```
public int getJamQueryIntervalInSeconds()
```
    Get the JAM Query Interval in seconds.
    
    Returns:
    
    the JamQueryIntervalInSeconds
  - setJamQueryIntervalInSeconds
```
public <T extends LeoProperties> T setJamQueryIntervalInSeconds(Integer mJamQueryIntervalInSeconds)
```
    If registering with JAM, the monitor query interval in seconds. Default is 60*60 (1 hour)
    
    Parameters:
    
    mJamQueryIntervalInSeconds - the JamQueryIntervalInSeconds to set
    
    Returns:
    
    reference to this instance
  - isJamResetStatisticsAfterQuery
```
public boolean isJamResetStatisticsAfterQuery()
```
    Reset statistics after jam query.
    
    Returns:
    
    the JamResetStatisticsAfterQuery
  - setJamResetStatisticsAfterQuery
```
public <T extends LeoProperties> T setJamResetStatisticsAfterQuery(Boolean mJamResetStatisticsAfterQuery)
```
    If registering with JAM, should statistics be reset after each gather? Default is true.
    
    Parameters:
    
    mJamResetStatisticsAfterQuery - the JamResetStatisticsAfterQuery flag to set
  - isDeleteOnExit
```
public boolean isDeleteOnExit()
```
    TRUE if generated descriptors will be deleted when the program exits, FALSE otherwise.
    
    Returns:
    
    TRUE if descriptors will be deleted
  - setDeleteOnExit
```
public <T extends LeoProperties> T setDeleteOnExit(boolean mDeleteOnExit)
```
    Set the flag to TRUE if generated descriptors should be deleted on program exit. Default is TRUE.
    
    Parameters:
    
    mDeleteOnExit - true if the descriptors should auto delete.
  - getDescriptorDirectory
```
public String getDescriptorDirectory()
```
    Get the path to the directory where descriptors will be generated.
    
    Returns:
    
    String representation of the descriptor directory
  - setDescriptorDirectory
```
public <T extends LeoProperties> T setDescriptorDirectory(String mDescriptorDirectory)
```
    Set the directory path where generated descriptors will be generated.
    
    Parameters:
    
    mDescriptorDirectory - String representation of the descriptor directory.
  - getJamJmxPort
```
public int getJamJmxPort()
```
    If registering with JAM, this is the port the local JMX Server will listen on. If this is -1, the service will find and use a local open port.
    
    Returns:
    
    the port the JMX Server will listener on. If -1, the port will be chosen automatically when the server starts up.
  - setJamJmxPort
```
public <T extends LeoProperties> T setJamJmxPort(Integer port)
```
    If registering with JAM, this is the port the local JMX Server will listen on. If this is -1, the service will find and use a local open port.
    
    Parameters:
    
    port - the port the JMX Server will listener on, or -1 to pick a port automatically.
  - getAggregateDescriptorFile
```
public String getAggregateDescriptorFile()
```
    File path to the aggregate descriptor.
    
    Returns:
    
    File path to the aggregate descriptor.
  - setAggregateDescriptorFile
```
public void setAggregateDescriptorFile(String mAggregateDescriptorFile)
```
    Set the file path to the aggregate descriptor.
    
    Parameters:
    
    mAggregateDescriptorFile - File path to the aggregate descriptor.

Class LeoProperties

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

mPropertiesFile

mDeploymentDescriptorFile

mServiceName

mAggregateDescriptorFile

mBrokerURL

mEndpoint

mDescriptorDirectory

mCasPoolSize

mFSHeapSize

mTimeout

mInitTimeout

mCCTimeout

mJamServerBaseUrl

mJamQueryIntervalInSeconds

mJamResetStatisticsAfterQuery

mJamJmxPort

mDeleteOnExit

LOG

BROKERURL_DEFAULT

ENDPOINT_DEFAULT

PROPERTIES_DEFAULT

Constructor Detail

LeoProperties

Method Detail

loadDefaults

loadprops

loadprops

loadProperties

getDeploymentDescriptorFile

setDeploymentDescriptorFile

getServiceName

setServiceName

getBrokerURL

setBrokerURL

getEndpoint

setEndpoint

getInputQueueName

setInputQueueName

getCasPoolSize

setCasPoolSize

getFSHeapSize

setFSHeapSize

getTimeout

setTimeout

getInitTimeout

setInitTimeout

getCCTimeout

setCCTimeout

getJamServerBaseUrl

setJamServerBaseUrl

getJamQueryIntervalInSeconds

setJamQueryIntervalInSeconds

isJamResetStatisticsAfterQuery

setJamResetStatisticsAfterQuery

isDeleteOnExit

setDeleteOnExit

getDescriptorDirectory

setDescriptorDirectory

getJamJmxPort

setJamJmxPort

getAggregateDescriptorFile

setAggregateDescriptorFile