com.tibco.bw.poa.runtime
Interface AdviceContext<I,U,N extends I,A extends I,S,T,X>


public interface AdviceContext<I,U,N extends I,A extends I,S,T,X>

The context of an advice instance. An instance of this class is created for every advice instance that executes in a join point.

Two or more advice instances may share the same advice implementation java object but they always have a different AdviceContext object associated with them.

Since:
1.0
See Also:
Advice, SyncAdvice, AsyncAdvice

Field Summary
static java.lang.String DATA_ACCESS_FEATURE
          The identifier of the DATA ACCESS feature.
static java.lang.String DATA_ACCESS_READ_ONLY
          Used by advice implementations that use READ ONLY data access.
static java.lang.String DATA_ACCESS_READ_WRITE
          Used by advice implementations that use READ WRITE data access.
static java.lang.String HIBERNATES_JOBS_FEATURE
          The identifier of the HIBERNATES JOBS feature.
static java.lang.String SCOPE_ADVICE
          Used by advice implementations that use the ADVICE scope.
static java.lang.String SCOPE_APPLICATION
          Used by advice implementations that use the APPLICATION scope.
static java.lang.String SCOPE_FEATURE
          The identifier of the SCOPE feature.
static java.lang.String TARGET_FILTER_FEATURE
          The identifier of the TARGET FILTER feature.
static java.lang.String TARGET_KIND_ACTIVITY_AFTER
          Used by advice implementations that must be executed only after activities, regardless of whether they successfully complete their business logic or they throw exceptions.
static java.lang.String TARGET_KIND_ACTIVITY_AFTER_RETURNING
          Used by advice implementations that must be executed only after activities, and only when they successfully complete their business logic.
static java.lang.String TARGET_KIND_ACTIVITY_AFTER_THROWING
          Used by advice implementations that must be executed only after activities, and only when they throw exceptions.
static java.lang.String TARGET_KIND_ACTIVITY_BEFORE
          Used by advice implementations that must be executed only before activities.
static java.lang.String TARGET_KIND_FEATURE
          The identifier of the TARGET KIND feature.
 
Method Summary
 AdviceConfig getAdviceConfiguration()
          Returns the configuration of the advice instance, as it appears in the aspect file.
 long getAdviceId()
          Return the advice instance's ID, which is unique in the context of an engine.
 java.lang.String getAdviceName()
          Returns the advice instance's name, which is unique in the context of a join point.
 java.lang.String getAdviceURI()
          Returns the advice instance's URI, which is unique in the context of an engine.
 AppContext getAppContext()
          Returns the application context.
 EngineCommandExecutor getEngineCommandExecutor()
          Returns the Engine Command Executor object to execute engine commands.
  getGxProcessingContext()
          Returns the context needed to access the XML data model.
 java.lang.String getImplementationFeature(java.lang.String featureName)
          Returns the value of a particular advice implementation feature.
 

Field Detail

SCOPE_FEATURE


static final java.lang.String SCOPE_FEATURE
The identifier of the SCOPE feature.

See Also:
Constant Field Values

SCOPE_ADVICE


static final java.lang.String SCOPE_ADVICE
Used by advice implementations that use the ADVICE scope.

See Also:
Constant Field Values

SCOPE_APPLICATION


static final java.lang.String SCOPE_APPLICATION
Used by advice implementations that use the APPLICATION scope.

See Also:
Constant Field Values

DATA_ACCESS_FEATURE


static final java.lang.String DATA_ACCESS_FEATURE
The identifier of the DATA ACCESS feature.

See Also:
Constant Field Values

DATA_ACCESS_READ_ONLY


static final java.lang.String DATA_ACCESS_READ_ONLY
Used by advice implementations that use READ ONLY data access.

See Also:
Constant Field Values

DATA_ACCESS_READ_WRITE


static final java.lang.String DATA_ACCESS_READ_WRITE
Used by advice implementations that use READ WRITE data access.

See Also:
Constant Field Values

HIBERNATES_JOBS_FEATURE


static final java.lang.String HIBERNATES_JOBS_FEATURE
The identifier of the HIBERNATES JOBS feature.

See Also:
Constant Field Values

TARGET_KIND_FEATURE


static final java.lang.String TARGET_KIND_FEATURE
The identifier of the TARGET KIND feature.

See Also:
Constant Field Values

TARGET_KIND_ACTIVITY_BEFORE


static final java.lang.String TARGET_KIND_ACTIVITY_BEFORE
Used by advice implementations that must be executed only before activities.

See Also:
Constant Field Values

TARGET_KIND_ACTIVITY_AFTER_RETURNING


static final java.lang.String TARGET_KIND_ACTIVITY_AFTER_RETURNING
Used by advice implementations that must be executed only after activities, and only when they successfully complete their business logic.

See Also:
Constant Field Values

TARGET_KIND_ACTIVITY_AFTER_THROWING


static final java.lang.String TARGET_KIND_ACTIVITY_AFTER_THROWING
Used by advice implementations that must be executed only after activities, and only when they throw exceptions.

See Also:
Constant Field Values

TARGET_KIND_ACTIVITY_AFTER


static final java.lang.String TARGET_KIND_ACTIVITY_AFTER
Used by advice implementations that must be executed only after activities, regardless of whether they successfully complete their business logic or they throw exceptions.

See Also:
Constant Field Values

TARGET_FILTER_FEATURE


static final java.lang.String TARGET_FILTER_FEATURE
The identifier of the TARGET FILTER feature.

See Also:
Constant Field Values
Method Detail

getAdviceConfiguration


AdviceConfig getAdviceConfiguration()
Returns the configuration of the advice instance, as it appears in the aspect file. An advice instance can use this method to get access to its configuration data.

Returns:
See Also:
AdviceConfig

getAdviceName


java.lang.String getAdviceName()
Returns the advice instance's name, which is unique in the context of a join point.

Returns:

getAdviceURI


java.lang.String getAdviceURI()
Returns the advice instance's URI, which is unique in the context of an engine. Unless a change occurs in the deployed environment, the BW engine guarantees that an advice instance gets the same URI when the engine is restarted.

Returns:

getAdviceId


long getAdviceId()
Return the advice instance's ID, which is unique in the context of an engine. The BW engine recycles the advice IDs at start up. The engine does not guarantee that an advice instance gets the same ID when the engine is restarted.

Returns:

getGxProcessingContext


 getGxProcessingContext()
Returns the context needed to access the XML data model.

Returns:

getImplementationFeature


java.lang.String getImplementationFeature(java.lang.String featureName)
Returns the value of a particular advice implementation feature. Advice implementations advertise specific features using java annotations.

Parameters:
featureName - The feature identifier
Returns:

getAppContext


AppContext getAppContext()
Returns the application context.

Returns:
Since:
1.1

getEngineCommandExecutor


EngineCommandExecutor getEngineCommandExecutor()
Returns the Engine Command Executor object to execute engine commands.

Returns:
Since:
1.2


Copyright @ 2010, TIBCO Softwares (Inc). All right reserved