ariba.util.core
Class PerformanceState.Stats

java.lang.Object
  java.util.AbstractMap
      ariba.util.core.Hashtable
          ariba.util.core.EqHashtable
              ariba.util.core.PerformanceState.Stats

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, java.util.Map

Enclosing class:

PerformanceState

public static class PerformanceState.Stats
extends EqHashtable

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Constructor Summary

PerformanceState.Stats()

Method Summary

java.lang.String	getAcceptLanguage()
java.lang.String	getAppDimension1() AppDimension (1 & 2) can be used for storing application-specific categorization information that can we used to slice/group information during analysis.
java.lang.String	getAppDimension2()
java.lang.String	getAppInfo() Arbitrary descriptive information that will be written to the CSV.
PerformanceState	getAppMetric() An additional metric that should be logged in the CSV.
java.lang.String	getDestinationArea()
java.lang.String	getDestinationPage() The page returned from the request
java.lang.String	getDisplayPageArea() Returns String suitable to display in perf or other logging, encoding context information in (source, destination) x (Page, Area), while avoiding boring repetition.
java.lang.String	getIPAddress()
PerformanceCheck	getPerformanceCheck()
java.lang.String	getRealm()
java.lang.String	getRealmType()
java.lang.String	getReferer()
java.lang.String	getScreenSize()
java.lang.String	getSessionID()
java.lang.String	getShutdownMode()
java.lang.String	getSourceArea() Sub-area within the source page.
java.lang.String	getSourcePage() For AW this is the AW page (class name) that processed the incoming request.
java.lang.String	getStatus() Status_Success, Status_InternalError, etc...
java.lang.String	getTabIndex() Returns the index of the current page regarding the multitab feature 0, 1, 2, ...
java.lang.String	getTestId()
java.lang.String	getTestLine()
java.lang.String	getTestShortId()
java.lang.String	getType() Type_User, Type_Task, etc...
java.lang.String	getUser()
java.lang.String	getUserAgent()
boolean	isRecordingSuspended() Indicates whether this performance state has suspended recording changes to stats.
boolean	isToBeContinued() Indicates that this performance state will be continued in a subsequent request (and so should not be logged on clear().
void	setAcceptLanguage(java.lang.String languages)
void	setAppDimension1(java.lang.String appDimension1)
void	setAppDimension2(java.lang.String appDimension2)
void	setAppInfo(java.lang.String appInfo)
void	setAppMetric(PerformanceState appMetric)
void	setDestinationArea(java.lang.String destinationArea)
void	setDestinationPage(java.lang.String destinationPage)
void	setIPAddress(java.lang.String ipAddress)
void	setRealm(java.lang.String realm)
void	setRealmType(java.lang.String realmType)
void	setRecordingSuspended(boolean recordingSuspended) Allows suspension of recording stats.
void	setReferer(java.lang.String url)
void	setScreenSize(java.lang.String size)
void	setSessionID(java.lang.String sessionID)
void	setShutdownMode(java.lang.String shutdownMode)
void	setSourceArea(java.lang.String sourceArea)
void	setSourcePage(java.lang.String sourcePage)
void	setStatus(java.lang.String status)
void	setTabIndex(java.lang.String tabIndex)
void	setTestId(java.lang.String testId)
void	setTestLine(java.lang.String testLine)
void	setTestShortId(java.lang.String testShortId)
void	setToBeContinued(boolean toBeContinued)
void	setType(java.lang.String type)
void	setUser(java.lang.String user)
void	setUserAgent(java.lang.String agent)
java.lang.String	toString() Returns the Hashtable's string representation.

Methods inherited from class ariba.util.core.Hashtable

clear, clone, contains, containsKey, count, elements, elementsArray, elementsVector, entrySet, fromSerializedString, get, isEmpty, keys, keysArray, keySet, keysVector, put, readExternal, remove, removeElement, size, toSerializedString, toStringArray, values, writeExternal

Methods inherited from class java.util.AbstractMap

containsValue, equals, hashCode, putAll

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PerformanceState.Stats

public PerformanceState.Stats()

Method Detail

getPerformanceCheck

public PerformanceCheck getPerformanceCheck()

isToBeContinued

public boolean isToBeContinued()

Indicates that this performance state will be continued in a subsequent request (and so should not be logged on clear(). This is used by AWSession when it bridges a single perf measure across the two-request form-post-redirect sequence.

setToBeContinued

public void setToBeContinued(boolean toBeContinued)

isRecordingSuspended

public boolean isRecordingSuspended()

Indicates whether this performance state has suspended recording changes to stats.

setRecordingSuspended

public void setRecordingSuspended(boolean recordingSuspended)

Allows suspension of recording stats. Care should be taken to ensure that any suspension is revoked by encapsulating the call in a try..finally block: PerformanceState.Stats stats = PerformanceState.getThisThreadHashtable(); try { stats.setRecordingSuspended(true); ... } finally { stats.setRecordingSuspended(false); }

getRealm

public java.lang.String getRealm()

setRealm

public void setRealm(java.lang.String realm)

getSessionID

public java.lang.String getSessionID()

getRealmType

public java.lang.String getRealmType()

setRealmType

public void setRealmType(java.lang.String realmType)

setSessionID

public void setSessionID(java.lang.String sessionID)

getIPAddress

public java.lang.String getIPAddress()

setIPAddress

public void setIPAddress(java.lang.String ipAddress)

getUser

public java.lang.String getUser()

setUser

public void setUser(java.lang.String user)

getSourcePage

public java.lang.String getSourcePage()

For AW this is the AW page (class name) that processed the incoming request. Could re-appropriated for scheduled tasks to be the scheduled task name

setSourcePage

public void setSourcePage(java.lang.String sourcePage)

getSourceArea

public java.lang.String getSourceArea()

Sub-area within the source page. Could be the Tab name or Wizard step

setSourceArea

public void setSourceArea(java.lang.String sourceArea)

getDestinationPage

public java.lang.String getDestinationPage()

The page returned from the request

setDestinationPage

public void setDestinationPage(java.lang.String destinationPage)

getDestinationArea

public java.lang.String getDestinationArea()

setDestinationArea

public void setDestinationArea(java.lang.String destinationArea)

getDisplayPageArea

public java.lang.String getDisplayPageArea()

Returns String suitable to display in perf or other logging, encoding context information in (source, destination) x (Page, Area), while avoiding boring repetition.

getTabIndex

public java.lang.String getTabIndex()

Returns the index of the current page regarding the multitab feature 0, 1, 2, ... up to TabManager.maxCookies.

setTabIndex

public void setTabIndex(java.lang.String tabIndex)

getType

public java.lang.String getType()

Type_User, Type_Task, etc...

setType

public void setType(java.lang.String type)

getStatus

public java.lang.String getStatus()

Status_Success, Status_InternalError, etc...

setStatus

public void setStatus(java.lang.String status)

getAppMetric

public PerformanceState getAppMetric()

An additional metric that should be logged in the CSV. E.g.: PerformanceState.getThisThreadHashtable().setAppMetric(NumberOfSourcingEvents) This metric name and value will be logged in the CSV metrics file.

setAppMetric

public void setAppMetric(PerformanceState appMetric)

getAppInfo

public java.lang.String getAppInfo()

Arbitrary descriptive information that will be written to the CSV. Example usage: Name of the Report being opened, ...

setAppInfo

public void setAppInfo(java.lang.String appInfo)

getAppDimension1

public java.lang.String getAppDimension1()

AppDimension (1 & 2) can be used for storing application-specific categorization information that can we used to slice/group information during analysis. For instance, AQS might put RFXType, and RFXName here. Analysis might put Fact Table name, and UsesSlowDimensions flag.

setAppDimension1

public void setAppDimension1(java.lang.String appDimension1)

getAppDimension2

public java.lang.String getAppDimension2()

setAppDimension2

public void setAppDimension2(java.lang.String appDimension2)

getReferer

public java.lang.String getReferer()

setReferer

public void setReferer(java.lang.String url)

getAcceptLanguage

public java.lang.String getAcceptLanguage()

setAcceptLanguage

public void setAcceptLanguage(java.lang.String languages)

getUserAgent

public java.lang.String getUserAgent()

setUserAgent

public void setUserAgent(java.lang.String agent)

getTestId

public java.lang.String getTestId()

getTestShortId

public java.lang.String getTestShortId()

setTestShortId

public void setTestShortId(java.lang.String testShortId)

setTestId

public void setTestId(java.lang.String testId)

getTestLine

public java.lang.String getTestLine()

setTestLine

public void setTestLine(java.lang.String testLine)

getShutdownMode

public java.lang.String getShutdownMode()

setShutdownMode

public void setShutdownMode(java.lang.String shutdownMode)

getScreenSize

public java.lang.String getScreenSize()

setScreenSize

public void setScreenSize(java.lang.String size)

toString

public java.lang.String toString()

Description copied from class: Hashtable

Returns the Hashtable's string representation.

Overrides:

toString in class Hashtable

Returns:

the Hashtable's string representation