com.sonicsw.esb.mgmtapi.config
Interface IProcessConfig

All Superinterfaces:

IBaseConfig, IQos

public interface IProcessConfig
extends IBaseConfig, IQos

This interface represents an ESB itinerary (also known as an ESB process).

Nested Class Summary

static class

IProcessConfig.TrackingLevel

Nested classes/interfaces inherited from interface com.sonicsw.esb.mgmtapi.config.IQos

IQos.QOSLevel

Field Summary

static IProcessConfig.TrackingLevel	TRACKING_ADD_MESSAGE_CONTENT TRACKING_ADD_MESSAGE_CONTENT (4) tracks at the TRACKING_ADD_MESSAGE_HEADERS level and in addition adds the message contet of the tracked message to the tracking message content as a multipart message.
static IProcessConfig.TrackingLevel	TRACKING_ADD_MESSAGE_HEADERS TRACKING_ADD_MESSAGE_HEADERS (3) tracks at the TRACKING_SERVICE_ENTRY_AND_EXIT level and in addition adds the message headers of the tracked message to the tracking message content: <xqMessageHeaders> <header name="A">valueA</header> <header name="B">valueB</header> </xqMessageHeaders>
static IProcessConfig.TrackingLevel	TRACKING_OFF TRACKING_OFF (0) implies no tracking.
static IProcessConfig.TrackingLevel	TRACKING_PROCESS_ENTRY_AND_EXIT TRACKING_PROCESS_ENTRY_AND_EXIT (1) tracks when a message enters and leaves a SonicESB process, including nested processes.
static IProcessConfig.TrackingLevel	TRACKING_SERVICE_ENTRY_AND_EXIT TRACKING_SERVICE_ENTRY_AND_EXIT (2) tracks when a message enters and leave a SonicESB service deployed within a SonicESB process, in addition to tracking process entries and exits.

Fields inherited from interface com.sonicsw.esb.mgmtapi.config.IQos

AT_LEAST_ONCE, BEST_EFFORT, EXACTLY_ONCE

Method Summary

void	addExitAddress(IAddress exit) Add a new exit destination to the set of addresses outputs from the process are delivered to.
IServiceApplicationConfig	addToContainer(IContainerConfig container, int numListeners) Add to the container who's configuration was specified
void	clearExitAddresses() Empty out the set of exit destinations.
IAddress	getAsAddress() Get the process's address for use in API calls which require an address.
java.lang.String	getDescription()
IEndpointConfig	getEntryEndpointConfig()
IAddress[]	getExitAddresses()
IAddress	getFaultAddress()
IAddress	getFaultHandlerAddress()
IQos.QOSLevel	getQOSLevel()
IAddress	getRejectedMessageAddress()
long	getTimeToLive()
IAddress	getTrackingDestination()
IProcessConfig.TrackingLevel	getTrackingLevel()
java.lang.String	getTrackingRulesFile()
java.lang.String	getWSDLUrl()
boolean	removeFromContainer(IContainerConfig container) Remove the process from the container, if it was deployed there.
void	setDescription(java.lang.String description)
void	setEntryEndpointConfig(IEndpointConfig entry) Set the destination to which Fault messages are sent by default.
void	setExitAddress(IAddress[] exits) Replace the currently configured set of exit destinations with the new set.
void	setFaultAddress(IAddress fault) Set the destination to which Fault messages are sent by default.
void	setFaultHandlerAddress(IAddress faultHandlerAddress) Set the configured destination for process Fault Handler
void	setQOSLevel(IQos.QOSLevel qosLevel) Set the Quality of Service for the process.
void	setRejectedMessageAddress(IAddress rme) Set the destination to which Rejected Messages are sent.
void	setTimeToLive(long timeToLive)
void	setTrackingDestination(IAddress tackingDestination) Set the destination to which tracking messages generated by the process are sent to.
void	setTrackingLevel(IProcessConfig.TrackingLevel level) Set the verbosity of tracking messages generated by this process. see above e.g.
void	setTrackingRulesFile(java.lang.String trackingRulesFile) Set the JavaScript rules file for generating ID's for tracking messages.
void	setWSDLUrl(java.lang.String url)

Methods inherited from interface com.sonicsw.esb.mgmtapi.config.IBaseConfig

getName, getType

Field Detail

TRACKING_OFF

static final IProcessConfig.TrackingLevel TRACKING_OFF

TRACKING_OFF (0) implies no tracking.

TRACKING_PROCESS_ENTRY_AND_EXIT

static final IProcessConfig.TrackingLevel TRACKING_PROCESS_ENTRY_AND_EXIT

TRACKING_PROCESS_ENTRY_AND_EXIT (1) tracks when a message enters and leaves a SonicESB process, including nested processes.

TRACKING_SERVICE_ENTRY_AND_EXIT

static final IProcessConfig.TrackingLevel TRACKING_SERVICE_ENTRY_AND_EXIT

TRACKING_SERVICE_ENTRY_AND_EXIT (2) tracks when a message enters and leave a SonicESB service deployed within a SonicESB process, in addition to tracking process entries and exits.

TRACKING_ADD_MESSAGE_HEADERS

static final IProcessConfig.TrackingLevel TRACKING_ADD_MESSAGE_HEADERS

TRACKING_ADD_MESSAGE_HEADERS (3) tracks at the TRACKING_SERVICE_ENTRY_AND_EXIT level and in addition adds the message headers of the tracked message to the tracking message content:

  <xqMessageHeaders>
    <header name="A">valueA</header>
    <header name="B">valueB</header>
  </xqMessageHeaders>
 

TRACKING_ADD_MESSAGE_CONTENT

static final IProcessConfig.TrackingLevel TRACKING_ADD_MESSAGE_CONTENT

TRACKING_ADD_MESSAGE_CONTENT (4) tracks at the TRACKING_ADD_MESSAGE_HEADERS level and in addition adds the message contet of the tracked message to the tracking message content as a multipart message.

 For tracking Level 4, the Tracking Message would always be a Multipart Message.
 The first part would have the same content as Tracking Level 3 above.   The part would be:
     �  Content-Id: TrackingMessage
     �  Content-Type: text/xml
 
 Parts 2�n+1 of the Tracking Message would be copies of parts 1�n of the original XQMessage.
 Note that for the case of the original message having no parts, the tracking message would be a
 single part MultipartMessage.
 
 In other words,
  � The user could recover the original message parts by looking at parts 2..n+1 of the Tracking Messages.
    This would include:
    �   Part Headers
    �   Part Content
 
  � The user could recover the original messages Headers by parsing the TrackingMessage part (Part 1) and
    getting header values from the <xqMessageHeaders/>
 
 
 

Method Detail

getWSDLUrl

java.lang.String getWSDLUrl()

Returns:

the URL pointing to the WSDL file associated with the process.

setWSDLUrl

void setWSDLUrl(java.lang.String url)

Parameters:

url - - A sonicfs:// URL pointing to the WSDL file associated with the process.

getTimeToLive

long getTimeToLive()

Returns:

- the currently configured Time To Live value for instances of the process.

setTimeToLive

void setTimeToLive(long timeToLive)

Parameters:

timeToLive - - set the elapsed time processes are allowed to continue execution. 0 represents forever. Expiration is evaluated before a message is dispatched to a service. The expiration time is set by the container which first processes a message.

getDescription

java.lang.String getDescription()

Returns:

- the description associated with the process. Also refered to as Notes.

setDescription

void setDescription(java.lang.String description)

Parameters:

description - - some descriptive text about the process.

getQOSLevel

IQos.QOSLevel getQOSLevel()

Returns:

- the configured Quality of Service for the process. See IQos.QOSLevel

setQOSLevel

void setQOSLevel(IQos.QOSLevel qosLevel)

Set the Quality of Service for the process. See IQos.QOSLevel

getAsAddress

IAddress getAsAddress()

Get the process's address for use in API calls which require an address. The returned value represents the process's address, not it's entry endpoint.

Returns:

an IAddress instance.

setEntryEndpointConfig

void setEntryEndpointConfig(IEndpointConfig entry)

Set the destination to which Fault messages are sent by default.

getEntryEndpointConfig

IEndpointConfig getEntryEndpointConfig()

Returns:

the configured entry endpoint, if any. If none, null.

getExitAddresses

IAddress[] getExitAddresses()

Returns:

- the set of exit destinations from the process.

addExitAddress

void addExitAddress(IAddress exit)

Add a new exit destination to the set of addresses outputs from the process are delivered to.

Parameters:

exit - - the new exist destination

setExitAddress

void setExitAddress(IAddress[] exits)

Replace the currently configured set of exit destinations with the new set.

Parameters:

exits - - new set of exit destination

clearExitAddresses

void clearExitAddresses()

Empty out the set of exit destinations.

getFaultAddress

IAddress getFaultAddress()

Returns:

- the configured destination to which Fault messages are sent.

setFaultAddress

void setFaultAddress(IAddress fault)

Set the destination to which Fault messages are sent by default.

getFaultHandlerAddress

IAddress getFaultHandlerAddress()

Returns:

- the configured destination for process Fault Handler

setFaultHandlerAddress

void setFaultHandlerAddress(IAddress faultHandlerAddress)

Set the configured destination for process Fault Handler

getRejectedMessageAddress

IAddress getRejectedMessageAddress()

Returns:

- the configured destination to which Rejected Messages are sent.

setRejectedMessageAddress

void setRejectedMessageAddress(IAddress rme)

Set the destination to which Rejected Messages are sent.

setTrackingLevel

void setTrackingLevel(IProcessConfig.TrackingLevel level)

Set the verbosity of tracking messages generated by this process. see above e.g. TRACKING_OFF TRACKING_ADD_MESSAGE_CONTENT When you enable tracking (a value other than TRACKING_OFF) you also need to set the tracking rules file and the tracking destination as all tracking information is saved to the process. When you disable tracking (TRACKING_OFF) all tracking information is removed from the process and any settings for tracking rules file and tracking destination will be discarded

Parameters:

level - - one of the predefined constants of type TrackingLevel

getTrackingLevel

IProcessConfig.TrackingLevel getTrackingLevel()

Returns:

the configured verbosity of tracking messages.

getTrackingRulesFile

java.lang.String getTrackingRulesFile()

Returns:

- the configured JavaScript rules file for generating ID's for tracking messages.

setTrackingRulesFile

void setTrackingRulesFile(java.lang.String trackingRulesFile)

Set the JavaScript rules file for generating ID's for tracking messages.

Parameters:

trackingRulesFile - - a URL to JavaScript file.

getTrackingDestination

IAddress getTrackingDestination()

Returns:

- the destination to which tracking messages generated by the process are sent to.

setTrackingDestination

void setTrackingDestination(IAddress tackingDestination)

Set the destination to which tracking messages generated by the process are sent to.

addToContainer

IServiceApplicationConfig addToContainer(IContainerConfig container,
                                         int numListeners)

Add to the container who's configuration was specified

Parameters:

container -

numListeners -

Returns:

a IServiceApplication capturing the configuration of the deployed instance.

removeFromContainer

boolean removeFromContainer(IContainerConfig container)

Remove the process from the container, if it was deployed there.

Parameters:

container - the container from which to remove

Returns:

true if removed.