weblogic.jdbc.common.internal

Interface AffinityContextHelper

All Known Implementing Classes:

AbstractAffinityContextHelper, SessionAffinityContextHelper, XAAffinityContextHelper

public interface AffinityContextHelper

Helper interface for managing connection affinity context objects.

See Also:

AffinityContextHelperFactory

Excluded in public API Reference.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	createAffinityContext(java.lang.String databaseName, java.lang.String serviceName, java.lang.String instanceName) Returns a new connection affinity context object derived from the specified arguments.
java.lang.Object	getAffinityContext(java.lang.String key) Returns the affinity context object associated with the specified key.
java.lang.String	getDatabaseName(java.lang.Object affinityContext) Extracts the database unique name from the affinity context object.
java.lang.String	getInstanceName(java.lang.Object affinityContext) Extracts the database instance name from the affinity context object.
java.lang.String	getKey(java.lang.Object affinityContext) Returns an affinity context key derived from database and service names found in the specified affinity context
java.lang.String	getKey(java.lang.String databaseName, java.lang.String serviceName) Returns the affinity context key derived from the specified database and service name
java.lang.String[]	getKeys() Returns a list of the set affinity context keys for this application context type, or null if no contexts are set.
java.lang.String	getServiceName(java.lang.Object affinityContext) Extracts the database service name from the affinity context object.
boolean	isApplicationContextAvailable() Returns true if the application context is available for this affinity context type.
boolean	setAffinityContext(java.lang.String key, java.lang.Object context) Sets the affinity context object on the application context under the specified key.

Method Detail

getKey

java.lang.String getKey(java.lang.Object affinityContext)
                 throws AffinityContextException

Returns an affinity context key derived from database and service names found in the specified affinity context

Parameters:

affinityContext - The affinity context object

Returns:

The affinity context key qualified with database and service name

Throws:

AffinityContextException - An error occurred

getKey

java.lang.String getKey(java.lang.String databaseName,
                        java.lang.String serviceName)

Returns the affinity context key derived from the specified database and service name

Parameters:

databaseName - Database unique name

serviceName - Database service name

Returns:

The affinity context key qualified with database and service name

getKeys

java.lang.String[] getKeys()

Returns a list of the set affinity context keys for this application context type, or null if no contexts are set.

Returns:

A list of the set affinity context keys.

getAffinityContext

java.lang.Object getAffinityContext(java.lang.String key)

Returns the affinity context object associated with the specified key.

Parameters:

key - The key of the affinity context object

Returns:

The affinity context object associated with the specified key.

setAffinityContext

boolean setAffinityContext(java.lang.String key,
                           java.lang.Object context)

Sets the affinity context object on the application context under the specified key.

Parameters:

key - The key used to store the affinity context object

context - The affinity context object to store

Returns:

true if the context was set, false otherwise

createAffinityContext

java.lang.Object createAffinityContext(java.lang.String databaseName,
                                       java.lang.String serviceName,
                                       java.lang.String instanceName)
                                throws AffinityContextException

Returns a new connection affinity context object derived from the specified arguments.

Parameters:

databaseName - The database unique name.

serviceName - The service name.

instanceName - The instance name.

Returns:

A new connection affinity context object

Throws:

AffinityContextException - An error occurred accessing the affinity context object

getDatabaseName

java.lang.String getDatabaseName(java.lang.Object affinityContext)
                          throws AffinityContextException

Extracts the database unique name from the affinity context object.

Parameters:

affinityContext - The affinity context object.

Returns:

The database unique name from the affinity context object.

Throws:

AffinityContextException - An error occurred accessing the affinity context object

getServiceName

java.lang.String getServiceName(java.lang.Object affinityContext)
                         throws AffinityContextException

Extracts the database service name from the affinity context object.

Parameters:

affinityContext - The affinity context object.

Returns:

The service name from the affinity context object.

Throws:

AffinityContextException - An error occurred accessing the affinity context object

getInstanceName

java.lang.String getInstanceName(java.lang.Object affinityContext)
                          throws AffinityContextException

Extracts the database instance name from the affinity context object.

Parameters:

affinityContext - The affinity context object.

Returns:

The database instance name from the affinity context object.

Throws:

AffinityContextException - An error occurred accessing the affinity context object

isApplicationContextAvailable

boolean isApplicationContextAvailable()

Returns true if the application context is available for this affinity context type. (e.g. For XA affinity, true if there is a global transaction context on the thread)

Returns:

true when application context exists for this affinity type