org.miloss.fgsms.agentcore

Interface IMessageProcessor

All Known Implementing Classes:

DefaultMessageProcessor, DropAllMessageProcessor

public interface IMessageProcessor

Author:

AO

Method Summary

Methods

Modifier and Type	Method and Description
void	abort() purges all queues and maps
void	clearTransactionThreadId(long ThreadId)
void	forceNewDataPusherThread() Use with caution.
ConfigLoader	getConfig()
String	getHostName() returns the lowercase value of the current hostname
Set<String>	getIgnoreList() list of soap actions that should be ignored by agents
String	getLastErrorMessage()
int	getPolicyCache() gets the size of the current policy cache
TransactionalWebServicePolicy	getPolicyIfAvailable(String url) Attempts to find and return a service policy from the local cache.
int	getThreadMapSize()
long	getTotalmessagesprocessed()
String	getTransactionThreadId(Long ThreadId) Dependency Detection This should only be called in the context of a client handler seeing outbound transactions
Map<String,String>	getURLaddressMap()
ArrayList<String>	getUserIdentities(TransactionalWebServicePolicy p, MessageCorrelator mc) turns all user identities as defined by the service policy, plus ip addresses
ArrayList<String>	getUsersfromXpath(ArrayOfXPathExpressionType xpaths, String message) returns user identities via xpath
void	incMessagesProcessed(int size)
int	internalMessageMapSize() gets the size of the current message map
boolean	isDependencyInjectionEnabled()
int	outboundQueueSize() gets the size of the current queue
void	processMessageInput(String XMLrequest, int requestSize, String url, String soapAction, String HttpUsername, String HashCode, HashMap headers, String ipaddress, String agentclassname, String relatedtransaction, String threadid) caches stored data and adds it to the message map.
void	processMessageOutput(String HashCode, String responseXML, int responseSize, boolean isFault, Long dod, HashMap headers) pairs up a response with a request and adds it to the queue for transmission
void	processMessageOutput(String HashCode, String responseXML, int responseSize, boolean isFault, Long dod, HashMap headers, String relatedTransaction) wrapper to the main function This is normally only called when a CLIENT receives a response from a service
void	processPreppedMessage(AddDataRequestMsg request) this assumes that the request is already prepopulated with all required information according the policy for this item typically used for the offline persistent storage agent.
void	purgeMessageMap() purges the map
void	purgeOutboundQueue() purges the queue
void	purgePolicyCache() purges the policy cache
void	purgeThreadMap()
void	removeDeadMessage() Any message in the Message Map older than the dead message interval will be removed from the Message Map, flagged as faulted and added to the outbound queue
void	removeFromQueue(String id) Use when for some reason, a transaction cannot be monitored NOTE, removes from the Message Map, not the outbound queue
void	removeFromQueue(UUID id) Use when for some reason, a transaction cannot be monitored NOTE, removes from the Message Map, not the outbound queue
void	setLastErrorMessage(String all_PCS_endpoints_are_either_unreachable_)
void	setRunning(boolean b)
void	setTransactionThreadId(Long ThreadId, String id) * Dependency Detection Only Set on an inbound service request
boolean	shouldAgentRecordRequestContent(String requesturl) performance optimzation to be used by agents that determines if the request body should be it uses a lazy algorithm for resolving request urls to modified urls and will always resort to being on the safe side
boolean	shouldAgentRecordResponseContent(String requesturl) performance optimization to be used by agents
void	terminate()

Method Detail

isDependencyInjectionEnabled

boolean isDependencyInjectionEnabled()

abort

void abort()

purges all queues and maps

clearTransactionThreadId

void clearTransactionThreadId(long ThreadId)

forceNewDataPusherThread

void forceNewDataPusherThread()

Use with caution. this will fire up a new thread. this is provided specifically for mbean management

getConfig

ConfigLoader getConfig()

getHostName

String getHostName()

returns the lowercase value of the current hostname

Returns:

getLastErrorMessage

String getLastErrorMessage()

getPolicyCache

int getPolicyCache()

gets the size of the current policy cache

Returns:

getPolicyIfAvailable

TransactionalWebServicePolicy getPolicyIfAvailable(String url)

Attempts to find and return a service policy from the local cache. if it is not available, null will be returned. should never throw an exception. use this function as a memory footprint reducer.

Parameters:

url -

Returns:

service policy, possibly null

getTotalmessagesprocessed

long getTotalmessagesprocessed()

Returns:

the totalmessagesprocessed

getTransactionThreadId

String getTransactionThreadId(Long ThreadId)

Dependency Detection This should only be called in the context of a client handler seeing outbound transactions

getUserIdentities

ArrayList<String> getUserIdentities(TransactionalWebServicePolicy p,
                                  MessageCorrelator mc)

turns all user identities as defined by the service policy, plus ip addresses

Parameters:

p - policy

mc, - current mesage correlation

Returns:

getUsersfromXpath

ArrayList<String> getUsersfromXpath(ArrayOfXPathExpressionType xpaths,
                                  String message)

returns user identities via xpath

Parameters:

xpaths -

message -

Returns:

internalMessageMapSize

int internalMessageMapSize()

gets the size of the current message map

Returns:

outboundQueueSize

int outboundQueueSize()

gets the size of the current queue

Returns:

processMessageInput

void processMessageInput(String XMLrequest,
                       int requestSize,
                       String url,
                       String soapAction,
                       String HttpUsername,
                       String HashCode,
                       HashMap headers,
                       String ipaddress,
                       String agentclassname,
                       String relatedtransaction,
                       String threadid)

caches stored data and adds it to the message map. see note on agentclassname reference

Parameters:

XMLrequest - - may be null, the request content

requestSize - - size of the payload

url - - the requested URL that the client asked for http://localhost/path

soapAction - - SOAPAction or HTTP Method

HttpUsername - the username or DN of the requestor

HashCode - - very important, a unique identifier for this message. Use UUID.random

headers - - Transport layer headers of the request

ipaddress - - IP of the requestor

agentclassname - - the class of the agent that recorded the message. MUST CONTAIN "client" IF THIS IS A CLIENT or from a proxy TRANSACTION!! this is necessary for proper URL resolution

relatedtransaction - - if this transaction was also recorded elsewhere, pull this data from the http headers

threadid - - if this transaction was also recorded elsewhere, pull this data from the http headers. or generate a new one if it was not present using UUID.random

processMessageOutput

void processMessageOutput(String HashCode,
                        String responseXML,
                        int responseSize,
                        boolean isFault,
                        Long dod,
                        HashMap headers,
                        String relatedTransaction)

wrapper to the main function This is normally only called when a CLIENT receives a response from a service

Parameters:

HashCode -

responseXML -

responseSize -

isFault -

dod -

headers -

relatedTransaction -

processMessageOutput

void processMessageOutput(String HashCode,
                        String responseXML,
                        int responseSize,
                        boolean isFault,
                        Long dod,
                        HashMap headers)

pairs up a response with a request and adds it to the queue for transmission

Parameters:

HashCode - the UUID of the message that links this response to the request

responseXML - response payload

responseSize -

isFault -

dod - time of death, no longer used

headers -

processPreppedMessage

void processPreppedMessage(AddDataRequestMsg request)

this assumes that the request is already prepopulated with all required information according the policy for this item typically used for the offline persistent storage agent. As of RC6

Parameters:

request -

purgeMessageMap

void purgeMessageMap()

purges the map

purgeOutboundQueue

void purgeOutboundQueue()

purges the queue

purgePolicyCache

void purgePolicyCache()

purges the policy cache

removeDeadMessage

void removeDeadMessage()

Any message in the Message Map older than the dead message interval will be removed from the Message Map, flagged as faulted and added to the outbound queue

removeFromQueue

void removeFromQueue(UUID id)

Use when for some reason, a transaction cannot be monitored NOTE, removes from the Message Map, not the outbound queue

Parameters:

id -

removeFromQueue

void removeFromQueue(String id)

Use when for some reason, a transaction cannot be monitored NOTE, removes from the Message Map, not the outbound queue

Parameters:

id -

setRunning

void setRunning(boolean b)

setTransactionThreadId

void setTransactionThreadId(Long ThreadId,
                          String id)
                            throws Exception

* Dependency Detection Only Set on an inbound service request

Throws:

Exception

shouldAgentRecordRequestContent

boolean shouldAgentRecordRequestContent(String requesturl)

performance optimzation to be used by agents that determines if the request body should be it uses a lazy algorithm for resolving request urls to modified urls and will always resort to being on the safe side

Parameters:

requesturl -

Returns:

shouldAgentRecordResponseContent

boolean shouldAgentRecordResponseContent(String requesturl)

performance optimization to be used by agents

Parameters:

requesturl -

Returns:

terminate

void terminate()

getIgnoreList

Set<String> getIgnoreList()

list of soap actions that should be ignored by agents

Returns:

getURLaddressMap

Map<String,String> getURLaddressMap()

Returns:

the URLaddressMap

getThreadMapSize

int getThreadMapSize()

purgeThreadMap

void purgeThreadMap()

setLastErrorMessage

void setLastErrorMessage(String all_PCS_endpoints_are_either_unreachable_)

incMessagesProcessed

void incMessagesProcessed(int size)