oracle.odi.domain.topology

Class OdiOnConnectConfig

java.lang.Object

oracle.odi.domain.topology.OdiOnConnectConfig

public class OdiOnConnectConfig
extends java.lang.Object

Holds configuration information related to OnConnect command to be applied to an OdiDataServer's connection when it is obtained. It is typically used to define DB session setup.

Since:

11.1.1.5.0

Constructor Summary

Constructors

Constructor and Description
OdiOnConnectConfig(java.lang.String pCmd, LogLevel pLogLevel, java.util.Set pTransactionChannels, boolean pShouldBePerformedOutsideTransactionChannels, boolean pShouldCommitCmd, boolean pShouldIgnoreErrors) Create a new OdiOnConnectConfig

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCommand() Obtains the command to be performed during onConnect
LogLevel	getLogLevel() Obtains log level to be used when executing onConnect command.
java.util.Set	getTransactionChannels() Obtains the transaction channels for which the onConnect command should be performed.
boolean	isShouldBePerformedOutsideTransactionChannels() Returns whether the on-connect command should also be performed outside transaction channels (i.e.
boolean	isShouldCommitCommand() Returns whether the on-connect command should be committed, or not.
boolean	isShouldIgnoreErrors() Return whether the on-connect command's errors should be ignored, or not.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OdiOnConnectConfig

public OdiOnConnectConfig(java.lang.String pCmd,
                          LogLevel pLogLevel,
                          java.util.Set pTransactionChannels,
                          boolean pShouldBePerformedOutsideTransactionChannels,
                          boolean pShouldCommitCmd,
                          boolean pShouldIgnoreErrors)
                   throws java.lang.IllegalArgumentException

Create a new OdiOnConnectConfig

Parameters:

pCmd - - the onConnect command, can be null

pLogLevel - - the log level to be applied when executing the command, LogLevel.LEVEL_3 will be used in case pLogLevel is null

pTransactionChannels - - transaction channels to apply the command

pShouldBePerformedOutsideTransactionChannels - - whether the command can be performed outside session execution

pShouldCommitCmd - - whether the command should be committed

pShouldIgnoreErrors - - whether errors should be ignored

Throws:

java.lang.IllegalArgumentException - - in case of an illegal null parameter value

Method Detail

getLogLevel

public LogLevel getLogLevel()

Obtains log level to be used when executing onConnect command.

Returns:

a LogLevel

getCommand

public java.lang.String getCommand()

Obtains the command to be performed during onConnect

Returns:

a string containing onConnect statement, or null if undefined

isShouldCommitCommand

public boolean isShouldCommitCommand()

Returns whether the on-connect command should be committed, or not.

Returns:

true if command should be committed, false otherwise.

isShouldIgnoreErrors

public boolean isShouldIgnoreErrors()

Return whether the on-connect command's errors should be ignored, or not.

Returns:

true if errors should be ignored, false otherwise

getTransactionChannels

public java.util.Set getTransactionChannels()

Obtains the transaction channels for which the onConnect command should be performed.

Returns:

a set of TransactionChannels

isShouldBePerformedOutsideTransactionChannels

public boolean isShouldBePerformedOutsideTransactionChannels()

Returns whether the on-connect command should also be performed outside transaction channels (i.e. outside the context of a session execution).

Returns:

true if command should be performed outside transaction channels, false otherwise