Package com.amazonaws.xray.entities

Class DummySegment

java.lang.Object

com.amazonaws.xray.entities.DummySegment

All Implemented Interfaces:

Entity, Segment, java.lang.AutoCloseable

@Deprecated
public class DummySegment
extends java.lang.Object
implements Segment

Deprecated.

Use Segment.noOp(TraceID, AWSXRayRecorder).

Constructor Summary

Constructors

Constructor	Description
DummySegment(AWSXRayRecorder creator)	Deprecated.
DummySegment(AWSXRayRecorder creator, TraceID traceId)	Deprecated.
DummySegment(AWSXRayRecorder creator, java.lang.String name, TraceID traceId)	Deprecated.

Method Summary

Modifier and Type	Method	Description
void	addException(java.lang.Throwable exception)	Deprecated. Adds an exception to the entity's cause and sets fault to true.
void	addSubsegment(Subsegment subsegment)	Deprecated. Adds a subsegment.
void	close()	Deprecated.
boolean	compareAndSetEmitted(boolean current, boolean next)	Deprecated. Checks whether this Entity currently has emitted state of current and if so, set emitted state to next.
boolean	decrementReferenceCount()	Deprecated. Decrements the subsegment-reference counter.
boolean	end()	Deprecated. Ends the segment.
java.util.Map<java.lang.String,java.lang.Object>	getAnnotations()	Deprecated.
java.util.Map<java.lang.String,java.lang.Object>	getAws()	Deprecated.
Cause	getCause()	Deprecated.
AWSXRayRecorder	getCreator()	Deprecated.
double	getEndTime()	Deprecated.
java.util.Map<java.lang.String,java.lang.Object>	getHttp()	Deprecated.
java.lang.String	getId()	Deprecated.
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>>	getMetadata()	Deprecated.
java.lang.String	getName()	Deprecated.
java.lang.String	getNamespace()	Deprecated.
java.lang.String	getOrigin()	Deprecated.
Entity	getParent()	Deprecated.
java.lang.String	getParentId()	Deprecated.
Segment	getParentSegment()	Deprecated.
int	getReferenceCount()	Deprecated. Returns the reference count of the segment.
java.lang.String	getResourceArn()	Deprecated.
java.util.Map<java.lang.String,java.lang.Object>	getService()	Deprecated.
java.util.Map<java.lang.String,java.lang.Object>	getSql()	Deprecated.
double	getStartTime()	Deprecated.
java.util.List<Subsegment>	getSubsegments()	Deprecated.
java.util.List<Subsegment>	getSubsegmentsCopy()	Deprecated. Returns a copy of the currently added subsegments.
java.util.concurrent.locks.ReentrantLock	getSubsegmentsLock()	Deprecated.
java.util.concurrent.atomic.LongAdder	getTotalSize()	Deprecated.
TraceID	getTraceId()	Deprecated.
java.lang.String	getUser()	Deprecated.
void	incrementReferenceCount()	Deprecated. Increments the subsegment-reference counter.
boolean	isEmitted()	Deprecated.
boolean	isError()	Deprecated.
boolean	isFault()	Deprecated.
boolean	isInProgress()	Deprecated.
boolean	isRecording()	Deprecated. Returns if this Segment is recording events and will be emitted.
boolean	isSampled()	Deprecated.
boolean	isThrottle()	Deprecated.
java.lang.String	prettySerialize()	Deprecated.
void	putAllAws(java.util.Map<java.lang.String,java.lang.Object> all)	Deprecated. Puts AWS information.
void	putAllHttp(java.util.Map<java.lang.String,java.lang.Object> all)	Deprecated. Puts HTTP information.
void	putAllService(java.util.Map<java.lang.String,java.lang.Object> all)	Deprecated. Puts information about this service.
void	putAllSql(java.util.Map<java.lang.String,java.lang.Object> all)	Deprecated. Puts SQL information.
void	putAnnotation(java.lang.String key, java.lang.Boolean value)	Deprecated. Puts a Boolean annotation.
void	putAnnotation(java.lang.String key, java.lang.Number value)	Deprecated. Puts a Number annotation.
void	putAnnotation(java.lang.String key, java.lang.String value)	Deprecated. Puts a String annotation.
void	putAws(java.lang.String key, java.lang.Object value)	Deprecated. Puts AWS information.
void	putHttp(java.lang.String key, java.lang.Object value)	Deprecated. Puts HTTP information.
void	putMetadata(java.lang.String key, java.lang.Object object)	Deprecated. Puts metadata under the namespace 'default'.
void	putMetadata(java.lang.String namespace, java.lang.String key, java.lang.Object object)	Deprecated. Puts metadata.
void	putService(java.lang.String key, java.lang.Object object)	Deprecated. Puts information about this service.
void	putSql(java.lang.String key, java.lang.Object value)	Deprecated. Puts SQL information.
void	removeSubsegment(Subsegment subsegment)	Deprecated. Removes a subsegment from the subsegment list.
java.lang.String	serialize()	Deprecated.
void	setAnnotations(java.util.Map<java.lang.String,java.lang.Object> annotations)	Deprecated.
void	setAws(java.util.Map<java.lang.String,java.lang.Object> aws)	Deprecated.
void	setCreator(AWSXRayRecorder creator)	Deprecated.
void	setEmitted(boolean emitted)	Deprecated.
void	setEndTime(double endTime)	Deprecated.
void	setError(boolean error)	Deprecated. Sets the error value of the entity.
void	setFault(boolean fault)	Deprecated.
void	setHttp(java.util.Map<java.lang.String,java.lang.Object> http)	Deprecated.
void	setId(java.lang.String id)	Deprecated.
void	setInProgress(boolean inProgress)	Deprecated.
void	setMetadata(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> metadata)	Deprecated.
void	setNamespace(java.lang.String namespace)	Deprecated.
void	setOrigin(java.lang.String origin)	Deprecated.
void	setParent(Entity parent)	Deprecated.
void	setParentId(@Nullable java.lang.String parentId)	Deprecated.
void	setResourceArn(java.lang.String resourceArn)	Deprecated.
void	setRuleName(java.lang.String name)	Deprecated.
void	setSampled(boolean sampled)	Deprecated.
void	setService(java.util.Map<java.lang.String,java.lang.Object> service)	Deprecated.
void	setSql(java.util.Map<java.lang.String,java.lang.Object> sql)	Deprecated.
void	setStartTime(double startTime)	Deprecated.
void	setSubsegmentsLock(java.util.concurrent.locks.ReentrantLock subsegmentsLock)	Deprecated.
void	setThrottle(boolean throttle)	Deprecated. Sets the throttle value.
void	setTraceId(TraceID traceId)	Deprecated.
void	setUser(java.lang.String user)	Deprecated.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.amazonaws.xray.entities.Entity

run, run

Constructor Detail

DummySegment

public DummySegment(AWSXRayRecorder creator,
                    java.lang.String name,
                    TraceID traceId)

Deprecated.

DummySegment

public DummySegment(AWSXRayRecorder creator)

Deprecated.

DummySegment

public DummySegment(AWSXRayRecorder creator,
                    TraceID traceId)

Deprecated.

Method Detail

getName

public java.lang.String getName()

Deprecated.

Specified by:

getName in interface Entity

getId

public java.lang.String getId()

Deprecated.

Specified by:

getId in interface Entity

Returns:

the id

setId

public void setId(java.lang.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 java.lang.String getNamespace()

Deprecated.

Specified by:

getNamespace in interface Entity

Returns:

the namespace

setNamespace

public void setNamespace(java.lang.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 java.util.Map<java.lang.String,java.lang.Object> getHttp()

Deprecated.

Specified by:

getHttp in interface Entity

Returns:

the http

setHttp

public void setHttp(java.util.Map<java.lang.String,java.lang.Object> http)

Deprecated.

Specified by:

setHttp in interface Entity

Parameters:

http - the http to set

getAws

public java.util.Map<java.lang.String,java.lang.Object> getAws()

Deprecated.

Specified by:

getAws in interface Entity

Returns:

the aws

setAws

public void setAws(java.util.Map<java.lang.String,java.lang.Object> aws)

Deprecated.

Specified by:

setAws in interface Entity

Parameters:

aws - the aws to set

getSql

public java.util.Map<java.lang.String,java.lang.Object> getSql()

Deprecated.

Specified by:

getSql in interface Entity

Returns:

the sql

setSql

public void setSql(java.util.Map<java.lang.String,java.lang.Object> sql)

Deprecated.

Specified by:

setSql in interface Entity

Parameters:

sql - the sql to set

getMetadata

public java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> getMetadata()

Deprecated.

Specified by:

getMetadata in interface Entity

Returns:

the metadata

setMetadata

public void setMetadata(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> metadata)

Deprecated.

Specified by:

setMetadata in interface Entity

Parameters:

metadata - the metadata to set

setAnnotations

public void setAnnotations(java.util.Map<java.lang.String,java.lang.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 java.lang.String getParentId()

Deprecated.

Specified by:

getParentId in interface Entity

Returns:

the parentId

setParentId

public void setParentId(@Nullable java.lang.String parentId)

Deprecated.

Specified by:

setParentId in interface Entity

Parameters:

parentId - the parentId to set

getSubsegments

public java.util.List<Subsegment> getSubsegments()

Deprecated.

Specified by:

getSubsegments in interface Entity

Returns:

the subsegments

getSubsegmentsCopy

public java.util.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(java.lang.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(java.lang.String key,
                    java.lang.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(java.util.Map<java.lang.String,java.lang.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(java.lang.String key,
                   java.lang.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(java.util.Map<java.lang.String,java.lang.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(java.lang.String key,
                   java.lang.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(java.util.Map<java.lang.String,java.lang.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(java.lang.String key,
                          java.lang.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(java.lang.String key,
                          java.lang.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(java.lang.String key,
                          java.lang.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(java.lang.String key,
                        java.lang.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(java.lang.String namespace,
                        java.lang.String key,
                        java.lang.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.

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 java.lang.String serialize()

Deprecated.

Specified by:

serialize in interface Entity

prettySerialize

public java.lang.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(java.lang.String key,
                       java.lang.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 Segment

Returns:

the sampled

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 java.util.concurrent.atomic.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 java.lang.String getResourceArn()

Deprecated.

Specified by:

getResourceArn in interface Segment

Returns:

the resourceArn

setResourceArn

public void setResourceArn(java.lang.String resourceArn)

Deprecated.

Specified by:

setResourceArn in interface Segment

Parameters:

resourceArn - the resourceArn to set

getUser

public java.lang.String getUser()

Deprecated.

Specified by:

getUser in interface Segment

Returns:

the user

setUser

public void setUser(java.lang.String user)

Deprecated.

Specified by:

setUser in interface Segment

Parameters:

user - the user to set

getOrigin

public java.lang.String getOrigin()

Deprecated.

Specified by:

getOrigin in interface Segment

Returns:

the origin

setOrigin

public void setOrigin(java.lang.String origin)

Deprecated.

Specified by:

setOrigin in interface Segment

Parameters:

origin - the origin to set

getService

public java.util.Map<java.lang.String,java.lang.Object> getService()

Deprecated.

Specified by:

getService in interface Segment

Returns:

the service

getAnnotations

public java.util.Map<java.lang.String,java.lang.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 java.lang.AutoCloseable

Specified by:

close in interface Segment

getSubsegmentsLock

public java.util.concurrent.locks.ReentrantLock getSubsegmentsLock()

Deprecated.

Specified by:

getSubsegmentsLock in interface Entity

Returns:

an unused ReentrantLock

setSubsegmentsLock

public void setSubsegmentsLock(java.util.concurrent.locks.ReentrantLock subsegmentsLock)

Deprecated.

Specified by:

setSubsegmentsLock in interface Entity

Parameters:

subsegmentsLock - the subsegmentsLock to set

putAllService

public void putAllService(java.util.Map<java.lang.String,java.lang.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(java.util.Map<java.lang.String,java.lang.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(java.lang.String name)

Deprecated.

Specified by:

setRuleName in interface Segment