Class ElasticBeanstalkPlugin

java.lang.Object
com.amazonaws.xray.plugins.ElasticBeanstalkPlugin
All Implemented Interfaces:
Plugin

public class ElasticBeanstalkPlugin
extends java.lang.Object
implements Plugin
A plugin, for use with the AWSXRayRecorderBuilder class, which will add Elastic Beanstalk environment information to segments generated by the built AWSXRayRecorder instance.
See Also:
AWSXRayRecorderBuilder.withPlugin(Plugin)
  • Field Summary

    Fields 
    Modifier and Type Field Description
    static java.lang.String ORIGIN  
  • Constructor Summary

    Constructors 
    Constructor Description
    ElasticBeanstalkPlugin()  
  • Method Summary

    Modifier and Type Method Description
    boolean equals​(@Nullable java.lang.Object o)
    Determine equality of plugins using origin to uniquely identify them
    java.lang.String getOrigin()
    Returns the name of the origin associated with this plugin.
    java.util.Map<java.lang.String,​@Nullable java.lang.Object> getRuntimeContext()  
    java.lang.String getServiceName()  
    int hashCode()
    Hash plugin object using origin to uniquely identify them
    boolean isEnabled()  
    void populateRuntimeContext()  

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface com.amazonaws.xray.plugins.Plugin

    getLogReferences
  • Field Details

  • Constructor Details

  • Method Details

    • getServiceName

      public java.lang.String getServiceName()
      Specified by:
      getServiceName in interface Plugin
    • isEnabled

      public boolean isEnabled()
      Specified by:
      isEnabled in interface Plugin
      Returns:
      true if an environment inspection determines X-Ray is operating in the correct environment for this plugin OR if X-Ray cannot accurately determine if it's in this plugin's environment
    • populateRuntimeContext

      public void populateRuntimeContext()
    • getRuntimeContext

      public java.util.Map<java.lang.String,​@Nullable java.lang.Object> getRuntimeContext()
      Specified by:
      getRuntimeContext in interface Plugin
    • getOrigin

      public java.lang.String getOrigin()
      Description copied from interface: Plugin
      Returns the name of the origin associated with this plugin. The AWSXRayRecorder contains a prioritized list of origins from least to most specific.
      Specified by:
      getOrigin in interface Plugin
      Returns:
      the name of the origin associated with this plugin.
    • equals

      public boolean equals​(@Nullable java.lang.Object o)
      Determine equality of plugins using origin to uniquely identify them
      Overrides:
      equals in class java.lang.Object
    • hashCode

      public int hashCode()
      Hash plugin object using origin to uniquely identify them
      Overrides:
      hashCode in class java.lang.Object