Class NoOpPrivateApi

  • All Implemented Interfaces:
    PrivateApi

    public class NoOpPrivateApi
    extends java.lang.Object
    implements PrivateApi
    • Constructor Summary

      Constructors 
      Constructor Description
      NoOpPrivateApi()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addCustomAttribute​(java.lang.String key, java.lang.Number value)
      Add a key/value pair to the current transaction.
      void addCustomAttribute​(java.lang.String key, java.lang.String value)
      Add a key/value pair to the current transaction.
      void addCustomAttribute​(java.lang.String key, java.util.Map<java.lang.String,​java.lang.String> values)
      Add a key with a map of values to the current transaction.
      void addMBeanServer​(javax.management.MBeanServer server)
      Call if you want to pull JMX metrics from this server instead of the default MBeanServers.
      java.io.Closeable addSampler​(java.lang.Runnable sampler, int period, java.util.concurrent.TimeUnit minutes)
      Adds a sampler to be called at a given frequency.
      void addTracerParameter​(java.lang.String key, java.lang.Number value)  
      void addTracerParameter​(java.lang.String key, java.lang.String value)  
      void addTracerParameter​(java.lang.String key, java.lang.String value, boolean addToSpan)  
      void addTracerParameter​(java.lang.String key, java.util.Map<java.lang.String,​java.lang.String> values)  
      void removeMBeanServer​(javax.management.MBeanServer serverToRemove)
      Call if you want to remove a particular MBeanServer.
      void reportException​(java.lang.Throwable throwable)
      Report an exception.
      void reportHTTPError​(java.lang.String message, int statusCode, java.lang.String uri)
      Report an HTTP error
      void setAppServerPort​(int port)
      Set the app server port which is reported to RPM.
      void setInstanceName​(java.lang.String instanceName)
      Set the instance name in the environment.
      void setServerInfo​(java.lang.String serverInfo)  
      void setServerInfo​(java.lang.String dispatcherName, java.lang.String version)
      Set the dispatcher name and version which is reported to RPM.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • NoOpPrivateApi

        public NoOpPrivateApi()
    • Method Detail

      • addSampler

        public java.io.Closeable addSampler​(java.lang.Runnable sampler,
                                            int period,
                                            java.util.concurrent.TimeUnit minutes)
        Description copied from interface: PrivateApi
        Adds a sampler to be called at a given frequency.
        Specified by:
        addSampler in interface PrivateApi
        Returns:
        a Closeable which when executed will cancel the sampler execution.
      • setServerInfo

        public void setServerInfo​(java.lang.String serverInfo)
        Specified by:
        setServerInfo in interface PrivateApi
      • addCustomAttribute

        public void addCustomAttribute​(java.lang.String key,
                                       java.lang.Number value)
        Description copied from interface: PrivateApi
        Add a key/value pair to the current transaction. These are reported in errors and transaction traces. This will add the parameter even if high_security is set. Use with caution.
        Specified by:
        addCustomAttribute in interface PrivateApi
        Parameters:
        key - Custom parameter key.
        value - Custom parameter value. @
      • addCustomAttribute

        public void addCustomAttribute​(java.lang.String key,
                                       java.lang.String value)
        Description copied from interface: PrivateApi
        Add a key/value pair to the current transaction. These are reported in errors and transaction traces. This will add the parameter even if high_security is set. Use with caution.
        Specified by:
        addCustomAttribute in interface PrivateApi
        Parameters:
        key - Custom parameter key.
        value - Custom parameter value. @
      • addCustomAttribute

        public void addCustomAttribute​(java.lang.String key,
                                       java.util.Map<java.lang.String,​java.lang.String> values)
        Description copied from interface: PrivateApi
        Add a key with a map of values to the current transaction. These are reported in errors and transaction traces. This will add the parameter even if high_security is set. Use with caution.
        Specified by:
        addCustomAttribute in interface PrivateApi
        Parameters:
        key - Custom parameter key.
        values - Custom parameter values. @
      • addMBeanServer

        public void addMBeanServer​(javax.management.MBeanServer server)
        Description copied from interface: PrivateApi
        Call if you want to pull JMX metrics from this server instead of the default MBeanServers.
        Specified by:
        addMBeanServer in interface PrivateApi
        Parameters:
        server - The server to use for pulling MBeans.
      • removeMBeanServer

        public void removeMBeanServer​(javax.management.MBeanServer serverToRemove)
        Description copied from interface: PrivateApi
        Call if you want to remove a particular MBeanServer.
        Specified by:
        removeMBeanServer in interface PrivateApi
        Parameters:
        serverToRemove - The desired server to remove from the JMXService.
      • addTracerParameter

        public void addTracerParameter​(java.lang.String key,
                                       java.lang.Number value)
        Specified by:
        addTracerParameter in interface PrivateApi
      • reportHTTPError

        public void reportHTTPError​(java.lang.String message,
                                    int statusCode,
                                    java.lang.String uri)
        Description copied from interface: PrivateApi
        Report an HTTP error
        Specified by:
        reportHTTPError in interface PrivateApi
        Parameters:
        message - Error message
        statusCode - HTTP status code
        uri - Request URI
      • reportException

        public void reportException​(java.lang.Throwable throwable)
        Description copied from interface: PrivateApi
        Report an exception. Checks if throwable should be ignored before reporting it.
        Specified by:
        reportException in interface PrivateApi
      • setAppServerPort

        public void setAppServerPort​(int port)
        Description copied from interface: PrivateApi
        Set the app server port which is reported to RPM.
        Specified by:
        setAppServerPort in interface PrivateApi
      • setServerInfo

        public void setServerInfo​(java.lang.String dispatcherName,
                                  java.lang.String version)
        Description copied from interface: PrivateApi
        Set the dispatcher name and version which is reported to RPM.
        Specified by:
        setServerInfo in interface PrivateApi
      • setInstanceName

        public void setInstanceName​(java.lang.String instanceName)
        Description copied from interface: PrivateApi
        Set the instance name in the environment. A single host:port may support multiple JVM instances. The instance name is intended to help the customer identify the specific JVM instance.
        Specified by:
        setInstanceName in interface PrivateApi
      • addTracerParameter

        public void addTracerParameter​(java.lang.String key,
                                       java.lang.String value)
        Specified by:
        addTracerParameter in interface PrivateApi
      • addTracerParameter

        public void addTracerParameter​(java.lang.String key,
                                       java.lang.String value,
                                       boolean addToSpan)
        Specified by:
        addTracerParameter in interface PrivateApi
      • addTracerParameter

        public void addTracerParameter​(java.lang.String key,
                                       java.util.Map<java.lang.String,​java.lang.String> values)
        Specified by:
        addTracerParameter in interface PrivateApi