Package com.opencloud.rhino.facilities.sas

Class NullSasFacilityImpl

java.lang.Object

com.opencloud.rhino.facilities.sas.NullSasFacilityImpl

All Implemented Interfaces:

SasFacility, Referenceable

public class NullSasFacilityImpl
extends Object
implements SasFacility

No-op implementation of the SAS facility to support unit testing and components shared by non-SLEE applications.

Field Summary

Fields

Modifier and Type	Field	Description
static SasFacility	NULL_SAS_FACILITY

Fields inherited from interface com.opencloud.rhino.facilities.sas.SasFacility

CONFIG_PROPERTY_NAME, JNDI_NAME

Method Summary

Modifier and Type	Method	Description
Trail	copyOrCreateTrail(ActivityContextInterface fromActivity, ActivityContextInterface toActivity)	Attach the Trail from fromActivity to toActivity.
Trail	getOrCreateTrail(ActivityContextInterface aci)	Get the trail attached to an activity or a new trail if one is not bound.
Trail	getOrCreateTrail(EventContext event)	Get the trail attached to the activity owning an event, or a new trail if one is not bound.
Trail	getOrCreateTrail(ActivityHandle handle)	Get the trail attached to an activity or a new trail if one is not bound.
Reference	getReference()
Trail	getTrail(ActivityHandle handle)	Get the trail attached to an activity.
boolean	isEnabled()	Return the current state of the global SAS enabled flag.
void	setActivityTrail(ActivityContextInterface aci, Trail trail)	Set the trail for an Activity.
void	setActivityTrail(EventContext event, Trail trail)	Attach a given Trail to the Activity owning an EventContext.
void	setActivityTrail(ActivityHandle handle, Trail trail)	Set the trail for an Activity.
Trail	startAndAssociateTrail(Trail trail, Scope scope)	Start a new colocated SAS trail, and associate it with the original trail.
Trail	startColocatedTrail(Trail trail)	Start a new SAS trail on the same server as an existing SAS trail.
Trail	startTrail()	Send a start marker on the next trail ID, and return a trail to create and send messages on.
Trail	startTrail(UUID steeringId)	Send a start marker on the next trail ID, and return a trail to create and send messages on.

Methods inherited from class java.lang.Object

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

Field Detail

NULL_SAS_FACILITY

public static final SasFacility NULL_SAS_FACILITY

Method Detail

getReference

public final Reference getReference()

Specified by:

getReference in interface Referenceable

isEnabled

public boolean isEnabled()

Description copied from interface: SasFacility

Return the current state of the global SAS enabled flag.

Specified by:

isEnabled in interface SasFacility

startTrail

public Trail startTrail()

Description copied from interface: SasFacility

Send a start marker on the next trail ID, and return a trail to create and send messages on. Trails are distributed between available servers randomly.

Service code (SBBs, SBB Parts) should use SasFacility.getOrCreateTrail(ActivityContextInterface) in preference to this method.

Specified by:

startTrail in interface SasFacility

startTrail

public Trail startTrail(UUID steeringId)

Description copied from interface: SasFacility

Send a start marker on the next trail ID, and return a trail to create and send messages on. Trails are sent to the server mapped from UUID. Uses a UUID steering ID provided by another network element to associate with a trail reported by that element.

Service code (SBBs, SBB Parts) should use SasFacility.getOrCreateTrail(ActivityContextInterface) in preference to this method.

Specified by:

startTrail in interface SasFacility

startColocatedTrail

public Trail startColocatedTrail(Trail trail)

Description copied from interface: SasFacility

Start a new SAS trail on the same server as an existing SAS trail.

To facilitate associating trails when using a federation of SAS servers this method starts the new trail on the same server as the provided trail.

Specified by:

startColocatedTrail in interface SasFacility

Parameters:

trail - a Trail associated with the desired SAS server

Returns:

a new Trail on the same server as trail, or the NullTrail if this server is unavailable permanently.

startAndAssociateTrail

public Trail startAndAssociateTrail(Trail trail,
                                    Scope scope)

Description copied from interface: SasFacility

Start a new colocated SAS trail, and associate it with the original trail.

Specified by:

startAndAssociateTrail in interface SasFacility

Parameters:

trail - to associate with

scope - association scope

Returns:

copyOrCreateTrail

public Trail copyOrCreateTrail(ActivityContextInterface fromActivity,
                               ActivityContextInterface toActivity)

Description copied from interface: SasFacility

Attach the Trail from fromActivity to toActivity. If no Trail is attached to fromActivity, start a Trail, and attach it to both Activities. This blindly overwrites any existing trail attachment in toActivity.

Specified by:

copyOrCreateTrail in interface SasFacility

Parameters:

fromActivity - Activity to copy trail from

toActivity - Activity to copy trail to

Returns:

The trail attached to both activities.

setActivityTrail

public void setActivityTrail(ActivityHandle handle,
                             Trail trail)

Description copied from interface: SasFacility

Set the trail for an Activity. This association is one-way, a trail may be attached to multiple activities.

This method is only usable from SasFacility instances owned by a Resource Adaptor.

Specified by:

setActivityTrail in interface SasFacility

Parameters:

handle - The handle for the Activity to attach the trail to

trail - The trail to attach

setActivityTrail

public void setActivityTrail(EventContext event,
                             Trail trail)

Description copied from interface: SasFacility

Attach a given Trail to the Activity owning an EventContext.

Specified by:

setActivityTrail in interface SasFacility

Parameters:

event - EventContext owned by the Activity to attach the Trail to

trail - to attach to Activity owning event

setActivityTrail

public void setActivityTrail(ActivityContextInterface aci,
                             Trail trail)

Description copied from interface: SasFacility

Set the trail for an Activity. This association is one-way, a trail may be attached to multiple activities.

This method is only usable from SasFacility instances obtained from an SBB context.

Specified by:

setActivityTrail in interface SasFacility

Parameters:

aci - The ACI for the Activity to attach the trail to

trail - The trail to attach

getTrail

public Trail getTrail(ActivityHandle handle)

Description copied from interface: SasFacility

Get the trail attached to an activity. Returns null if no activity is bound.

This method is only usable from SasFacility instances owned by a Resource Adaptor. RAs should create the trail and attach it with SasFacility.setActivityTrail(ActivityHandle, Trail) before calling this method.

Specified by:

getTrail in interface SasFacility

Parameters:

handle - The handle for the Activity to get the trail from

Returns:

The trail or null if no trail is attached

getOrCreateTrail

public Trail getOrCreateTrail(ActivityHandle handle)

Description copied from interface: SasFacility

Get the trail attached to an activity or a new trail if one is not bound. The new trail will be bound to the activity.

This method is only usable from SasFacility instances obtained from a Resource Adaptor context.

Specified by:

getOrCreateTrail in interface SasFacility

Parameters:

handle - An ActivityHandle referencing the Activity to get the trail from

Returns:

The trail attached to the referenced activity.

getOrCreateTrail

public Trail getOrCreateTrail(EventContext event)

Description copied from interface: SasFacility

Get the trail attached to the activity owning an event, or a new trail if one is not bound. The new trail will be bound to the owning activity.

Specified by:

getOrCreateTrail in interface SasFacility

Parameters:

event - An event on the Activity to fetch the trail from

Returns:

The trail attached to the referenced activity.

getOrCreateTrail

public Trail getOrCreateTrail(ActivityContextInterface aci)

Description copied from interface: SasFacility

Get the trail attached to an activity or a new trail if one is not bound. The new trail will be bound to the activity.

This method is only usable from SasFacility instances obtained from an SBB context.

Specified by:

getOrCreateTrail in interface SasFacility

Parameters:

aci - An ACI referencing the Activity to get the trail from

Returns:

The trail attached to the referenced activity.