Package com.amazonaws.xray.entities

Class DummySegment

java.lang.Object
com.amazonaws.xray.entities.DummySegment
All Implemented Interfaces:
Entity, Segment, AutoCloseable
@Deprecated public class DummySegment extends Object implements Segment
Deprecated.
Use Segment.noOp(TraceID, AWSXRayRecorder).

  • Constructor Details

  • Method Details

    • getName

      public String getName()
      Deprecated.
      Specified by:
      getName in interface Entity

    • getId

      public String getId()
      Deprecated.
      Specified by:
      getId in interface Entity
      Returns:
      the id

    • setId

      public void setId(String id)
      Deprecated.
      Specified by:
      setId in interface Entity
      Parameters:
      id - the id to set

    • getStartTime

      public double getStartTime()
      Deprecated.
      Specified by:
      getStartTime in interface Entity
      Returns:
      the startTime

    • setStartTime

      public void setStartTime(double startTime)
      Deprecated.
      Specified by:
      setStartTime in interface Entity
      Parameters:
      startTime - the startTime to set

    • getEndTime

      public double getEndTime()
      Deprecated.
      Specified by:
      getEndTime in interface Entity
      Returns:
      the endTime

    • setEndTime

      public void setEndTime(double endTime)
      Deprecated.
      Specified by:
      setEndTime in interface Entity
      Parameters:
      endTime - the endTime to set

    • isFault

      public boolean isFault()
      Deprecated.
      Specified by:
      isFault in interface Entity
      Returns:
      the fault

    • setFault

      public void setFault(boolean fault)
      Deprecated.
      Specified by:
      setFault in interface Entity
      Parameters:
      fault - the fault to set

    • isError

      public boolean isError()
      Deprecated.
      Specified by:
      isError in interface Entity
      Returns:
      the error

    • setError

      public void setError(boolean error)
      Deprecated.
      Description copied from interface: Entity
      Sets the error value of the entity.
      Specified by:
      setError in interface Entity
      Parameters:
      error - the error to set

    • getNamespace

      public String getNamespace()
      Deprecated.
      Specified by:
      getNamespace in interface Entity
      Returns:
      the namespace

    • setNamespace

      public void setNamespace(String namespace)
      Deprecated.
      Specified by:
      setNamespace in interface Entity
      Parameters:
      namespace - the namespace to set

    • getCause

      public Cause getCause()
      Deprecated.
      Specified by:
      getCause in interface Entity
      Returns:
      the cause

    • getHttp

      public Map<String,Object> getHttp()
      Deprecated.
      Specified by:
      getHttp in interface Entity
      Returns:
      the http

    • setHttp

      public void setHttp(Map<String,Object> http)
      Deprecated.
      Specified by:
      setHttp in interface Entity
      Parameters:
      http - the http to set

    • getAws

      public Map<String,Object> getAws()
      Deprecated.
      Specified by:
      getAws in interface Entity
      Returns:
      the aws

    • setAws

      public void setAws(Map<String,Object> aws)
      Deprecated.
      Specified by:
      setAws in interface Entity
      Parameters:
      aws - the aws to set

    • getSql

      public Map<String,Object> getSql()
      Deprecated.
      Specified by:
      getSql in interface Entity
      Returns:
      the sql

    • setSql

      public void setSql(Map<String,Object> sql)
      Deprecated.
      Specified by:
      setSql in interface Entity
      Parameters:
      sql - the sql to set

    • getMetadata

      public Map<String,Map<String,Object>> getMetadata()
      Deprecated.
      Specified by:
      getMetadata in interface Entity
      Returns:
      the metadata

    • setMetadata

      public void setMetadata(Map<String,Map<String,Object>> metadata)
      Deprecated.
      Specified by:
      setMetadata in interface Entity
      Parameters:
      metadata - the metadata to set

    • setAnnotations

      public void setAnnotations(Map<String,Object> annotations)
      Deprecated.
      Specified by:
      setAnnotations in interface Entity
      Parameters:
      annotations - the annotations to set

    • getParent

      public Entity getParent()
      Deprecated.
      Specified by:
      getParent in interface Entity
      Returns:
      the parent

    • setParent

      public void setParent(Entity parent)
      Deprecated.
      Specified by:
      setParent in interface Entity
      Parameters:
      parent - the parent to set

    • isThrottle

      public boolean isThrottle()
      Deprecated.
      Specified by:
      isThrottle in interface Entity
      Returns:
      the throttle

    • setThrottle

      public void setThrottle(boolean throttle)
      Deprecated.
      Description copied from interface: Entity
      Sets the throttle value. When setting to true, error is also set to true and fault set to false.
      Specified by:
      setThrottle in interface Entity
      Parameters:
      throttle - the throttle to set

    • isInProgress

      public boolean isInProgress()
      Deprecated.
      Specified by:
      isInProgress in interface Entity
      Returns:
      the inProgress

    • setInProgress

      public void setInProgress(boolean inProgress)
      Deprecated.
      Specified by:
      setInProgress in interface Entity
      Parameters:
      inProgress - the inProgress to set

    • getTraceId

      public TraceID getTraceId()
      Deprecated.
      Specified by:
      getTraceId in interface Entity
      Returns:
      the traceId

    • setTraceId

      public void setTraceId(TraceID traceId)
      Deprecated.
      Specified by:
      setTraceId in interface Entity
      Parameters:
      traceId - the traceId to set

    • getCreator

      public AWSXRayRecorder getCreator()
      Deprecated.
      Specified by:
      getCreator in interface Entity
      Returns:
      the creator

    • setCreator

      public void setCreator(AWSXRayRecorder creator)
      Deprecated.
      Specified by:
      setCreator in interface Entity
      Parameters:
      creator - the creator to set

    • getParentId

      public String getParentId()
      Deprecated.
      Specified by:
      getParentId in interface Entity
      Returns:
      the parentId

    • setParentId

      public void setParentId(@Nullable String parentId)
      Deprecated.
      Specified by:
      setParentId in interface Entity
      Parameters:
      parentId - the parentId to set

    • getSubsegments

      public List<Subsegment> getSubsegments()
      Deprecated.
      Specified by:
      getSubsegments in interface Entity
      Returns:
      the subsegments

    • getSubsegmentsCopy

      public List<Subsegment> getSubsegmentsCopy()
      Deprecated.
      Description copied from interface: Entity
      Returns a copy of the currently added subsegments. Updates to the returned List will not be reflected in the Entity.
      Specified by:
      getSubsegmentsCopy in interface Entity

    • addSubsegment

      public void addSubsegment(Subsegment subsegment)
      Deprecated.
      Description copied from interface: Entity
      Adds a subsegment.
      Specified by:
      addSubsegment in interface Entity
      Parameters:
      subsegment - the subsegment to add

    • addException

      public void addException(Throwable exception)
      Deprecated.
      Description copied from interface: Entity
      Adds an exception to the entity's cause and sets fault to true.
      Specified by:
      addException in interface Entity
      Parameters:
      exception - the exception to add

    • putHttp

      public void putHttp(String key, Object value)
      Deprecated.
      Description copied from interface: Entity
      Puts HTTP information.
      Specified by:
      putHttp in interface Entity
      Parameters:
      key - the key under which the HTTP information is stored
      value - the HTTP information

    • putAllHttp

      public void putAllHttp(Map<String,Object> all)
      Deprecated.
      Description copied from interface: Entity
      Puts HTTP information.
      Specified by:
      putAllHttp in interface Entity
      Parameters:
      all - the HTTP information to put

    • putAws

      public void putAws(String key, Object value)
      Deprecated.
      Description copied from interface: Entity
      Puts AWS information.
      Specified by:
      putAws in interface Entity
      Parameters:
      key - the key under which the AWS information is stored
      value - the AWS information

    • putAllAws

      public void putAllAws(Map<String,Object> all)
      Deprecated.
      Description copied from interface: Entity
      Puts AWS information.
      Specified by:
      putAllAws in interface Entity
      Parameters:
      all - the AWS information to put

    • putSql

      public void putSql(String key, Object value)
      Deprecated.
      Description copied from interface: Entity
      Puts SQL information.
      Specified by:
      putSql in interface Entity
      Parameters:
      key - the key under which the SQL information is stored
      value - the SQL information

    • putAllSql

      public void putAllSql(Map<String,Object> all)
      Deprecated.
      Description copied from interface: Entity
      Puts SQL information.
      Specified by:
      putAllSql in interface Entity
      Parameters:
      all - the SQL information to put

    • putAnnotation

      public void putAnnotation(String key, String value)
      Deprecated.
      Description copied from interface: Entity
      Puts a String annotation.
      Specified by:
      putAnnotation in interface Entity
      Parameters:
      key - the key under which the annotation is stored
      value - the String annotation

    • putAnnotation

      public void putAnnotation(String key, Number value)
      Deprecated.
      Description copied from interface: Entity
      Puts a Number annotation.
      Specified by:
      putAnnotation in interface Entity
      Parameters:
      key - the key under which the annotation is stored
      value - the Number annotation

    • putAnnotation

      public void putAnnotation(String key, Boolean value)
      Deprecated.
      Description copied from interface: Entity
      Puts a Boolean annotation.
      Specified by:
      putAnnotation in interface Entity
      Parameters:
      key - the key under which the annotation is stored
      value - the Boolean annotation

    • putMetadata

      public void putMetadata(String key, Object object)
      Deprecated.
      Description copied from interface: Entity
      Puts metadata under the namespace 'default'.
      Specified by:
      putMetadata in interface Entity
      Parameters:
      key - the key under which the metadata is stored
      object - the metadata

    • putMetadata

      public void putMetadata(String namespace, String key, Object object)
      Deprecated.
      Description copied from interface: Entity
      Puts metadata.
      Specified by:
      putMetadata in interface Entity
      Parameters:
      namespace - the namespace under which the metadata is stored
      key - the key under which the metadata is stored
      object - the metadata

    • isEmitted

      public boolean isEmitted()
      Deprecated.
      Specified by:
      isEmitted in interface Entity

    • setEmitted

      public void setEmitted(boolean emitted)
      Deprecated.
      Description copied from interface: Entity
      Sets emitted on the entity.
      Specified by:
      setEmitted in interface Entity

    • compareAndSetEmitted

      public boolean compareAndSetEmitted(boolean current, boolean next)
      Deprecated.
      Description copied from interface: Entity
      Checks whether this Entity currently has emitted state of current and if so, set emitted state to next. Returns true if the state was updated, or false otherwise.
      Specified by:
      compareAndSetEmitted in interface Entity

    • serialize

      public String serialize()
      Deprecated.
      Specified by:
      serialize in interface Entity

    • prettySerialize

      public String prettySerialize()
      Deprecated.
      Specified by:
      prettySerialize in interface Entity

    • end

      public boolean end()
      Deprecated.
      Description copied from interface: Segment
      Ends the segment. Sets the end time to the current time. Sets inProgress to false.
      Specified by:
      end in interface Segment
      Returns:
      true if 1) the reference count is less than or equal to zero and 2) sampled is true

    • isRecording

      public boolean isRecording()
      Deprecated.
      Description copied from interface: Segment
      Returns if this Segment is recording events and will be emitted. Any operations on a Segment which is not recording are effectively no-op.
      Specified by:
      isRecording in interface Segment

    • putService

      public void putService(String key, Object object)
      Deprecated.
      Description copied from interface: Segment
      Puts information about this service.
      Specified by:
      putService in interface Segment
      Parameters:
      key - the key under which the service information is stored
      object - the service information

    • isSampled

      public boolean isSampled()
      Deprecated.
      Specified by:
      isSampled in interface Entity

    • setSampled

      public void setSampled(boolean sampled)
      Deprecated.
      Specified by:
      setSampled in interface Segment
      Parameters:
      sampled - the sampled to set

    • getReferenceCount

      public int getReferenceCount()
      Deprecated.
      Description copied from interface: Entity
      Returns the reference count of the segment. This number represents how many open subsegments are children of this segment. The segment is emitted when its reference count reaches 0.
      Specified by:
      getReferenceCount in interface Entity
      Returns:
      the reference count

    • getTotalSize

      public LongAdder getTotalSize()
      Deprecated.
      Specified by:
      getTotalSize in interface Entity
      Returns:
      the totalSize

    • incrementReferenceCount

      public void incrementReferenceCount()
      Deprecated.
      Description copied from interface: Entity
      Increments the subsegment-reference counter.
      Specified by:
      incrementReferenceCount in interface Entity

    • decrementReferenceCount

      public boolean decrementReferenceCount()
      Deprecated.
      Description copied from interface: Entity
      Decrements the subsegment-reference counter.
      Specified by:
      decrementReferenceCount in interface Entity
      Returns:
      true if the segment is no longer in progress and the reference count is less than or equal to zero.

    • getResourceArn

      public String getResourceArn()
      Deprecated.
      Specified by:
      getResourceArn in interface Segment
      Returns:
      the resourceArn

    • setResourceArn

      public void setResourceArn(String resourceArn)
      Deprecated.
      Specified by:
      setResourceArn in interface Segment
      Parameters:
      resourceArn - the resourceArn to set

    • getUser

      public String getUser()
      Deprecated.
      Specified by:
      getUser in interface Segment
      Returns:
      the user

    • setUser

      public void setUser(String user)
      Deprecated.
      Specified by:
      setUser in interface Segment
      Parameters:
      user - the user to set

    • getOrigin

      public String getOrigin()
      Deprecated.
      Specified by:
      getOrigin in interface Segment
      Returns:
      the origin

    • setOrigin

      public void setOrigin(String origin)
      Deprecated.
      Specified by:
      setOrigin in interface Segment
      Parameters:
      origin - the origin to set

    • getService

      public Map<String,Object> getService()
      Deprecated.
      Specified by:
      getService in interface Segment
      Returns:
      the service

    • getAnnotations

      public Map<String,Object> getAnnotations()
      Deprecated.
      Specified by:
      getAnnotations in interface Entity
      Specified by:
      getAnnotations in interface Segment
      Returns:
      the annotations

    • getParentSegment

      public Segment getParentSegment()
      Deprecated.
      Specified by:
      getParentSegment in interface Entity
      Specified by:
      getParentSegment in interface Segment

    • close

      public void close()
      Deprecated.
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Segment

    • getSubsegmentsLock

      public ReentrantLock getSubsegmentsLock()
      Deprecated.
      Specified by:
      getSubsegmentsLock in interface Entity
      Returns:
      the subsegmentsLock

    • setSubsegmentsLock

      public void setSubsegmentsLock(ReentrantLock subsegmentsLock)
      Deprecated.
      Specified by:
      setSubsegmentsLock in interface Entity
      Parameters:
      subsegmentsLock - the subsegmentsLock to set

    • putAllService

      public void putAllService(Map<String,Object> all)
      Deprecated.
      Description copied from interface: Segment
      Puts information about this service.
      Specified by:
      putAllService in interface Segment
      Parameters:
      all - the service information to set.

    • setService

      public void setService(Map<String,Object> service)
      Deprecated.
      Specified by:
      setService in interface Segment
      Parameters:
      service - the service to set

    • removeSubsegment

      public void removeSubsegment(Subsegment subsegment)
      Deprecated.
      Description copied from interface: Entity
      Removes a subsegment from the subsegment list. Decrements the total size of the parentSegment. Marks the removed subsegment as emitted future modification on this subsegment may raise an AlreadyEmittedException.
      Specified by:
      removeSubsegment in interface Entity
      Parameters:
      subsegment - the subsegment to remove

    • setRuleName

      public void setRuleName(String name)
      Deprecated.
      Specified by:
      setRuleName in interface Segment