com.genesyslab.omsdk.commons
Interface ApplicationInfo


public interface ApplicationInfo

Provides information about the connected application.

Since:
7.1.008.00

Method Summary
 java.util.Map getAnnex()
          Returns the Annex options defined for the application in the Configuration Layer.
 java.lang.String getApplicationName()
          Returns the application name.
 int getApplicationType()
          Returns application type in the Configuration Layer.
 java.lang.String getHost()
          Returns the application's base host.
 java.lang.String getOption(java.lang.String name)
          Returns the option value defined for this application in the Configuration Layer.
 java.lang.String getOption(java.lang.String sectionName, java.lang.String name)
          Returns the options defined for this application in the specified section of the Configuration Layer.
 java.util.Map getOptions()
          Returns the options defined for the application in the Configuration Layer.
 

Method Detail

getApplicationName

public java.lang.String getApplicationName()
Returns the application name.

Returns:
application name
See Also:
InitializationParameters

getApplicationType

public int getApplicationType()
Returns application type in the Configuration Layer.

Returns:
application type
See Also:
CfgAppType, CfgAppType.CFGGenericServer, CfgAppType.CFGThirdPartyServer

getHost

public java.lang.String getHost()
Returns the application's base host.

Returns:
Host name or IP defined in the Configuration Layer.

getOptions

public java.util.Map getOptions()
Returns the options defined for the application in the Configuration Layer.

Returns:
a Map of options, where the key is a String value for a section name and the value is a second-level Map of options.
In the second-level Map, the key is a String value for an option name and the value is a String or an int for the corresponding option value.

getOption

public java.lang.String getOption(java.lang.String name)
Returns the option value defined for this application in the Configuration Layer.
Sections are not considered for this operation. If duplicate options are present in different sections, returns the first option encountered.

Parameters:
name - option name.
Returns:
the option value; null if the option does not exist.

getOption

public java.lang.String getOption(java.lang.String sectionName,
                                  java.lang.String name)
Returns the options defined for this application in the specified section of the Configuration Layer.

Sections are considered for this operation.

Parameters:
sectionName - section name.
name - option name.
Returns:
String value; otherwise, null if no such option exists in the specified section.

getAnnex

public java.util.Map getAnnex()
Returns the Annex options defined for the application in the Configuration Layer.

Returns:
annex as a Map, where the key is a String for a section name, and the value is a second-level Map of options.
In the second-level Map, the key is a String for an option name and the value is a String for the corresponding option value.