Oracle Business Components for Java 9.0.2: Interface EnvInfoProvider

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Business Components

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

oracle.jbo.common.ampool
Interface EnvInfoProvider

All Known Implementing Classes:: JUEnvInfoProvider

public interface EnvInfoProvider

Invoked by DefaultConnectionStrategy when the application pool is establishing connection to the database.

Application developers may implement this interface to provide dynamic information to oracle.jbo.Transaction.connect(String, Properties). Examples of dynamic information may include a database username or a database user password.

Method Summary
Type Method

java.lang.Object getInfo(java.lang.String info, java.lang.Object connEnvironment)
          Invoked when the application pool is establishing a connection to the database.

int getNumOfRetries()
          Returns the number times that the default connection strategy should attempt to create/connect and application module instance before failing.

void modifyInitialContext(java.lang.Object initialContext)
          Invoked when the application pool is creating a new application module instance.

Type	Method
`java.lang.Object`	`getInfo(java.lang.String info, java.lang.Object connEnvironment)` Invoked when the application pool is establishing a connection to the database.
`int`	`getNumOfRetries()` Returns the number times that the default connection strategy should attempt to create/connect and application module instance before failing.
`void`	`modifyInitialContext(java.lang.Object initialContext)` Invoked when the application pool is creating a new application module instance.

Method Detail

getInfo

public java.lang.Object getInfo(java.lang.String info,
                                java.lang.Object connEnvironment)

Invoked when the application pool is establishing a connection to the database.

Parameters:: info - a string representing the info required by the DefaultConnectionStrategy.; environment - a Properties object containing the environment that will be passed to oracle.jbo.Transaction.connect(String, Properties)
Returns:: A not null value indicates that getInfo was successful. The instance that the return value references is ignored by the DefaultConnectionStrategy.

modifyInitialContext

public void modifyInitialContext(java.lang.Object initialContext)

Invoked when the application pool is creating a new application module instance. The environment hashtable may be modified by the EnvInfoProvider to provide dynamic application module context.

getNumOfRetries

public int getNumOfRetries()

Returns the number times that the default connection strategy should attempt to create/connect and application module instance before failing.