Package com.amazonaws.xray.entities

Class FacadeSegment

java.lang.Object

com.amazonaws.xray.entities.EntityImpl

com.amazonaws.xray.entities.FacadeSegment

All Implemented Interfaces:

Entity, Segment, AutoCloseable

public class FacadeSegment
extends EntityImpl
implements Segment

Field Summary

Fields

Modifier and Type	Field	Description
protected String	origin
protected String	resourceArn
protected Map<String,Object>	service
protected String	user

Fields inherited from class com.amazonaws.xray.entities.EntityImpl

mapper, referenceCount, totalSize

Constructor Summary

Constructors

Constructor	Description
FacadeSegment(AWSXRayRecorder recorder, @Nullable TraceID traceId, @Nullable String id, @Nullable TraceHeader.SampleDecision sampleDecision)

Method Summary

Modifier and Type	Method	Description
void	addException(Throwable exception)	Unsupported as FacadeSegments cannot be mutated.
void	close()	Unsupported as FacadeSegments cannot be mutated.
boolean	end()	Unsupported as FacadeSegments cannot be mutated.
String	getOrigin()	Unsupported as FacadeSegments are not aware of their origin.
Segment	getParentSegment()
String	getResourceArn()	Unsupported as FacadeSegments are not aware of their resource ARN.
Map<String,Object>	getService()	Unsupported as FacadeSegments are not aware of their service.
LongAdder	getTotalSize()
String	getUser()	Unsupported as FacadeSegments are not aware of their user.
boolean	isRecording()	Returns if this Segment is recording events and will be emitted.
boolean	isSampled()
void	putAllAws(Map<String,Object> all)	Unsupported as FacadeSegments cannot be mutated.
void	putAllHttp(Map<String,Object> all)	Unsupported as FacadeSegments cannot be mutated.
void	putAllService(Map<String,Object> all)	Unsupported as FacadeSegments cannot be mutated.
void	putAllSql(Map<String,Object> all)	Unsupported as FacadeSegments cannot be mutated.
void	putAnnotation(String key, Boolean value)	Unsupported as FacadeSegments cannot be mutated.
void	putAnnotation(String key, Number value)	Unsupported as FacadeSegments cannot be mutated.
void	putAnnotation(String key, String value)	Unsupported as FacadeSegments cannot be mutated.
void	putAws(String key, Object value)	Unsupported as FacadeSegments cannot be mutated.
void	putHttp(String key, Object value)	Unsupported as FacadeSegments cannot be mutated.
void	putMetadata(String key, Object object)	Unsupported as FacadeSegments cannot be mutated.
void	putMetadata(String namespace, String key, Object object)	Unsupported as FacadeSegments cannot be mutated.
void	putService(String key, Object object)	Unsupported as FacadeSegments cannot be mutated.
void	putSql(String key, Object value)	Unsupported as FacadeSegments cannot be mutated.
void	setAnnotations(Map<String,Object> annotations)	Unsupported as FacadeSegments cannot be mutated.
void	setAws(Map<String,Object> aws)	Unsupported as FacadeSegments cannot be mutated.
void	setCreator(AWSXRayRecorder creator)	Unsupported as FacadeSegments cannot be mutated.
void	setEndTime(double endTime)	Unsupported as FacadeSegments cannot be mutated.
void	setError(boolean error)	Unsupported as FacadeSegments cannot be mutated.
void	setFault(boolean fault)	Unsupported as FacadeSegments cannot be mutated.
void	setHttp(Map<String,Object> http)	Unsupported as FacadeSegments cannot be mutated.
void	setId(String id)	Unsupported as FacadeSegments cannot be mutated.
void	setInProgress(boolean inProgress)	Unsupported as FacadeSegments cannot be mutated.
void	setMetadata(Map<String,Map<String,Object>> metadata)	Unsupported as FacadeSegments cannot be mutated.
void	setNamespace(String namespace)	Unsupported as FacadeSegments cannot be mutated.
void	setOrigin(String origin)	Unsupported as FacadeSegments cannot be mutated.
void	setParent(Entity parent)	Unsupported as FacadeSegments cannot be mutated.
void	setParentId(@Nullable String parentId)	Unsupported as FacadeSegments cannot be mutated.
void	setResourceArn(String resourceArn)	Unsupported as FacadeSegments cannot be mutated.
void	setRuleName(String name)
void	setSampled(boolean sampled)	Unsupported as FacadeSegments cannot be mutated.
void	setService(Map<String,Object> service)	Unsupported as FacadeSegments cannot be mutated.
void	setSql(Map<String,Object> sql)	Unsupported as FacadeSegments cannot be mutated.
void	setStartTime(double startTime)	Unsupported as FacadeSegments cannot be mutated.
void	setThrottle(boolean throttle)	Unsupported as FacadeSegments cannot be mutated.
void	setTraceId(@Nullable TraceID traceId)	Unsupported as FacadeSegments cannot be mutated.
void	setUser(String user)	Unsupported as FacadeSegments cannot be mutated.

Methods inherited from class com.amazonaws.xray.entities.EntityImpl

addSubsegment, checkAlreadyEmitted, compareAndSetEmitted, decrementReferenceCount, getAnnotations, getAws, getCause, getCreator, getEndTime, getHttp, getId, getMetadata, getName, getNamespace, getParent, getParentId, getReferenceCount, getSql, getStartTime, getSubsegments, getSubsegmentsCopy, getSubsegmentsLock, getTraceId, incrementReferenceCount, isEmitted, isError, isFault, isInProgress, isThrottle, prettySerialize, removeSubsegment, serialize, setEmitted, setSubsegmentsLock, validateNotNull

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

addSubsegment, compareAndSetEmitted, decrementReferenceCount, getAws, getCause, getCreator, getEndTime, getHttp, getId, getMetadata, getName, getNamespace, getParent, getParentId, getReferenceCount, getSql, getStartTime, getSubsegments, getSubsegmentsCopy, getSubsegmentsLock, getTraceId, incrementReferenceCount, isEmitted, isError, isFault, isInProgress, isThrottle, prettySerialize, removeSubsegment, run, run, serialize, setEmitted, setSubsegmentsLock

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

getAnnotations

Field Details

resourceArn

protected String resourceArn

user

protected String user

origin

protected String origin

service

protected Map<String,Object> service

Constructor Details

FacadeSegment

public FacadeSegment(AWSXRayRecorder recorder,
 @Nullable TraceID traceId,
 @Nullable String id,
 @Nullable TraceHeader.SampleDecision sampleDecision)

Method Details

close

public void close()

Unsupported as FacadeSegments cannot be mutated.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Segment

Throws:

UnsupportedOperationException - in all cases

end

public boolean end()

Unsupported as FacadeSegments cannot be mutated.

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

Throws:

UnsupportedOperationException - in all cases

isRecording

public boolean isRecording()

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)

Unsupported as FacadeSegments cannot be mutated.

Specified by:

putService in interface Segment

Parameters:

key - the key under which the service information is stored

object - the service information

Throws:

UnsupportedOperationException - in all cases

getTotalSize

public LongAdder getTotalSize()

Specified by:

getTotalSize in interface Entity

Overrides:

getTotalSize in class EntityImpl

Returns:

a LongAdder with a value of 0, as the total size of a FacadeSegment is not tracked.

isSampled

public boolean isSampled()

Specified by:

isSampled in interface Entity

setSampled

public void setSampled(boolean sampled)

Unsupported as FacadeSegments cannot be mutated.

Specified by:

setSampled in interface Segment

Parameters:

sampled - the sampled to set

Throws:

UnsupportedOperationException - in all cases

getResourceArn

public String getResourceArn()

Unsupported as FacadeSegments are not aware of their resource ARN.

Specified by:

getResourceArn in interface Segment

Returns:

the resourceArn

Throws:

UnsupportedOperationException - in all cases

setResourceArn

public void setResourceArn(String resourceArn)

Unsupported as FacadeSegments cannot be mutated.

Specified by:

setResourceArn in interface Segment

Parameters:

resourceArn - the resourceArn to set

Throws:

UnsupportedOperationException - in all cases

getUser

public String getUser()

Unsupported as FacadeSegments are not aware of their user.

Specified by:

getUser in interface Segment

Returns:

the user

Throws:

UnsupportedOperationException - in all cases

setUser

public void setUser(String user)

Unsupported as FacadeSegments cannot be mutated.

Specified by:

setUser in interface Segment

Parameters:

user - the user to set

Throws:

UnsupportedOperationException - in all cases

getOrigin

public String getOrigin()

Unsupported as FacadeSegments are not aware of their origin.

Specified by:

getOrigin in interface Segment

Returns:

the origin

Throws:

UnsupportedOperationException - in all cases

setOrigin

public void setOrigin(String origin)

Unsupported as FacadeSegments cannot be mutated.

Specified by:

setOrigin in interface Segment

Parameters:

origin - the origin to set

Throws:

UnsupportedOperationException - in all cases

getService

public Map<String,Object> getService()

Unsupported as FacadeSegments are not aware of their service.

Specified by:

getService in interface Segment

Returns:

the service

Throws:

UnsupportedOperationException - in all cases

getParentSegment

public Segment getParentSegment()

Specified by:

getParentSegment in interface Entity

Specified by:

getParentSegment in interface Segment

Specified by:

getParentSegment in class EntityImpl

setId

public void setId(String id)

Unsupported as FacadeSegments cannot be mutated.

Specified by:

setId in interface Entity

Overrides:

setId in class EntityImpl

Parameters:

id - the id to set

Throws:

UnsupportedOperationException - in all cases

setStartTime

public void setStartTime(double startTime)

Unsupported as FacadeSegments cannot be mutated.

Specified by:

setStartTime in interface Entity

Overrides:

setStartTime in class EntityImpl

Parameters:

startTime - the startTime to set

Throws:

UnsupportedOperationException - in all cases

setEndTime

public void setEndTime(double endTime)

Unsupported as FacadeSegments cannot be mutated.

Specified by:

setEndTime in interface Entity

Overrides:

setEndTime in class EntityImpl

Parameters:

endTime - the endTime to set

Throws:

UnsupportedOperationException - in all cases

setFault

public void setFault(boolean fault)

Unsupported as FacadeSegments cannot be mutated.

Specified by:

setFault in interface Entity

Overrides:

setFault in class EntityImpl

Parameters:

fault - the fault to set

Throws:

UnsupportedOperationException - in all cases

setError

public void setError(boolean error)

Unsupported as FacadeSegments cannot be mutated.

Specified by:

setError in interface Entity

Overrides:

setError in class EntityImpl

Parameters:

error - the error to set

Throws:

UnsupportedOperationException - in all cases

setNamespace

public void setNamespace(String namespace)

Unsupported as FacadeSegments cannot be mutated.

Specified by:

setNamespace in interface Entity

Overrides:

setNamespace in class EntityImpl

Parameters:

namespace - the namespace to set

Throws:

UnsupportedOperationException - in all cases

setHttp

public void setHttp(Map<String,Object> http)

Unsupported as FacadeSegments cannot be mutated.

Specified by:

setHttp in interface Entity

Overrides:

setHttp in class EntityImpl

Parameters:

http - the http to set

Throws:

UnsupportedOperationException - in all cases

setAws

public void setAws(Map<String,Object> aws)

Unsupported as FacadeSegments cannot be mutated.

Specified by:

setAws in interface Entity

Overrides:

setAws in class EntityImpl

Parameters:

aws - the aws to set

Throws:

UnsupportedOperationException - in all cases

setSql

public void setSql(Map<String,Object> sql)

Unsupported as FacadeSegments cannot be mutated.

Specified by:

setSql in interface Entity

Overrides:

setSql in class EntityImpl

Parameters:

sql - the sql to set

Throws:

UnsupportedOperationException - in all cases

setMetadata

public void setMetadata(Map<String,Map<String,Object>> metadata)

Unsupported as FacadeSegments cannot be mutated.

Specified by:

setMetadata in interface Entity

Overrides:

setMetadata in class EntityImpl

Parameters:

metadata - the metadata to set

Throws:

UnsupportedOperationException - in all cases

setAnnotations

public void setAnnotations(Map<String,Object> annotations)

Unsupported as FacadeSegments cannot be mutated.

Specified by:

setAnnotations in interface Entity

Overrides:

setAnnotations in class EntityImpl

Parameters:

annotations - the annotations to set

Throws:

UnsupportedOperationException - in all cases

setParent

public void setParent(Entity parent)

Unsupported as FacadeSegments cannot be mutated.

Specified by:

setParent in interface Entity

Overrides:

setParent in class EntityImpl

Parameters:

parent - the parent to set

Throws:

UnsupportedOperationException - in all cases

setCreator

public void setCreator(AWSXRayRecorder creator)

Unsupported as FacadeSegments cannot be mutated.

Specified by:

setCreator in interface Entity

Overrides:

setCreator in class EntityImpl

Parameters:

creator - the creator to set

Throws:

UnsupportedOperationException - in all cases

setThrottle

public void setThrottle(boolean throttle)

Unsupported as FacadeSegments cannot be mutated.

Specified by:

setThrottle in interface Entity

Overrides:

setThrottle in class EntityImpl

Parameters:

throttle - the throttle to set

Throws:

UnsupportedOperationException - in all cases

setInProgress

public void setInProgress(boolean inProgress)

Unsupported as FacadeSegments cannot be mutated.

Specified by:

setInProgress in interface Entity

Overrides:

setInProgress in class EntityImpl

Parameters:

inProgress - the inProgress to set

Throws:

UnsupportedOperationException - in all cases

setTraceId

public void setTraceId(@Nullable TraceID traceId)

Unsupported as FacadeSegments cannot be mutated.

Specified by:

setTraceId in interface Entity

Overrides:

setTraceId in class EntityImpl

Parameters:

traceId - the traceId to set

Throws:

UnsupportedOperationException - in all cases

setParentId

public void setParentId(@Nullable String parentId)

Unsupported as FacadeSegments cannot be mutated.

Specified by:

setParentId in interface Entity

Overrides:

setParentId in class EntityImpl

Parameters:

parentId - the parentId to set

Throws:

UnsupportedOperationException - in all cases

addException

public void addException(Throwable exception)

Unsupported as FacadeSegments cannot be mutated.

Specified by:

addException in interface Entity

Overrides:

addException in class EntityImpl

Parameters:

exception - the exception to add

Throws:

UnsupportedOperationException - in all cases

putHttp

public void putHttp(String key,
 Object value)

Unsupported as FacadeSegments cannot be mutated.

Specified by:

putHttp in interface Entity

Overrides:

putHttp in class EntityImpl

Parameters:

key - the key under which the HTTP information is stored

value - the HTTP information

Throws:

UnsupportedOperationException - in all cases

putAllHttp

public void putAllHttp(Map<String,Object> all)

Unsupported as FacadeSegments cannot be mutated.

Specified by:

putAllHttp in interface Entity

Overrides:

putAllHttp in class EntityImpl

Parameters:

all - the HTTP information to put

Throws:

UnsupportedOperationException - in all cases

putAws

public void putAws(String key,
 Object value)

Unsupported as FacadeSegments cannot be mutated.

Specified by:

putAws in interface Entity

Overrides:

putAws in class EntityImpl

Parameters:

key - the key under which the AWS information is stored

value - the AWS information

Throws:

UnsupportedOperationException - in all cases

putAllAws

public void putAllAws(Map<String,Object> all)

Unsupported as FacadeSegments cannot be mutated.

Specified by:

putAllAws in interface Entity

Overrides:

putAllAws in class EntityImpl

Parameters:

all - the AWS information to put

Throws:

UnsupportedOperationException - in all cases

putSql

public void putSql(String key,
 Object value)

Unsupported as FacadeSegments cannot be mutated.

Specified by:

putSql in interface Entity

Overrides:

putSql in class EntityImpl

Parameters:

key - the key under which the SQL information is stored

value - the SQL information

Throws:

UnsupportedOperationException - in all cases

putAllSql

public void putAllSql(Map<String,Object> all)

Unsupported as FacadeSegments cannot be mutated.

Specified by:

putAllSql in interface Entity

Overrides:

putAllSql in class EntityImpl

Parameters:

all - the SQL information to put

Throws:

UnsupportedOperationException - in all cases

putAnnotation

public void putAnnotation(String key,
 String value)

Unsupported as FacadeSegments cannot be mutated.

Specified by:

putAnnotation in interface Entity

Overrides:

putAnnotation in class EntityImpl

Parameters:

key - the key under which the annotation is stored

value - the String annotation

Throws:

UnsupportedOperationException - in all cases

putAnnotation

public void putAnnotation(String key,
 Number value)

Unsupported as FacadeSegments cannot be mutated.

Specified by:

putAnnotation in interface Entity

Overrides:

putAnnotation in class EntityImpl

Parameters:

key - the key under which the annotation is stored

value - the Number annotation

Throws:

UnsupportedOperationException - in all cases

putAnnotation

public void putAnnotation(String key,
 Boolean value)

Unsupported as FacadeSegments cannot be mutated.

Specified by:

putAnnotation in interface Entity

Overrides:

putAnnotation in class EntityImpl

Parameters:

key - the key under which the annotation is stored

value - the Boolean annotation

Throws:

UnsupportedOperationException - in all cases

putMetadata

public void putMetadata(String key,
 Object object)

Unsupported as FacadeSegments cannot be mutated.

Specified by:

putMetadata in interface Entity

Overrides:

putMetadata in class EntityImpl

Parameters:

key - the key under which the metadata is stored

object - the metadata

Throws:

UnsupportedOperationException - in all cases

putMetadata

public void putMetadata(String namespace,
 String key,
 Object object)

Unsupported as FacadeSegments cannot be mutated.

Specified by:

putMetadata in interface Entity

Overrides:

putMetadata in class EntityImpl

Parameters:

namespace - the namespace under which the metadata is stored

key - the key under which the metadata is stored

object - the metadata

Throws:

UnsupportedOperationException - in all cases

putAllService

public void putAllService(Map<String,Object> all)

Unsupported as FacadeSegments cannot be mutated.

Specified by:

putAllService in interface Segment

Parameters:

all - the service information to set.

Throws:

UnsupportedOperationException - in all cases

setService

public void setService(Map<String,Object> service)

Unsupported as FacadeSegments cannot be mutated.

Specified by:

setService in interface Segment

Parameters:

service - the service to set

Throws:

UnsupportedOperationException - in all cases

setRuleName

public void setRuleName(String name)

Specified by:

setRuleName in interface Segment