com.sonicsw.xq
Interface XQProcessContext

All Superinterfaces:

XQRuntimeProcess

All Known Subinterfaces:

XQFaultProcessContext

public interface XQProcessContext
extends XQRuntimeProcess

An XQProcessContext provides process-related information to a service when it is performing its per-message processing.

Method Summary

java.lang.String	getDescription() Returns the process description.
java.lang.String	getName() Returns the name of the process.
java.util.Iterator<XQAddress>	getNextAddresses() Returns the next addresses from this step in the itinerary.
XQProcessContinuation	getProcessContinuation(XQProcessContinuation.Level ctnLevel) Return a new process continuation object.
int	getQoS() This method is DEPRECATED.
XQAddress	getStepAddress(java.lang.String stepName) Returns the address corresponding to the step name, in the currently executing process.
int	getStepType() Returns the current step type in the itinerary.
long	getTimestamp() Returns the timestamp of the current message.
java.lang.String	getTopProcessName() Returns the name of the top-level, or root process, in a nested itinerary.

Methods inherited from interface com.sonicsw.xq.XQRuntimeProcess

addExitEndpoint, getEventAddress, getExitEndpoints, getFaultAddress, getInflightProperties, getQualityofService, getRMEAddress, getStepName, getTrackingID, getTrackingLevel, getTTL, removeAllExitEndpoints, removeExitEndpoint, setEventAddress, setFaultAddress, setInflightProperties, setRMEAddress, setTrackingID, setTrackingLevel, setTTL

Method Detail

getName

java.lang.String getName()

Returns the name of the process.

Returns:

the process name

getDescription

java.lang.String getDescription()

Returns the process description.

Returns:

the process description

getQoS

int getQoS()

This method is DEPRECATED. See getQualityOfService( ). Returns the operating QoS level. Note that this value may not be the configured QoS level of the current process if it is nested in another process.

Returns:

the current QoS level

getTimestamp

long getTimestamp()

Returns the timestamp of the current message.

Returns:

the timestamp of the message as milliseconds since midnight, Jan. 1, 1970 UTC.

getStepType

int getStepType()

Returns the current step type in the itinerary.

Returns:

the current step type

getNextAddresses

java.util.Iterator<XQAddress> getNextAddresses()

Returns the next addresses from this step in the itinerary.

Returns:

an Iterator containing the next XQAddresses

getTopProcessName

java.lang.String getTopProcessName()

Returns the name of the top-level, or root process, in a nested itinerary. This is equivalent to calling getParameter(XQConstants.PARAM_TOP_PROCESS_NAME) on the XQServiceContext. The method XQProcessContext.getName() will return the name of the sub-process.

Returns:

the top-level process name

getStepAddress

XQAddress getStepAddress(java.lang.String stepName)
                         throws java.lang.Exception

Returns the address corresponding to the step name, in the currently executing process.

Parameters:

stepName - String containing the name of a step within a process. It should not contain the ":" character.

Returns:

the XQAddress corresponding to the stepName. If step name is null, the return value is null

Throws:

XQAddressNotFoundException

java.lang.Exception

getProcessContinuation

XQProcessContinuation getProcessContinuation(XQProcessContinuation.Level ctnLevel)

Return a new process continuation object. This method will be used by the service that is performing the passivation.

Parameters:

ctnLevel - The level of continuation that should be returned

Returns:

A process continuation object

Throws:

java.lang.Exception

See Also:

XQProcessContinuation