|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.apptelemetry.apm.APMApplication
public class APMApplication
Constructor Summary | |
---|---|
APMApplication(java.lang.String applName,
java.lang.String applId,
java.lang.String applTier,
java.lang.String applTierId)
Create a new Software-Telemetry application and register it on the app.telemetry Server. |
Method Summary | |
---|---|
void |
AttachContext(byte[] context)
Call AttachContext to restore the context acquired through GetContext in another thread or process. |
void |
CreateContext(java.lang.String filterValue)
Call CreateContext to create a new Software-Telemetry context. |
byte[] |
GetContext()
Call GetContext to get a context handle, which can be passed to another threads or processes. |
static APMApplication |
GetCurrent()
|
byte[] |
GetSyncMark()
Call GetSyncMark to get a synchronization handle that can be passed to another thread or process to synchronize control flow. |
boolean |
HasActiveContext(byte level)
Call HasActiveContext to test, if a software-telemetry session is active for some logging level. |
void |
RegisterFilterValue(java.lang.String filterValue,
java.lang.String filterDescription)
Call RegisterFilterValue for each valid filter value. |
void |
ReleaseContext()
Call ReleaseContext to finish logging and to flush logged information to the STRUDL infrastructure. |
void |
Report(java.lang.String filterValue,
java.lang.String reportKey,
java.lang.String description)
Call STRUDLReport to create a new feedback report. |
void |
ReportContent(java.lang.String reportKey,
java.lang.String filename,
java.lang.String mimetype,
byte[] content)
Call ReportContent to add binary values to a previously created feedback report. |
void |
ReportValue(java.lang.String reportKey,
java.lang.String key,
java.lang.String value)
Call ReportValue to add values to a previously created feedback report. |
void |
SetSyncMark(byte[] syncMark)
Call SetSyncMark to pass a synchronization handle you got from GetSyncMark for synchronizing the sequence of events. |
void |
SyncContext(byte[] context)
Call SyncContext to mark the return point of a synchronous call to another thread or process. |
void |
Unregister()
Call Unregister to cleanup data structures immediately. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public APMApplication(java.lang.String applName, java.lang.String applId, java.lang.String applTier, java.lang.String applTierId)
applName
- (String) The name of the application.applId
- (String) The ID of the application.applTier
- (String) For multi-tiered applications pass the name of the tier to be registered.applTierId
- (String) For multi-tiered applications pass the ID of the tier to be registered.
This ID needs to be unique for a certain applTier.Method Detail |
---|
public static APMApplication GetCurrent()
public void Unregister()
public void RegisterFilterValue(java.lang.String filterValue, java.lang.String filterDescription)
filterValue
- Filter string that identifies the filter.filterDescription
- Description string of the filter.public void CreateContext(java.lang.String filterValue)
filterValue
- Filter string valid for the context to be created.public void AttachContext(byte[] context)
context
- Context handle.public byte[] GetContext()
public void SyncContext(byte[] context)
context
- Context handle.public void ReleaseContext()
public byte[] GetSyncMark()
public void SetSyncMark(byte[] syncMark)
syncMark
- Synchronization handle.public boolean HasActiveContext(byte level)
level
- Logging level to be checked.
public void Report(java.lang.String filterValue, java.lang.String reportKey, java.lang.String description)
filterValue
- (String) The filter value will be matched to the description using the registered filter values.reportKey
- (String) A key value may be generated by the calling application to associate further descriptions
to a feedback. If empty, a new feedback report will be generated on each call.description
- (String) Textual description of the feedback entered by the user or generated by the application.public void ReportValue(java.lang.String reportKey, java.lang.String key, java.lang.String value)
reportKey
- (String) The reportkey parameter of the previously issued Report function callkey
- (String) Key of the Key/Value pairvalue
- (String) Value of the Key/Value pairpublic void ReportContent(java.lang.String reportKey, java.lang.String filename, java.lang.String mimetype, byte[] content)
reportKey
- (String) The reportkey parameter of the previously issued Report function callfilename
- (String) Filename to store the content undermimetype
- (String) MIME-Type of content (e.g.: text/plain, image/png, ...)content
- (byte []) Content value
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |