com.ibm.zosconnect.spi

Interface TrackingInterceptor

All Superinterfaces:

Interceptor

public interface TrackingInterceptor
extends Interceptor

Applies to zosConnect-2.0 and zosConnect-3.0.

Defines an extension of the Interceptor interface, and provides the ability to register a stakeholder tracking identifier to enable an interceptor to support selective tracking.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	copyright_notice

Fields inherited from interface com.ibm.zosconnect.spi.Interceptor

CFG_AD_SEQUENCE_ALIAS, DEFAULT_SEQUENCE_NUMBER

Method Summary

Modifier and Type	Method and Description
char	getStakeholderIdentifier() Returns the unique identifier of the stakeholder to be used in selective tracking of requests.

Methods inherited from interface com.ibm.zosconnect.spi.Interceptor

getName, getSequence, postInvoke, preInvoke

Field Detail

copyright_notice

static final java.lang.String copyright_notice

See Also:

Constant Field Values

Method Detail

getStakeholderIdentifier

char getStakeholderIdentifier()

Returns the unique identifier of the stakeholder to be used in selective tracking of requests. This method is used when a tracking interceptor is loaded to warn if multiple TrackingInterceptor implementations are using the same stakeholder identifier.

The character returned must be in the range A-Z or a-z. This character must be passed on subsequent calls to Data.addStakeholderToken(char stakeholderIdentifier) to indicate to the monitoring agent in the system of record whether tracking of the request is required.

Returns:

The registered stakeholder identifier.