|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.genesyslab.ail.AilLoader
public class AilLoader
Main entry point into the Agent Interaction Layer.
Create the AilLoader interface to:
Use the getAilFactory() static method to get an AilFactory
instance that your application can use to access the Interaction SDK features.
| Nested Class Summary | |
|---|---|
static class |
AilLoader.ApplicationType
Constants for types of application. |
| Field Summary | |
|---|---|
com.genesyslab.ail.component.deployer.DeployerComponent |
mDeployer
|
com.genesyslab.ail.core.AilModule |
mModule
|
| Constructor Summary | |
|---|---|
AilLoader(java.lang.String primary_host,
int primary_port,
java.lang.String backup_host,
int backup_port,
java.lang.String user_name,
java.lang.String password,
java.lang.String application_name,
AilLoader.ApplicationType application_type,
int period,
int timeout)
Instanciates this loader for the Agent Interaction Layer. |
|
| Method Summary | |
|---|---|
void |
debug()
Sets the trace level at startup to DEBUG. |
void |
disasterSwitchover()
|
void |
enableOutboundChainApi()
Enables the OutboundChain API. |
static AilFactory |
getAilFactory()
Instantiates and returns the AilFactory. |
static AilLoader |
getAilLoader()
|
static com.genesyslab.ail.core.AilModule |
getAilModule()
|
static ServiceException |
getInitException()
Returns the ServiceException that occurred when initializing
the AIL. |
com.genesyslab.ail.component.framework.SynchronizerComponent |
getSynchronizerComponent()
|
void |
killFactory()
Kills the current factory. |
void |
noLog4jSettings()
Tells the Agent Interaction Layer not to handle settings in Log4j. |
void |
noLogFile()
Tells the Agent Interaction Layer not to output traces in a file. |
void |
noShutdownHook()
Tells the Agent Interaction Layer not to set a shutdown hook. |
void |
noTrace()
Tells the Agent Interaction Layer not to output any trace in the console. |
void |
record()
|
void |
setDefaultLogFileName(java.lang.String file_name)
Sets the default log file name. |
void |
setDefaultLogFilePath(java.lang.String file_path)
Sets the default log file location. |
void |
setForcedOptions(java.util.Map forcedOptions)
Forces options and overrides any options set in the Configuration Layer. |
void |
setInitListener(InitListener listener)
Sets a listener for initialization events. |
void |
setLicenseFile(java.lang.String license_file)
Sets license file when given as application parameter rather than option of config. |
void |
setMockComponents(java.util.HashMap map)
|
void |
setStartupConnectionAttempts(int attempts)
Sets the maximum number of attepts for the connection to the config server. |
void |
setStartupTimeout(int startupTimeout)
Sets the timeout for startup. |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public com.genesyslab.ail.component.deployer.DeployerComponent mDeployer
public com.genesyslab.ail.core.AilModule mModule
| Constructor Detail |
|---|
public AilLoader(java.lang.String primary_host,
int primary_port,
java.lang.String backup_host,
int backup_port,
java.lang.String user_name,
java.lang.String password,
java.lang.String application_name,
AilLoader.ApplicationType application_type,
int period,
int timeout)
primary_host - the name of the host where the primary Configuration Server runs. Not
taken into account if the primary_port is lower than or equal to 0.primary_port - the port on which the primary Configuration Server runs. Not taken into
account if the primary_host is null.backup_host - the name of the host of the backup Configuration Server. Not taken into
account if the backup_port is lower than or equal to 0.backup_port - the port of the backup Configuration Server. Not taken into account if the
backup_host is null.user_name - a user name for the Configuration Layer. This
parameter is not taken into account if
application_type is SERVER.password - the password of this user. This parameter is
not taken into account if application_type is
SERVER.application_name - the name of the application in the
Configuration Layer.application_type - the type of the application in the Configuration Layer.period - the heartbeat period (in seconds) for checking the connections
to the servers. This ping allows keeping the
connections alive. The default value is 300 (five minutes); it
should be greater than the timeout.timeout - the timeout (in
seconds) for the requests to the servers. When a request to a server doesn't get an answer by
this delay, it will throw a timeout exception. The default
value is 30 (seconds); it should be lower than the period.| Method Detail |
|---|
public com.genesyslab.ail.component.framework.SynchronizerComponent getSynchronizerComponent()
public static AilLoader getAilLoader()
public static com.genesyslab.ail.core.AilModule getAilModule()
public void noLog4jSettings()
public void noTrace()
public void noLogFile()
public void noShutdownHook()
public void setDefaultLogFilePath(java.lang.String file_path)
noLogFile().
file_path - the fully-qualified path to the log file ; it
can be either absolute or relativesetDefaultLogFileName(java.lang.String)public void setDefaultLogFileName(java.lang.String file_name)
noLogFile().
file_name - the name of the log filesetDefaultLogFilePath(java.lang.String)public void debug()
public void record()
public void setStartupConnectionAttempts(int attempts)
public void setStartupTimeout(int startupTimeout)
public void setLicenseFile(java.lang.String license_file)
license_file - The license file (one or several filepath|port@host separated by semicolon)public void enableOutboundChainApi()
public void setForcedOptions(java.util.Map forcedOptions)
public void setInitListener(InitListener listener)
public static AilFactory getAilFactory()
AilFactory. If the
AIlFactory was not initialized, returns
null. In case of error while initializing the
connection to the config server, returns null. In
that case, you can have more information with getInitException().
AilFactory or null in
case of error.public void killFactory()
getAilFactory()
in the same JVM.
public static ServiceException getInitException()
ServiceException that occurred when initializing
the AIL. If no exception occurred when you called getAilFactory(), returns null.
ServiceException that occurred when
initializing the AIL, if any.public void setMockComponents(java.util.HashMap map)
public void disasterSwitchover()
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||