FRAPI (FusionReactor 7.0.0 Core API Specification)

java.lang.Object
- com.intergral.fusionreactor.api.FRAPI

```
public abstract class FRAPI
extends Object
```
This class defines the public interface to FusionReactor.

All API calls internally check whether FusionReactor is available before proceeding. Storing references to objects produced by this type any longer than strictly necessary (certainly not longer than the course of a single page request) is strongly discouraged, in order to reduce the scope for memory leaks. This object itself may be stored and reused if required.

This is a factory-type class; you must not instantiate it yourself, rather use the getInstance() method.

Since:

1.5 Introduction of type.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`KILL_STATUS_ALREADY_DISPOSED` Indicates this request has already been disposed of -- already completed or killed.
`static int`	`KILL_STATUS_ALREADY_NOTIFIED` Indicates this request has already been notified of a kill action by some other mechanism.
`static int`	`KILL_STATUS_KILLED` Indicates this request was killed.
`static int`	`KILL_STATUS_NOT_KILLED` Indicates Guard attempted to kill this request but could not.
`static int`	`KILL_STATUS_UNABLE` Indicates this request could not be killed because the Intergral APM Guard OSGi Service is not running, or the FusionReactor Guard Component is not available.
`static String`	`TRACE_CONTEXT_ID` Indicates the Transit context used to store FusionReactor Traces.
`static String`	`TRACE_CONTEXT_NAME` The name of the Transit property used to store traces.

Constructor Summary

Constructors
Constructor and Description

FRAPI()
The default constructor should not be called publicly.

Constructors
Constructor and Description
`FRAPI()` The default constructor should not be called publicly.

Method Summary

Methods
Modifier and Type	Method and Description
`abstract com.intergral.apm.transit.txn.TrackedTransaction`	`createTrackedTransaction(String flavor)` Creates a transaction in the APM Transit system.
`abstract com.intergral.apm.transit.txn.BaseTransaction`	`createTransaction(String flavor)` Creates a transaction in the APM Transit system.
`abstract boolean`	`deleteLog(String name)` Deletes a given logfile.
`abstract void`	`deregisterNotification(long id)` Deregister a previously-registered notification.
`abstract void`	`enableCloudMetric(String seriesId)` Enables a given metric for transfer to FusionReactor Cloud.
`abstract String`	`explainKillStatus(int killStatus)` Explain a given kill result value.
`abstract com.intergral.apm.transit.txn.BaseTransaction`	`getActiveMasterTransaction()` Get the master (root) transaction on this thread.
`abstract com.intergral.apm.transit.txn.BaseTransaction`	`getActiveTransaction()` Get the current transaction on this thread.
`abstract long`	`getAllocatedMemory()` Get the quantity of memory allocated to the JVM by the operating system.
`abstract short`	`getCpuUsage()` Get the current CPU usage.
`abstract File`	`getCurrentLogDirectory()` Get the location of the current FusionReactor log directory.
`abstract File`	`getCurrentLogFolder()` Get the location of the current FusionReactor log folder.
`abstract long`	`getDeepObjectSize(Object objectToSize)` Returns an implementation-specific approximation of the total amount of storage consumed by the specified object by summing the storage recursively of it's fields.
`abstract long`	`getFreeMemory()` Get the quantity of free memory available to the VM, including any not yet allocated.
`abstract IVersion`	`getFRVersion()` Returns an implementation of the `IVersion` interface to expose FusionReactor version information.
`static FRAPI`	`getInstance()` Get a concrete instance of the FusionReactor API, on which further calls can be made.
`abstract File`	`getLogfile(String name)` Gets a `File` object representing the named log.
`abstract int`	`getLogFileVersion()` Get a string containing the version of the log files.
`abstract long`	`getNextRotationTime()` Get the next rotation time.
`abstract long`	`getObjectSize(Object objectToSize)` Returns an implementation-specific approximation of the amount of storage consumed by the specified object.
`abstract long`	`getProbeInterval()` Gets the interval, in milliseconds, of the internal resource-gathering probes.
`abstract IFusionRequestSurrogate[]`	`getRecentRequests()` Query FusionReactor for the a list of historic WebRequests currently held by FusionReactor.
`abstract IFusionRequestSurrogate`	`getRequest(long id)` Get a request by ID.
`abstract ConfigurationSurrogate`	`getRunningConfiguration()` Return a deep clone of the currently running configuration.
`abstract IFusionRequestSurrogate[]`	`getRunningRequests()` Return an array containing objects representing all requests currently being tracked by FusionReactor.
`abstract double`	`getSeriesAverage(String seriesId)` Get the mean value of the currently-held values for the series.
`abstract double`	`getSeriesCount(String seriesId)` Get the count of values currently held for this series.
`abstract double`	`getSeriesSum(String seriesId)` Get the sum of the values currently held for this series.
`static Map`	`getSharedMap()` Non-api: clients must not call this method.
`abstract long`	`getStartedAt()` Returns the Java epoch time at which the system was started.
`abstract long`	`getStartTime()` Get the time in milliseconds since the epoch at which the server was started.
`abstract String`	`getStartTimeString()` Get the system uptime as a date/time string of the form `HH:mm:ss dd-MMM-yyyy`
`abstract long`	`getTotalMemory()` Get the quantity of memory available to the JVM, including any not yet allocated to it by the JVM.
`abstract String`	`getUemTrackingScript()` Gets a set of JavaScript that can be injected into a page to provide User Experience, Management and Tracking metrics for FusionReactor's transaction engine.
`abstract long`	`getUptime()` Get the number of milliseconds since FusionReactor was last started.
`abstract long`	`getUsedMemory()` Get the quantity of memory currently allocated by the JVM to Java objects.
`abstract String`	`getUserCookieName()` Gets the name of the cookie used for authentication.
`abstract String`	`getUserCookieValue(String role, String password)` Gets the value of the cookie used for authentication.
`abstract boolean`	`isFusionReactorRunning()` Attempt to locate FusionReactor in memory and return a boolean indicating success or failure.
`abstract boolean`	`isInitialized()` Gets a boolean indicating whether FR has started up and is ready for FRAPI requests.
`abstract boolean`	`isMemoryProtectionActive()` Get a boolean describing whether Crash Protection's Memory Protection feature is enabled.
`abstract boolean`	`isRequestProtectionActive()` Get a boolean describing whether Crash Protection's Request Protection feature is enabled.
`abstract boolean`	`isTimeoutProtectionActive()` Get a boolean describing whether Crash Protection's Timeout Protection feature is enabled.
`abstract int`	`kill(long fusionRequestId, String userTraceMarker)` Kill a running request.
`abstract void`	`log(String filename, String text)` Write an INFORMATION entry to a log file.
`abstract void`	`log(String filename, String level, String text)` Write a message to a log, with a given level.
`abstract void`	`postMetric(String seriesId, Object payload)` Post an untyped metric to Metro.
`abstract void`	`postNumericAggregateMetric(String seriesId, float value)` Post a numeric metric to metro, and create a standard set of aggregators on that series.
`abstract void`	`postNumericAggregateMetric(String seriesId, long value)` Post a numeric metric to metro, and create a standard set of aggregators on that series.
`abstract void`	`postNumericAggregateMetricFloat(String seriesId, float value)` Post a floating point value to a series.
`abstract void`	`postNumericAggregateMetricLong(String seriesId, long value)` Post an integral value to a series.
`abstract void`	`postNumericAggregateMetrics(Map<String,Number> values)` Post a collection of numeric metrics to metro, and create a standard set of aggregators on each series.
`abstract void`	`postNumericMetric(String seriesId, float value)` Post a numeric metric to metro.
`abstract void`	`postNumericMetric(String seriesId, long value)` Post a numeric metric to metro.
`abstract void`	`postNumericMetricFloat(String seriesId, float value)` Post a floating point value to a series.
`abstract void`	`postNumericMetricLong(String seriesId, long value)` Post an integral value to a series.
`abstract IProbiCallback.ICallbackRegistration`	`registerCallback(IProbiCallback callback, long period)` Register a callback for a sampler.
`abstract long`	`registerNotification(String title, String message, short severity)` Generate a notification.
`abstract long`	`registerNotification(String title, String message, short severity, String origin)` Version of `registerNotification(String, String, short)` which allows the client to set the origin string for the notification.
`abstract void`	`rotateLogs()` Requests an immediate log rotation.
`abstract boolean`	`sendOsgiEventAsync(com.intergral.fusionreactor.capi.event.IEvent event)` Sends an event into the OSGi (Plugin) subsystem.
`abstract com.intergral.fusionreactor.capi.event.IEvent`	`sendOsgiEventSync(com.intergral.fusionreactor.capi.event.IEvent event, String replyTopic, long timeout)` Sends an event into the OSGi (Plugin) framework.
`abstract void`	`setPageTimeout(int seconds)` Reset the timeout value for this page.
`abstract void`	`setRequestCaptureFolder(String fullPath)` Change the location to which Request Capture will store request and response data.
`static void`	`setSharedMap(Map map)` Non-api: clients must not call this method.
`abstract void`	`setTransactionApplicationName(String name)` Set the application name for the master transaction on this thread.
`abstract void`	`setTransactionName(String name)` Set the transaction name for the master transaction on this thread.
`abstract void`	`setVMOption(String name, String value)` Set an option on the Java Virtual Machine.
`abstract void`	`subscribeOsgiEvent(String topic, com.intergral.fusionreactor.capi.event.IEventHandler handler)` Subscribes an `IEventHandler` within the OSGi plugin subsystem.
`abstract void`	`trace(Object object)` Attach an object to this request as a trace element.
`abstract void`	`trace(String traceString)` Attach a user trace string to this request.
`abstract void`	`unsubscribeOsgiEvent(com.intergral.fusionreactor.capi.event.IEventHandler handler)` Unsubscribe a given handler from the OSGi event system.
`abstract boolean`	`wasShutdownCleanly()` Gets a boolean indicating whether FR was shutdown cleanly last time.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - KILL_STATUS_ALREADY_DISPOSED
```
public static final int KILL_STATUS_ALREADY_DISPOSED
```
    Indicates this request has already been disposed of -- already completed or killed.
    
    See Also:
    Constant Field Values
  - KILL_STATUS_ALREADY_NOTIFIED
```
public static final int KILL_STATUS_ALREADY_NOTIFIED
```
    Indicates this request has already been notified of a kill action by some other mechanism.
    
    See Also:
    Constant Field Values
  - KILL_STATUS_KILLED
```
public static final int KILL_STATUS_KILLED
```
    Indicates this request was killed.
    
    See Also:
    Constant Field Values
  - KILL_STATUS_UNABLE
```
public static final int KILL_STATUS_UNABLE
```
    Indicates this request could not be killed because the Intergral APM Guard OSGi Service is not running, or the FusionReactor Guard Component is not available.
    
    See Also:
    Constant Field Values
  - KILL_STATUS_NOT_KILLED
```
public static final int KILL_STATUS_NOT_KILLED
```
    Indicates Guard attempted to kill this request but could not. This probably indicates the thread was executing native code, which can't be killed by Java.
    
    See Also:
    Constant Field Values
  - TRACE_CONTEXT_ID
```
public static final String TRACE_CONTEXT_ID
```
    Indicates the Transit context used to store FusionReactor Traces.
    
    See Also:
    Constant Field Values
  - TRACE_CONTEXT_NAME
```
public static final String TRACE_CONTEXT_NAME
```
    The name of the Transit property used to store traces.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - FRAPI
```
public FRAPI()
```
    The default constructor should not be called publicly. Instances of this class should only be returned by getInstance().
- Method Detail
  - getInstance
```
public static final FRAPI getInstance()
```
    Get a concrete instance of the FusionReactor API, on which further calls can be made.
    
    Returns:
    a concrete FusionReactor API instance.
    Since:
    
    2.0
  - trace
```
public abstract void trace(String traceString)
```
    Attach a user trace string to this request. These strings are available within the FusionReactor GUI in the Request Details page, and also appear in the FusionReactor debug console.
    
    If FusionReactor is not running, this method does nothing.
    
    Parameters:
    traceString - The string to be attached to this request.
    Since:
    
    2.0, 5.0 Trace strings are logged to the master transaction (in most cases the web request), in the context TRACE_CONTEXT_ID.
  - trace
```
public abstract void trace(Object object)
```
    Attach an object to this request as a trace element. The semantics of this method are the same as trace(String), except that the object is attached to the request instead of a string.
    
    When FusionReactor displays the object, it will use the Object.toString() method to produce a string for display.
    
    Caution: because of the way Traces are now implemented (as Transit Contexts), the lifetime of this object cannot be easily calculated. You should therefore ensure that the object has as few efferent references as possible.
    
    Parameters:
    object - the object to be attached to this request for tracing.
    Since:
    
    5.0
  - isFusionReactorRunning
```
public abstract boolean isFusionReactorRunning()
```
    Attempt to locate FusionReactor in memory and return a boolean indicating success or failure.
    
    Returns:
    a boolean indicating whether Fusion Reactor was detected and is running.
    Since:
    
    2.0
  - setPageTimeout
```
public abstract void setPageTimeout(int seconds)
```
    Reset the timeout value for this page. If Timeout Protection is not active within FusionReactor, calls to this method have no effect. If Timeout Protection is active, the value passed to this method overrides the value configured in FusionReactor.
    
    If FusionReactor is not running, this method does nothing.
    
    Parameters:
    seconds - the timeout in seconds after which this page will be aborted.
    Since:
    
    2.0
  - getRunningRequests
```
public abstract IFusionRequestSurrogate[] getRunningRequests()
```
    Return an array containing objects representing all requests currently being tracked by FusionReactor. There is a small time penalty associated with this method, since it must temporarily lock FusionReactor to obtain the list of running requests.
    
    N.b. By the time your code uses the objects returned by this method, they may have completed.
    
    Returns:
    an array of IFusionRequestSurrogate objects representing all running tracked requests, or a zero-length array if FusionReactor was not detected.
    Since:
    
    2.0
  - getRecentRequests
```
public abstract IFusionRequestSurrogate[] getRecentRequests()
```
    Query FusionReactor for the a list of historic WebRequests currently held by FusionReactor.
    
    N.b. By the time your code uses the objects returned by this method, they may no longer be in FusionReactor.
    
    Returns:
    an array of IFusionRequestSurrogate objects representing all requests that are currently held in the FusionReactor history, or null if FusionReactor cannot be found.
    Since:
    
    5.2.4
  - getRunningConfiguration
```
public abstract ConfigurationSurrogate getRunningConfiguration()
```
    Return a deep clone of the currently running configuration. It is safe to manipulate this object.
    
    Returns:
    a ConfigurationSurrogate object constructed as a deep-clone of the running configuration, which may be manipulated safely.
    Since:
    
    2.0
  - setRequestCaptureFolder
```
public abstract void setRequestCaptureFolder(String fullPath)
                                      throws ConfigurationInvalidExceptionSurrogate,
                                             IOException
```
    Change the location to which Request Capture will store request and response data. Will cause FusionReactor to restart.
    
    Parameters:
    fullPath - a full path specifying a folder which exists on the system.
    
    Throws:
    
    ConfigurationInvalidExceptionSurrogate - with a descriptive message, if FusionReactor could not adopt the new configuration.
    
    IOException - if FusionReactor could not open write a new configuration prior to adopting it.
    Since:
    
    2.0
  - kill
```
public abstract int kill(long fusionRequestId,
       String userTraceMarker)
```
    Kill a running request.
    
    Parameters:
    fusionRequestId - the ID of the request which is to be killed.
    userTraceMarker - if non-null and not an empty string, this trace marker will be stored with the request.
    
    Returns:
    an integer corresponding to the KILL_STATUS_* set of enumeration defined in this type.
    Since:
    
    2.0
  - explainKillStatus
```
public abstract String explainKillStatus(int killStatus)
```
    Explain a given kill result value.
    
    Parameters:
    killStatus - the status to be explained.
    
    Returns:
    a concise English sentence explaining the kill status.
    Since:
    
    2.0
  - getFreeMemory
```
public abstract long getFreeMemory()
```
    Get the quantity of free memory available to the VM, including any not yet allocated. This value represents the hard upper limit, after which Java will respond to further demand with OutOfMemoryError. This value is commonly influenced using the -Xmx JVM parameter.
    
    Returns:
    a long representing the quantity of unused memory in bytes.
    Since:
    
    2.0.3
  - getTotalMemory
```
public abstract long getTotalMemory()
```
    Get the quantity of memory available to the JVM, including any not yet allocated to it by the JVM. This value is commonly influenced using the -Xmx JVM parameter.
    
    Returns:
    a long representing the total quantity of memory available to the JVM in bytes.
    Since:
    
    2.0.3
  - getUsedMemory
```
public abstract long getUsedMemory()
```
    Get the quantity of memory currently allocated by the JVM to Java objects.
    
    Returns:
    a long representing the total quantity of memory allocated to Java objects in bytes.
    Since:
    
    2.0.3
  - getAllocatedMemory
```
public abstract long getAllocatedMemory()
```
    Get the quantity of memory allocated to the JVM by the operating system. This may vary as the JVM progressively requests and releases memory.
    
    Returns:
    a long representing the quantity of allocated memory in bytes.
    Since:
    
    2.0.3
  - getCpuUsage
```
public abstract short getCpuUsage()
```
    Get the current CPU usage.
    
    Returns:
    a short describing the JVMs processor occupancy in percent, across all cores. If CPU sampling is not supported on this platform, -1 is returned.
    Since:
    
    2.0.3
  - getStartTime
```
public abstract long getStartTime()
```
    Get the time in milliseconds since the epoch at which the server was started. The epoch, for Java purposes, is defined as having its datum at midnight, January 1st 1970 UTC.
    
    Returns:
    the time at which the server was started.
    Since:
    
    2.0.3
  - getStartTimeString
```
public abstract String getStartTimeString()
```
    Get the system uptime as a date/time string of the form HH:mm:ss dd-MMM-yyyy
    
    Returns:
    a user-friendly representation of the uptime of the system.
    Since:
    
    2.0.3
  - getUptime
```
public abstract long getUptime()
```
    Get the number of milliseconds since FusionReactor was last started.
    
    Returns:
    the number of milliseconds since FusionReactor was last started.
    Since:
    
    2.0.3
  - isRequestProtectionActive
```
public abstract boolean isRequestProtectionActive()
```
    Get a boolean describing whether Crash Protection's Request Protection feature is enabled.
    
    Returns:
    a boolean describing the state of Request Protection.
    Since:
    
    3.2.0
  - isTimeoutProtectionActive
```
public abstract boolean isTimeoutProtectionActive()
```
    Get a boolean describing whether Crash Protection's Timeout Protection feature is enabled.
    
    Returns:
    a boolean describing the state of Timeout Protection.
    Since:
    
    3.2.0
  - isMemoryProtectionActive
```
public abstract boolean isMemoryProtectionActive()
```
    Get a boolean describing whether Crash Protection's Memory Protection feature is enabled.
    
    Returns:
    a boolean describing the state of Memory Protection.
    Since:
    
    3.2.0
  - getLogFileVersion
```
public abstract int getLogFileVersion()
```
    Get a string containing the version of the log files. This string is incremented when fields are added or removed.
    
    Returns:
    a String containing the version number of the log files.
    Since:
    
    3.2.0
  - getRequest
```
public abstract IFusionRequestSurrogate getRequest(long id)
```
    Get a request by ID.
    
    Parameters:
    id - the ID of the request being sought.
    
    Returns:
    a IFusionRequestSurrogate if the request could be located in the running transaction structure, or the history list. If not, or Transit is not available, null.
    Since:
    
    1.0, 5.0 The ID is interpreted to be a Transit per-flavor Transaction ID, specifically that of FusionRequest.
  - log
```
public abstract void log(String filename,
       String level,
       String text)
```
    Write a message to a log, with a given level.
    
    Parameters:
    filename - filename of the log to write to.
    level - one of INFO, WARN or SEVERE. null means a log level will not be written.
    text - text entry to write to the log.
  - log
```
public abstract void log(String filename,
       String text)
```
    Write an INFORMATION entry to a log file.
    
    Parameters:
    filename - filename of the log to write to.
    text - text entry to write to the log.
    Since:
    
    4.0
  - setVMOption
```
public abstract void setVMOption(String name,
               String value)
```
    Set an option on the Java Virtual Machine.
    
    Parameters:
    name - name of the option to set.
    value - value for the option.
    Since:
    
    4.0
  - getStartedAt
```
public abstract long getStartedAt()
```
    Returns the Java epoch time at which the system was started.
    
    Returns:
    epoch time when the system started
    Since:
    
    1.0
  - rotateLogs
```
public abstract void rotateLogs()
```
    Requests an immediate log rotation.
    
    Since:
    
    4.0
  - getProbeInterval
```
public abstract long getProbeInterval()
```
    Gets the interval, in milliseconds, of the internal resource-gathering probes.
    
    Returns:
    an interval in milliseconds.
    Since:
    
    4.0
  - getCurrentLogFolder
```
public abstract File getCurrentLogFolder()
```
    Get the location of the current FusionReactor log folder. This will change after rotation.
    
    Returns:
    a File representing the current FR log folder.
    Since:
    
    4.0
  - getCurrentLogDirectory
```
public abstract File getCurrentLogDirectory()
```
    Get the location of the current FusionReactor log directory.
    
    Returns:
    a File representing the current FR log directory.
    Since:
    
    4.0
  - getNextRotationTime
```
public abstract long getNextRotationTime()
```
    Get the next rotation time.
    
    Returns:
    a long representing the next rotation time, as measured since the Java epoch (1.1.1970), or -1 if the rotation task is not active (log engine is in legacy mode) or has stopped.
    Since:
    
    4.0
  - getUserCookieName
```
public abstract String getUserCookieName()
```
    Gets the name of the cookie used for authentication.
    
    Returns:
    a String containing the name of the cookie.
    Since:
    
    4.0
  - getUserCookieValue
```
public abstract String getUserCookieValue(String role,
                        String password)
```
    Gets the value of the cookie used for authentication.
    
    Parameters:
    role - the role for which a cookie is required, one of "Administrator", "Manager" or "Observer"
    password - the password which will be stored in the cookie
    
    Returns:
    a cookie enabling passwordless access to FusionReactor.
    Since:
    
    4.0
  - isInitialized
```
public abstract boolean isInitialized()
```
    Gets a boolean indicating whether FR has started up and is ready for FRAPI requests.
    Returns:
    a boolean indicating whether FR is initialized and ready for FRAPI.
    Since:
    4.0, 5.0 This method has been updated to check whether the three core OSGi services required by FRAPI are available:
    
    Metro, the metric-tracking, aggregation and storage engine,
    Guard, the system protection engine, and
    FusionReactor Guard Component, which provides FusionRequest 'kill' functionality to Guard.
  - wasShutdownCleanly
```
public abstract boolean wasShutdownCleanly()
```
    Gets a boolean indicating whether FR was shutdown cleanly last time.
    
    Returns:
    true if the system was shutdown cleanly, otherwise false.
    Since:
    
    4.0
  - getLogfile
```
public abstract File getLogfile(String name)
```
    Gets a File object representing the named log.
    
    Parameters:
    name - the named of the log for which a file is required
    
    Returns:
    a File representing the named log (which may not exist yet)
    Since:
    
    4.0
  - deleteLog
```
public abstract boolean deleteLog(String name)
```
    Deletes a given logfile.
    
    Parameters:
    name - the name of the log being deleted.
    
    Returns:
    true if the log was deleted, otherwise false.
    Since:
    
    4.0
  - sendOsgiEventAsync
```
public abstract boolean sendOsgiEventAsync(com.intergral.fusionreactor.capi.event.IEvent event)
```
    Sends an event into the OSGi (Plugin) subsystem. Any bundles subscribed to the topic will receive the event. After the event has been sent, this method returns.
    If no Event Admin service was available in the OSGi framework, the method returns false.
    
    Parameters:
    event - the event to be placed on the OSGi event bus.
    
    Returns:
    true if the event was sent.
    Since:
    
    4.0
  - sendOsgiEventSync
```
public abstract com.intergral.fusionreactor.capi.event.IEvent sendOsgiEventSync(com.intergral.fusionreactor.capi.event.IEvent event,
                                                              String replyTopic,
                                                              long timeout)
```
    Sends an event into the OSGi (Plugin) framework. Any bundles subscribed to the topic will receive the event. The system then waits for a reply on the event bus, with the given topic, waiting for at most timeout milliseconds.
    Any bundle may generate the reply event. If more than one reply event is sent by a bundle, the first one is used.
    Although the method is able to wait indefinitely for a reply, this is strongly discouraged since OSGi bundles can be removed and restarted with no notice.
    
    Parameters:
    event - the event to be placed on the OSGi event bus.
    replyTopic - the topic of the event to be waited for in reply
    timeout - a timeout value in milliseconds. If no reply is received after this timeout, null is returned. -1 signifies the method should wait indefinitely.
    
    Returns:
    the event generated in response.
    Since:
    
    4.0
  - subscribeOsgiEvent
```
public abstract void subscribeOsgiEvent(String topic,
                      com.intergral.fusionreactor.capi.event.IEventHandler handler)
```
    Subscribes an IEventHandler within the OSGi plugin subsystem. Whenever a topic is raised with the given passed string, the event handler is called.
    Any bundle may generate the given event. The passed topic may conform to any valid OSGi topic string, i.e. may contain a single trailing wildcard.
    If no Event Admin service was available in the OSGi framework, no events will be raised.
    
    Parameters:
    topic - the topic being subscribed to.
    handler - an IEventHandler capable of receiving events.
    Since:
    
    4.0
  - unsubscribeOsgiEvent
```
public abstract void unsubscribeOsgiEvent(com.intergral.fusionreactor.capi.event.IEventHandler handler)
```
    Unsubscribe a given handler from the OSGi event system.
    If the given handler is not actually subscribed to any events, the method returns immediately.
    
    Parameters:
    handler - the handler being unsubscribed.
    Since:
    
    4.0
  - registerNotification
```
public abstract long registerNotification(String title,
                        String message,
                        short severity)
```
    Generate a notification. This is a simplified entry point into the notifications system. These notifications are dismissible by the user using the 'remove' button.
    
    Parameters:
    title - a terse string containing the title of the notification.
    message - a more verbose string consisting of plain text, describing the notification.
    severity - 0 = INFO, 1 = WARNING, 2 = SEVERE (as defined in com.intergral.fusionreactor.notifications.INotification
    
    Returns:
    the FRAPI-tracked ID of this notification. The notification may be deregistered using this ID.
    Since:
    
    4.0.6
  - registerNotification
```
public abstract long registerNotification(String title,
                        String message,
                        short severity,
                        String origin)
```
    Version of registerNotification(String, String, short) which allows the client to set the origin string for the notification.
    
    Parameters:
    origin - a terse string containing the origin of the notification (e.g. page name or application subsystem).
    title - a terse string containing the title of the notification.
    message - a more verbose string consisting of plain text, describing the notification.
    severity - 0 = INFO, 1 = WARNING, 2 = SEVERE (as defined in com.intergral.fusionreactor.notifications.INotification
    
    Returns:
    the FRAPI-tracked ID of this notification. The notification may be deregistered using this ID.
    Since:
    
    4.0.6
  - deregisterNotification
```
public abstract void deregisterNotification(long id)
```
    Deregister a previously-registered notification.
    
    Parameters:
    id - the ID supplied as the return value of registerNotification(String, String, short)
    Since:
    
    4.0.6
  - postMetric
```
public abstract void postMetric(String seriesId,
              Object payload)
```
    Post an untyped metric to Metro.
    
    Parameters:
    seriesId - the ID of the series tracking this metric. This will be created if it does not exist.
    payload - the object to be posted.
    Since:
    
    5.0.0
  - postNumericMetric
```
public abstract void postNumericMetric(String seriesId,
                     long value)
```
    Post a numeric metric to metro.
    
    Parameters:
    seriesId - the ID of the series tracking this metric. This will be created if it does not exist. The series will not have a standard set of aggregators at 5s, 1m and 1h.
    value - the value to be tracked.
    Since:
    
    5.0.0
  - postNumericMetric
```
public abstract void postNumericMetric(String seriesId,
                     float value)
```
    Post a numeric metric to metro.
    
    Parameters:
    seriesId - the ID of the series tracking this metric. This will be created if it does not exist. The series will not have a standard set of aggregators at 5s, 1m and 1h.
    value - the value to be tracked.
    Since:
    
    5.0.0
  - postNumericMetricFloat
```
public abstract void postNumericMetricFloat(String seriesId,
                          float value)
```
    Post a floating point value to a series. This method is functionally equivalent to postNumericMetric(String, float), but is supplied here to provide an unambiguous signature for scripting languages which automatically select methods incorrectly.
    
    Parameters:
    seriesId - the ID of the series tracking this metric. This will be created if it does not exist. The series will not have a standard set of aggregators at 5s, 1m and 1h.
    value - the value to be tracked.
    Since:
    
    5.0.0
  - postNumericMetricLong
```
public abstract void postNumericMetricLong(String seriesId,
                         long value)
```
    Post an integral value to a series. This method is functionally equivalent to postNumericMetric(String, long), but is supplied here to provide an unambiguous signature for scripting languages which automatically select methods incorrectly.
    
    Parameters:
    seriesId - the ID of the series tracking this metric. This will be created if it does not exist. The series will not have a standard set of aggregators at 5s, 1m and 1h.
    value - the value to be tracked.
    Since:
    
    5.0.0
  - postNumericAggregateMetricFloat
```
public abstract void postNumericAggregateMetricFloat(String seriesId,
                                   float value)
```
    Post a floating point value to a series. This method is functionally equivalent to postNumericMetric(String, float), but is supplied here to provide an unambiguous signature for scripting languages which automatically select methods incorrectly.
    
    Parameters:
    seriesId - the ID of the series tracking this metric. This will be created if it does not exist. The series will have a standard set of aggregators at 5s, 1m and 1h.
    value - the value to be tracked.
    Since:
    
    5.0.0
  - postNumericAggregateMetricLong
```
public abstract void postNumericAggregateMetricLong(String seriesId,
                                  long value)
```
    Post an integral value to a series. This method is functionally equivalent to postNumericMetric(String, long), but is supplied here to provide an unambiguous signature for scripting languages which automatically select methods incorrectly.
    
    Parameters:
    seriesId - the ID of the series tracking this metric. This will be created if it does not exist. The series will have a standard set of aggregators at 5s, 1m and 1h.
    value - the value to be tracked.
    Since:
    
    5.0.0
  - postNumericAggregateMetric
```
public abstract void postNumericAggregateMetric(String seriesId,
                              long value)
```
    Post a numeric metric to metro, and create a standard set of aggregators on that series.
    
    Parameters:
    seriesId - the ID of the series tracking this metric. This will be created if it does not exist. The series will have a standard set of aggregators at 5s, 1m and 1h.
    value - the value to be tracked.
    Since:
    
    5.0.0
  - postNumericAggregateMetric
```
public abstract void postNumericAggregateMetric(String seriesId,
                              float value)
```
    Post a numeric metric to metro, and create a standard set of aggregators on that series.
    
    Parameters:
    seriesId - the ID of the series tracking this metric. This will be created if it does not exist. The series will have a standard set of aggregators at 5s, 1m and 1h.
    value - the value to be tracked.
    Since:
    
    5.0.0
  - postNumericAggregateMetrics
```
public abstract void postNumericAggregateMetrics(Map<String,Number> values)
```
    Post a collection of numeric metrics to metro, and create a standard set of aggregators on each series.
    
    Parameters:
    values - the collection of values to post to metro, where the key is the seriesId.
    Since:
    
    6.0.0
  - enableCloudMetric
```
public abstract void enableCloudMetric(String seriesId)
```
    Enables a given metric for transfer to FusionReactor Cloud.
    If this metric does not exist, it will be created as a numeric, aggregating metric. If this metric exists, it must be a numeric, aggregating metric.
    
    Parameters:
    seriesId - the metric to be transferred
    Since:
    
    6.0.0
  - getSeriesAverage
```
public abstract double getSeriesAverage(String seriesId)
```
    Get the mean value of the currently-held values for the series. From the entire life of the series - since it was created (for internal series this will approximate the startup time of the system).
    
    Parameters:
    seriesId - the series for which a value is required.
    
    Returns:
    the average of the values held by the series, or -1 if the series does not exist or Metro is not available.
    Since:
    
    5.0
  - getSeriesCount
```
public abstract double getSeriesCount(String seriesId)
```
    Get the count of values currently held for this series. From the entire life of the series - since it was created (for internal series this will approximate the startup time of the system).
    
    Parameters:
    seriesId - the series for which a value is required.
    
    Returns:
    the count of the values held by the series, or -1 if the series does not exist or Metro is not available.
    Since:
    
    5.0
  - getSeriesSum
```
public abstract double getSeriesSum(String seriesId)
```
    Get the sum of the values currently held for this series. From the entire life of the series - since it was created (for internal series this will approximate the startup time of the system).
    
    Parameters:
    seriesId - the series for which a value is required.
    
    Returns:
    the total sum of values held by the series, or -1 if the series does not exist or Metro is not available.
    Since:
    
    5.0
  - getUemTrackingScript
```
public abstract String getUemTrackingScript()
```
    Gets a set of JavaScript that can be injected into a page to provide User Experience, Management and Tracking metrics for FusionReactor's transaction engine.
    
    Returns:
    JavaScript code which should be placed inside script tags.
    Since:
    
    5.0.0
  - createTransaction
```
public abstract com.intergral.apm.transit.txn.BaseTransaction createTransaction(String flavor)
                                                                         throws com.intergral.apm.transit.api.gate.GateException,
                                                                                IllegalArgumentException
```
    Creates a transaction in the APM Transit system. This is a convenience method, and calls new BaseTransaction( flavor ). The transaction flavor will not be tracked in Metro.
    The thrown exception must be handled as Exception, since the GateException hierarchy is not yet exposed in FRAPI.
    
    Parameters:
    flavor - the type of transaction required.
    
    Returns:
    a BaseTransaction with the given flavor.
    
    Throws:
    
    com.intergral.apm.transit.api.gate.GateTimeoutException - if the transaction timed out while traversing Transit input gates.
    
    com.intergral.apm.transit.api.gate.GateRejectionException - if the transaction was rejected immediately by any Transit input gate.
    
    com.intergral.apm.transit.api.gate.GateException - if the transaction couldn't be created due to a Transit transaction gate refusing the request.
    
    IllegalArgumentException - if the provided flavor is null or an empty string
    Since:
    
    5.0.0
  - createTrackedTransaction
```
public abstract com.intergral.apm.transit.txn.TrackedTransaction createTrackedTransaction(String flavor)
                                                                                   throws com.intergral.apm.transit.api.gate.GateException,
                                                                                          IllegalArgumentException
```
    Creates a transaction in the APM Transit system. This is a convenience method, and calls new BaseTransaction( flavor ). The transaction flavor will be tracked in Metro.
    The thrown exception must be handled as Exception, since the GateException hierarchy is not yet exposed in FRAPI.
    
    Parameters:
    flavor - the type of transaction required.
    
    Returns:
    a BaseTransaction with the given flavor.
    
    Throws:
    
    com.intergral.apm.transit.api.gate.GateTimeoutException - if the transaction timed out while traversing Transit input gates.
    
    com.intergral.apm.transit.api.gate.GateRejectionException - if the transaction was rejected immediately by any Transit input gate.
    
    com.intergral.apm.transit.api.gate.GateException - if the transaction couldn't be created due to a Transit transaction gate refusing the request.
    
    IllegalArgumentException - if the provided flavor is null or an empty string
    Since:
    
    5.0.0
  - getActiveTransaction
```
public abstract com.intergral.apm.transit.txn.BaseTransaction getActiveTransaction()
```
    Get the current transaction on this thread.
    
    Returns:
    the current BaseTransaction on this thread or null if no transaction is active, for instance if the page is exempt from FusionReactor tracking by restrictions.
    Since:
    
    5.2.4
  - getActiveMasterTransaction
```
public abstract com.intergral.apm.transit.txn.BaseTransaction getActiveMasterTransaction()
```
    Get the master (root) transaction on this thread.
    
    Returns:
    the master BaseTransaction on this thread or null if no transaction is active.
    Since:
    
    5.2.4
  - setTransactionName
```
public abstract void setTransactionName(String name)
                                 throws IllegalStateException,
                                        IllegalArgumentException
```
    Set the transaction name for the master transaction on this thread.
    
    Parameters:
    name - name of the transaction
    
    Throws:
    
    IllegalStateException - if no transaction is active on this thread
    
    IllegalArgumentException - if name is null or is an empty string
    Since:
    
    6.0.0
  - setTransactionApplicationName
```
public abstract void setTransactionApplicationName(String name)
                                            throws IllegalStateException,
                                                   IllegalArgumentException
```
    Set the application name for the master transaction on this thread.
    
    Parameters:
    name - name of the application
    
    Throws:
    
    IllegalStateException - if no transaction is active on this thread
    
    IllegalArgumentException - if name is null or is an empty string
    Since:
    
    6.0.0
  - getObjectSize
```
public abstract long getObjectSize(Object objectToSize)
                            throws IllegalStateException
```
    Returns an implementation-specific approximation of the amount of storage consumed by the specified object. The result may include some or all of the object's overhead, and thus is useful for comparison within an implementation but not between implementations. The estimate may change during a single invocation of the JVM. Returns 0 if the supplied object is null.
    
    Parameters:
    objectToSize - the object to size
    
    Returns:
    an implementation-specific approximation of the amount of storage consumed by the specified object
    
    Throws:
    
    IllegalStateException - if Java Instrumentation is not available
    Since:
    
    5.1.0
  - getDeepObjectSize
```
public abstract long getDeepObjectSize(Object objectToSize)
                                throws IllegalStateException
```
    Returns an implementation-specific approximation of the total amount of storage consumed by the specified object by summing the storage recursively of it's fields. Objects encountered in fields are not summed twice. The result may include some or all of the object's overhead, and thus is useful for comparison within an implementation but not between implementations. The estimate may change during a single invocation of the JVM.
    
    Parameters:
    objectToSize - the object to size
    
    Returns:
    an implementation-specific approximation of the total amount of storage consumed by the specified object including recursive field storage. Returns 0 if the supplied object is null.
    
    Throws:
    
    IllegalStateException - if Java Instrumentation is not available
    
    RuntimeException - if a field on an object cannot be accessed
    Since:
    
    5.1.0
  - getFRVersion
```
public abstract IVersion getFRVersion()
```
    Returns an implementation of the IVersion interface to expose FusionReactor version information.
    
    Returns:
    an implementation of the IVersion interface. Will return null if a instance of IVersion cannot be found.
    Since:
    
    6.0.0
  - registerCallback
```
public abstract IProbiCallback.ICallbackRegistration registerCallback(IProbiCallback callback,
                                                    long period)
```
    Register a callback for a sampler.
    
    Parameters:
    callback - the call back implementation you want to use.
    period - the period in milliseconds between calls. Minimum period of 1000 milliseconds. The stated period is not guaranteed to be accurate, and will be adjusted to the nearest second during calls. Any value that is not a multiple of 1000 will be rounded up to the next second.
    
    Returns:
    the registration for this call back
  - setSharedMap
```
public static void setSharedMap(Map map)
```
    Non-api: clients must not call this method.
    
    Parameters:
    map - the map that will be set as a shared map
  - getSharedMap
```
public static Map getSharedMap()
```
    Non-api: clients must not call this method.
    
    Returns:
    a Map representing the shared map

Class FRAPI

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

KILL_STATUS_ALREADY_DISPOSED

KILL_STATUS_ALREADY_NOTIFIED

KILL_STATUS_KILLED

KILL_STATUS_UNABLE

KILL_STATUS_NOT_KILLED

TRACE_CONTEXT_ID

TRACE_CONTEXT_NAME

Constructor Detail

FRAPI

Method Detail

getInstance

trace

trace

isFusionReactorRunning

setPageTimeout

getRunningRequests

getRecentRequests

getRunningConfiguration

setRequestCaptureFolder

kill

explainKillStatus

getFreeMemory

getTotalMemory

getUsedMemory

getAllocatedMemory

getCpuUsage

getStartTime

getStartTimeString

getUptime

isRequestProtectionActive

isTimeoutProtectionActive

isMemoryProtectionActive

getLogFileVersion

getRequest

log

log

setVMOption

getStartedAt

rotateLogs

getProbeInterval

getCurrentLogFolder

getCurrentLogDirectory

getNextRotationTime

getUserCookieName

getUserCookieValue

isInitialized

wasShutdownCleanly

getLogfile

deleteLog

sendOsgiEventAsync

sendOsgiEventSync

subscribeOsgiEvent

unsubscribeOsgiEvent

registerNotification

registerNotification

deregisterNotification

postMetric

postNumericMetric

postNumericMetric

postNumericMetricFloat

postNumericMetricLong

postNumericAggregateMetricFloat

postNumericAggregateMetricLong

postNumericAggregateMetric

postNumericAggregateMetric

postNumericAggregateMetrics

enableCloudMetric

getSeriesAverage

getSeriesCount

getSeriesSum

getUemTrackingScript

createTransaction

createTrackedTransaction

getActiveTransaction