GXConfig (ApplinX API Specification)

java.lang.Object
- com.sabratec.applinx.framework.GXConfig

All Implemented Interfaces:: Cloneable

public class GXConfig
extends Object
implements Cloneable

Constructor Summary

Constructors
Constructor and Description

GXConfig()

Constructors
Constructor and Description
`GXConfig()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addVariable(GXVariable variable)` Adds a variable to the framework configuration The variable will be used in the internal framework requests to the server.
`void`	`addVariable(String varName, String varValue)`
`Object`	`clone()`
`String`	`get_ApplicationName()` For .NET framework usage.
`String`	`get_Description()` For .NET framework usage.
`boolean`	`get_FailOnWarning()` For .NET framework usage.
`String`	`get_HostNewPassword()` For .NET framework usage.
`String`	`get_HostPassword()` For .NET framework usage.
`String`	`get_HostUserName()` For .NET framework usage.
`String`	`get_Password()` For .NET framework usage.
`String`	`get_ServerURL()` For .NET framework usage.
`String`	`get_ServiceName()` For .NET framework usage.
`String`	`get_SessionId()` For .NET framework usage.
`boolean`	`get_ShowIntermediateScreen()` For .NET framework usage.
`GXVariable`	`get_Variable(String varName)` For .NET framework usage.
`GXVariable[]`	`get_Variables()` For .NET framework usage.
`boolean`	`get_VariablesModified()` For .NET framework usage.
`String`	`getApplicationName()` The name of the ApplinX application.
`String`	`getDescription()` The description of the session in ApplinX server.
`String`	`getHostNewPassword()`
`String`	`getHostPassword()` The host password.
`String`	`getHostUserName()` The host user name for SSH and Natural-Unix protocol only.
`String`	`getPassword()` The password to the session in ApplinX server.
`GXIApplicationServerContext`	`getServerContext()` For J2EE usage only.
`String`	`getServerURL()` The ApplinX server URL, by default it is applinx://localhost:2323.
`String`	`getServiceName()` Formally known as host service The connection pool used to get a session.
`String`	`getSessionId()` The session ID in ApplinX server.
`GXVariable`	`getVariable(String varName)` Returns a variable used by the framework by the specified variable name.
`GXVariable[]`	`getVariables()` An array of variables to be passed to the server.
`boolean`	`isFailOnWarning()`
`boolean`	`isShowIntermediateScreen()` Determines whether to show intermediate host screens.
`boolean`	`isVariablesModified()` For internal usage
`void`	`removeVariable(String varName)`
`void`	`set_ApplicationName(String applicationName)` For .NET framework usage.
`void`	`set_Description(String desc)` For .NET framework usage.
`void`	`set_FailOnWarning(boolean failOnWarning)` For .NET framework usage.
`void`	`set_HostNewPassword(String hostNewPassword)` For .NET framework usage.
`void`	`set_HostPassword(String hostPassword)` For .NET framework usage.
`void`	`set_HostUserName(String hostUserName)` For .NET framework usage.
`void`	`set_Password(String password)` For .NET framework usage.
`void`	`set_ServerURL(String serverURL)` For .NET framework usage.
`void`	`set_ServiceName(String serviceName)` For .NET framework usage.
`void`	`set_SessionId(String sessionId)` For .NET framework usage.
`void`	`set_ShowIntermediateScreen(boolean show)` For .NET framework usage.
`void`	`set_Variables(GXVariable[] variables)` For .NET framework usage.
`void`	`setApplicationName(String applicationName)` The name of the ApplinX application.
`void`	`setDescription(String desc)` The description of the session in ApplinX server.
`void`	`setFailOnWarning(boolean failOnWarning)`
`void`	`setHostNewPassword(String hostNewPassword)`
`void`	`setHostPassword(String hostPassword)` The host password.
`void`	`setHostUserName(String hostUserName)` The host user name.
`void`	`setPassword(String password)` The password required to access a specific session on the ApplinX server.
`void`	`setServerContext(GXIApplicationServerContext serverContext)` For J2EE usage only.
`void`	`setServerURL(String serverURL)` The ApplinX server URL, by default it is applinx://localhost:2323.
`void`	`setServiceName(String serviceName)` Formally known as host service The connection pool used to get a session.
`void`	`setSessionId(String sessionId)` The Session ID in the web server.
`void`	`setShowIntermediateScreen(boolean show)` Determine whether to show intermediate host screens.
`void`	`setVariables(GXVariable[] variables)` An array of variables to be passed to the server.
`String`	`toString()`

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

- Constructor Detail
  - GXConfig
```
public GXConfig()
```
- Method Detail
  - get_ServerURL
```
public String get_ServerURL()
```
    For .NET framework usage. Expose the method as a property.
  - set_ServerURL
```
public void set_ServerURL(String serverURL)
```
    For .NET framework usage. Expose the method as a property.
  - getServerURL
```
public String getServerURL()
```
    The ApplinX server URL, by default it is applinx://localhost:2323. For secured SSL socket: applinxs://localhost:23443
    
    Returns:
    
    The ApplinX server URL
  - setServerURL
```
public void setServerURL(String serverURL)
```
    The ApplinX server URL, by default it is applinx://localhost:2323. For secured SSL socket: applinxs://localhost:23443
    
    Parameters:
    
    serverURL - The ApplinX server URL
  - get_SessionId
```
public String get_SessionId()
```
    For .NET framework usage. Expose the method as a property.
  - set_SessionId
```
public void set_SessionId(String sessionId)
```
    For .NET framework usage. Expose the method as a property.
  - getSessionId
```
public String getSessionId()
```
    The session ID in ApplinX server.
    
    Returns:
    
    the session ID in ApplinX server
  - setSessionId
```
public void setSessionId(String sessionId)
```
    The Session ID in the web server. Can be set according to the connecting IP address or by an allocated session ID. It is also possible to set the Web Session ID from the code (in the GXBasicContext (JSP)/GXBasicWebForm (.NET) file), overriding the option selected here.
    
    Parameters:
    
    sessionId - the session ID in ApplinX server
  - get_HostUserName
```
public String get_HostUserName()
```
    For .NET framework usage. Expose the method as a property.
  - set_HostUserName
```
public void set_HostUserName(String hostUserName)
```
    For .NET framework usage. Expose the method as a property.
  - getHostUserName
```
public String getHostUserName()
```
    The host user name for SSH and Natural-Unix protocol only.
    
    Returns:
    
    The host user name for SSH and Natural-Unix protocol
  - setHostUserName
```
public void setHostUserName(String hostUserName)
```
    The host user name. Relevant for SSH and Natural-Unix protocol only.
    
    Parameters:
    
    hostUserName - the host user name for SSH and Natural-Unix protocol
  - get_ApplicationName
```
public String get_ApplicationName()
```
    For .NET framework usage. Expose the method as a property.
  - set_ApplicationName
```
public void set_ApplicationName(String applicationName)
```
    For .NET framework usage. Expose the method as a property.
  - getApplicationName
```
public String getApplicationName()
```
    The name of the ApplinX application.
    
    Returns:
    
    the name of the ApplinX application
  - setApplicationName
```
public void setApplicationName(String applicationName)
```
    The name of the ApplinX application.
    
    Parameters:
    
    applicationName - the name of the ApplinX application
  - get_Description
```
public String get_Description()
```
    For .NET framework usage. Expose the method as a property.
  - set_Description
```
public void set_Description(String desc)
```
    For .NET framework usage. Expose the method as a property.
  - getDescription
```
public String getDescription()
```
    The description of the session in ApplinX server.
    
    Returns:
    
    the description of the session in ApplinX server
  - setDescription
```
public void setDescription(String desc)
```
    The description of the session in ApplinX server. This description appears in the list of sessions in ApplinX Administrator.
    The information entered can be dynamic and may include tokens such as:
    $(SESSION_ID) � Represents the Web server session ID.
    $(IP) � Represents the user IP address.
    $(BY_APPLINX) � Represents the ApplinX session ID.
    
    Parameters:
    
    desc - the description of the session in ApplinX server
  - get_Password
```
public String get_Password()
```
    For .NET framework usage. Expose the method as a property.
  - set_Password
```
public void set_Password(String password)
```
    For .NET framework usage. Expose the method as a property.
  - getPassword
```
public String getPassword()
```
    The password to the session in ApplinX server.
    
    Returns:
    
    the password to the session in ApplinX server
  - setPassword
```
public void setPassword(String password)
```
    The password required to access a specific session on the ApplinX server. Can be set according to the connecting IP address or by an allocated session ID. It is also possible to set the password from the code (in the GXBasicContext (JSP)/GXBasicWebForm (.NET) file), overriding the option selected here.
    
    Parameters:
    
    password - the password to the session in ApplinX server
  - get_HostPassword
```
public String get_HostPassword()
```
    For .NET framework usage. Expose the method as a property.
  - set_HostPassword
```
public void set_HostPassword(String hostPassword)
```
    For .NET framework usage. Expose the method as a property.
  - getHostPassword
```
public String getHostPassword()
```
    The host password. Relevant for SSH and Natural-Unix protocol only.
    
    Returns:
    
    the host password for SSH and Natural-Unix protocol only
  - setHostPassword
```
public void setHostPassword(String hostPassword)
```
    The host password. Relevant for SSH and Natural-Unix protocol only.
    
    Parameters:
    
    hostPassword - the host password for SSH and Natural-Unix protocol only
  - get_ServiceName
```
public String get_ServiceName()
```
    For .NET framework usage. Expose the method as a property.
  - set_ServiceName
```
public void set_ServiceName(String serviceName)
```
    For .NET framework usage. Expose the method as a property.
  - getServiceName
```
public String getServiceName()
```
    Formally known as host service
    The connection pool used to get a session. When a pool is stated, the framework will connect to the pool instead of using a new session.
    
    Returns:
    
    the connection pool used to get a session
  - setServiceName
```
public void setServiceName(String serviceName)
```
    Formally known as host service
    The connection pool used to get a session. When a pool is stated, the framework will connect to the pool instead of using a new session.
    
    Parameters:
    
    serviceName - the connection pool used to get a session
  - getVariables
```
public GXVariable[] getVariables()
```
    An array of variables to be passed to the server. For example, changing the host address, before creating a new session or application parameters.
    
    Returns:
    
    an array of variables to be passed to the server
    
    See Also:
    
    GXBaseObjectConstants
  - get_Variables
```
public GXVariable[] get_Variables()
```
    For .NET framework usage. Expose the method as a property.
  - set_Variables
```
public void set_Variables(GXVariable[] variables)
```
    For .NET framework usage. Expose the method as a property.
  - setVariables
```
public void setVariables(GXVariable[] variables)
```
    An array of variables to be passed to the server. For example, changing the host address, before creating a new session or application parameters. The variables will be used in the internal framework requests to the server.
    
    Parameters:
    
    variables - an array of variables to be passed to the server
    
    See Also:
    
    GXBaseObjectConstants
  - getVariable
```
public GXVariable getVariable(String varName)
```
    Returns a variable used by the framework by the specified variable name. The variable will be used in the internal framework requests to the server.
    
    Returns:
    
    a variable by the specified variable name
  - addVariable
```
public void addVariable(GXVariable variable)
```
    Adds a variable to the framework configuration The variable will be used in the internal framework requests to the server.
  - addVariable
```
public void addVariable(String varName,
                        String varValue)
```
  - removeVariable
```
public void removeVariable(String varName)
```
  - isVariablesModified
```
public boolean isVariablesModified()
```
    For internal usage
  - getServerContext
```
public GXIApplicationServerContext getServerContext()
```
    For J2EE usage only. The ApplinX server context when running in local mode.
    
    Returns:
    
    the ApplinX server context when running in local mode
  - setServerContext
```
public void setServerContext(GXIApplicationServerContext serverContext)
```
    For J2EE usage only. The ApplinX server context when running in local mode.
    
    Parameters:
    
    serverContext - the ApplinX server context when running in local mode
  - isShowIntermediateScreen
```
public boolean isShowIntermediateScreen()
```
    Determines whether to show intermediate host screens. Relevant for Natural Set Control N command
    
    Returns:
    
    whether to show host screens
  - setShowIntermediateScreen
```
public void setShowIntermediateScreen(boolean show)
```
    Determine whether to show intermediate host screens. Relevant for Natural Set Control N command.
    
    Parameters:
    
    show - whether to show intermediate host screens
  - get_ShowIntermediateScreen
```
public boolean get_ShowIntermediateScreen()
```
    For .NET framework usage. Expose the method as a property.
  - set_ShowIntermediateScreen
```
public void set_ShowIntermediateScreen(boolean show)
```
    For .NET framework usage. Expose the method as a property.
  - clone
```
public Object clone()
             throws CloneNotSupportedException
```
    Overrides:
    
    clone in class Object
    
    Throws:
    
    CloneNotSupportedException
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getHostNewPassword
```
public String getHostNewPassword()
```
  - setHostNewPassword
```
public void setHostNewPassword(String hostNewPassword)
```
  - isFailOnWarning
```
public boolean isFailOnWarning()
```
  - setFailOnWarning
```
public void setFailOnWarning(boolean failOnWarning)
```
  - get_Variable
```
public GXVariable get_Variable(String varName)
```
    For .NET framework usage. Expose the method as a property.
  - get_VariablesModified
```
public boolean get_VariablesModified()
```
    For .NET framework usage. Expose the method as a property.
  - get_HostNewPassword
```
public String get_HostNewPassword()
```
    For .NET framework usage. Expose the method as a property.
  - set_HostNewPassword
```
public void set_HostNewPassword(String hostNewPassword)
```
    For .NET framework usage. Expose the method as a property.
  - get_FailOnWarning
```
public boolean get_FailOnWarning()
```
    For .NET framework usage. Expose the method as a property.
  - set_FailOnWarning
```
public void set_FailOnWarning(boolean failOnWarning)
```
    For .NET framework usage. Expose the method as a property.

Class GXConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GXConfig

Method Detail

get_ServerURL

set_ServerURL

getServerURL

setServerURL

get_SessionId

set_SessionId

getSessionId

setSessionId

get_HostUserName

set_HostUserName

getHostUserName

setHostUserName

get_ApplicationName

set_ApplicationName

getApplicationName

setApplicationName

get_Description

set_Description

getDescription

setDescription

get_Password

set_Password

getPassword

setPassword

get_HostPassword

set_HostPassword

getHostPassword

setHostPassword

get_ServiceName

set_ServiceName

getServiceName

setServiceName

getVariables

get_Variables

set_Variables

setVariables

getVariable

addVariable

addVariable

removeVariable

isVariablesModified

getServerContext

setServerContext

isShowIntermediateScreen

setShowIntermediateScreen

get_ShowIntermediateScreen

set_ShowIntermediateScreen

clone

toString

getHostNewPassword

setHostNewPassword

isFailOnWarning

setFailOnWarning

get_Variable

get_VariablesModified

get_HostNewPassword

set_HostNewPassword

get_FailOnWarning

set_FailOnWarning