org.miloss.fgsms.agentcore.mp

Class DefaultMessageProcessor

java.lang.Object

org.miloss.fgsms.agentcore.mp.DefaultMessageProcessor

All Implemented Interfaces:

IMessageProcessor

public class DefaultMessageProcessor
extends Object
implements IMessageProcessor

The Message Processor handles and manages the collection of Transactional Web Service records. Using data from the fgsms PCS, the MP sends performance stats to the fgsms DCS.

Features support for online/offline data storage, roundrobin/failover support and discovery of FGSMS service endpoints

Author:

AO

See Also:

IMessageProcessor, ConfigLoader

Constructor Summary

Constructors

Constructor and Description
DefaultMessageProcessor()

Method Summary

Methods

Modifier and Type	Method and Description
void	abort() purges all queues and maps
void	clearTransactionThreadId(long ThreadId)
protected boolean	containsSLAXpathOrUserIdentXpath(TransactionalWebServicePolicy pol) used to determine if we need to save the request or response
protected boolean	doesSLAContainXpath(SLA get) used to determine if we need to record the request/response pair
protected boolean	doesSLARuleContainXpath(RuleBaseType rule) recursive used to determine if we need to record the request/response pair
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
protected String	ipWrapAndCacher(String URL) IP to DNS mappings to speed up performance non blocking
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 msg)
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()

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultMessageProcessor

public DefaultMessageProcessor()

Method Detail

getThreadMapSize

public int getThreadMapSize()

Specified by:

getThreadMapSize in interface IMessageProcessor

purgeThreadMap

public void purgeThreadMap()

Specified by:

purgeThreadMap in interface IMessageProcessor

abort

public void abort()

Description copied from interface: IMessageProcessor

purges all queues and maps

Specified by:

abort in interface IMessageProcessor

ipWrapAndCacher

protected String ipWrapAndCacher(String URL)

IP to DNS mappings to speed up performance non blocking

Parameters:

URL -

Returns:

clearTransactionThreadId

public void clearTransactionThreadId(long ThreadId)

Specified by:

clearTransactionThreadId in interface IMessageProcessor

forceNewDataPusherThread

public void forceNewDataPusherThread()

Description copied from interface: IMessageProcessor

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

Specified by:

forceNewDataPusherThread in interface IMessageProcessor

getConfig

public ConfigLoader getConfig()

Specified by:

getConfig in interface IMessageProcessor

getHostName

public String getHostName()

Description copied from interface: IMessageProcessor

returns the lowercase value of the current hostname

Specified by:

getHostName in interface IMessageProcessor

Returns:

getLastErrorMessage

public String getLastErrorMessage()

Specified by:

getLastErrorMessage in interface IMessageProcessor

getPolicyCache

public int getPolicyCache()

Description copied from interface: IMessageProcessor

gets the size of the current policy cache

Specified by:

getPolicyCache in interface IMessageProcessor

Returns:

getPolicyIfAvailable

public TransactionalWebServicePolicy getPolicyIfAvailable(String url)

Description copied from interface: IMessageProcessor

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.

Specified by:

getPolicyIfAvailable in interface IMessageProcessor

Returns:

service policy, possibly null

getTotalmessagesprocessed

public long getTotalmessagesprocessed()

Specified by:

getTotalmessagesprocessed in interface IMessageProcessor

Returns:

the totalmessagesprocessed

getTransactionThreadId

public String getTransactionThreadId(Long ThreadId)

Description copied from interface: IMessageProcessor

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

Specified by:

getTransactionThreadId in interface IMessageProcessor

getUserIdentities

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

Description copied from interface: IMessageProcessor

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

Specified by:

getUserIdentities in interface IMessageProcessor

Parameters:

p - policy

Returns:

getUsersfromXpath

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

Description copied from interface: IMessageProcessor

returns user identities via xpath

Specified by:

getUsersfromXpath in interface IMessageProcessor

Returns:

incMessagesProcessed

public void incMessagesProcessed(int size)

Specified by:

incMessagesProcessed in interface IMessageProcessor

internalMessageMapSize

public int internalMessageMapSize()

Description copied from interface: IMessageProcessor

gets the size of the current message map

Specified by:

internalMessageMapSize in interface IMessageProcessor

Returns:

outboundQueueSize

public int outboundQueueSize()

Description copied from interface: IMessageProcessor

gets the size of the current queue

Specified by:

outboundQueueSize in interface IMessageProcessor

Returns:

processMessageInput

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

Description copied from interface: IMessageProcessor

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

Specified by:

processMessageInput in interface IMessageProcessor

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

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

Description copied from interface: IMessageProcessor

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

Specified by:

processMessageOutput in interface IMessageProcessor

processMessageOutput

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

Description copied from interface: IMessageProcessor

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

Specified by:

processMessageOutput in interface IMessageProcessor

Parameters:

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

responseXML - response payload

dod - time of death, no longer used

processPreppedMessage

public void processPreppedMessage(AddDataRequestMsg request)

Description copied from interface: IMessageProcessor

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

Specified by:

processPreppedMessage in interface IMessageProcessor

purgeMessageMap

public void purgeMessageMap()

Description copied from interface: IMessageProcessor

purges the map

Specified by:

purgeMessageMap in interface IMessageProcessor

purgeOutboundQueue

public void purgeOutboundQueue()

Description copied from interface: IMessageProcessor

purges the queue

Specified by:

purgeOutboundQueue in interface IMessageProcessor

purgePolicyCache

public void purgePolicyCache()

Description copied from interface: IMessageProcessor

purges the policy cache

Specified by:

purgePolicyCache in interface IMessageProcessor

removeDeadMessage

public void removeDeadMessage()

Description copied from interface: IMessageProcessor

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

Specified by:

removeDeadMessage in interface IMessageProcessor

removeFromQueue

public void removeFromQueue(UUID id)

Description copied from interface: IMessageProcessor

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

Specified by:

removeFromQueue in interface IMessageProcessor

removeFromQueue

public void removeFromQueue(String id)

Description copied from interface: IMessageProcessor

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

Specified by:

removeFromQueue in interface IMessageProcessor

setRunning

public void setRunning(boolean b)

Specified by:

setRunning in interface IMessageProcessor

setTransactionThreadId

public void setTransactionThreadId(Long ThreadId,
                          String id)
                            throws Exception

Description copied from interface: IMessageProcessor

* Dependency Detection Only Set on an inbound service request

Specified by:

setTransactionThreadId in interface IMessageProcessor

Throws:

Exception

shouldAgentRecordRequestContent

public boolean shouldAgentRecordRequestContent(String requesturl)

Description copied from interface: IMessageProcessor

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

Specified by:

shouldAgentRecordRequestContent in interface IMessageProcessor

Returns:

doesSLAContainXpath

protected boolean doesSLAContainXpath(SLA get)

used to determine if we need to record the request/response pair

Parameters:

get -

Returns:

doesSLARuleContainXpath

protected boolean doesSLARuleContainXpath(RuleBaseType rule)

recursive used to determine if we need to record the request/response pair

Parameters:

rule -

Returns:

containsSLAXpathOrUserIdentXpath

protected boolean containsSLAXpathOrUserIdentXpath(TransactionalWebServicePolicy pol)

used to determine if we need to save the request or response

Parameters:

pol -

Returns:

shouldAgentRecordResponseContent

public boolean shouldAgentRecordResponseContent(String requesturl)

Description copied from interface: IMessageProcessor

performance optimization to be used by agents

Specified by:

shouldAgentRecordResponseContent in interface IMessageProcessor

Returns:

terminate

public void terminate()

Specified by:

terminate in interface IMessageProcessor

getIgnoreList

public Set<String> getIgnoreList()

Description copied from interface: IMessageProcessor

list of soap actions that should be ignored by agents

Specified by:

getIgnoreList in interface IMessageProcessor

Returns:

getURLaddressMap

public Map<String,String> getURLaddressMap()

Specified by:

getURLaddressMap in interface IMessageProcessor

Returns:

the URLaddressMap

isDependencyInjectionEnabled

public boolean isDependencyInjectionEnabled()

Specified by:

isDependencyInjectionEnabled in interface IMessageProcessor

setLastErrorMessage

public void setLastErrorMessage(String msg)

Specified by:

setLastErrorMessage in interface IMessageProcessor