software.amazon.disco.agent.event

Class AwsServiceDownstreamResponseEvent

java.lang.Object

software.amazon.disco.agent.event.AbstractEvent

software.amazon.disco.agent.event.AbstractServiceEvent

software.amazon.disco.agent.event.AbstractServiceResponseEvent

software.amazon.disco.agent.event.ServiceDownstreamResponseEvent

software.amazon.disco.agent.event.AwsServiceDownstreamResponseEvent

All Implemented Interfaces:

software.amazon.disco.agent.event.ActivityRequestHeaderRetrievable, AwsServiceDownstreamEvent, software.amazon.disco.agent.event.BaseHeaderRetrievable, software.amazon.disco.agent.event.Event, software.amazon.disco.agent.event.HeaderRetrievable, software.amazon.disco.agent.event.ServiceEvent, software.amazon.disco.agent.event.ServiceResponseEvent

public abstract class AwsServiceDownstreamResponseEvent
extends software.amazon.disco.agent.event.ServiceDownstreamResponseEvent
implements AwsServiceDownstreamEvent, software.amazon.disco.agent.event.HeaderRetrievable

Specialization of a ServiceDownstreamResponseEvent, to encapsulate data specific to Aws downstream call responses. Implementation of inherited methods are in the disco-java-agent-aws package.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AwsServiceDownstreamResponseEvent.DataKey Keys to use in the data map

Nested classes/interfaces inherited from interface software.amazon.disco.agent.event.ServiceEvent

software.amazon.disco.agent.event.ServiceEvent.Type

Field Summary

Fields inherited from class software.amazon.disco.agent.event.AbstractEvent

data, origin

Constructor Summary

Constructors

Constructor and Description
AwsServiceDownstreamResponseEvent(java.lang.String origin, java.lang.String service, java.lang.String operation, software.amazon.disco.agent.event.ServiceDownstreamRequestEvent requestEvent) Construct a new AwsServiceDownstreamResponseEvent

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getHeaderMap() Deprecated. deprecated in favour of HeaderRetrievable which should be used wherever possible instead.
java.lang.String	getRequestId() Retrieve the request ID of the downstream call
int	getRetryCount() Retrieve the number of times the downstream call had retried.
abstract int	getStatusCode() Obtain the overall status code of the downstream call.

Methods inherited from class software.amazon.disco.agent.event.ServiceDownstreamResponseEvent

getType

Methods inherited from class software.amazon.disco.agent.event.AbstractServiceResponseEvent

getRequest, getResponse, getThrown, withResponse, withThrown

Methods inherited from class software.amazon.disco.agent.event.AbstractServiceEvent

getOperation, getService, getServiceEventId

Methods inherited from class software.amazon.disco.agent.event.AbstractEvent

getData, getOrigin, withData

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.disco.agent.event.AwsServiceDownstreamEvent

getValueForField

Methods inherited from interface software.amazon.disco.agent.event.ServiceEvent

getOperation, getService, getServiceEventId, getType

Methods inherited from interface software.amazon.disco.agent.event.Event

getData, getOrigin

Methods inherited from interface software.amazon.disco.agent.event.BaseHeaderRetrievable

getAllHeaders, getFirstHeader, getHeaders

Constructor Detail

AwsServiceDownstreamResponseEvent

public AwsServiceDownstreamResponseEvent(java.lang.String origin,
                                         java.lang.String service,
                                         java.lang.String operation,
                                         software.amazon.disco.agent.event.ServiceDownstreamRequestEvent requestEvent)

Construct a new AwsServiceDownstreamResponseEvent

Parameters:

origin - the origin of the downstream call e.g. 'AWSv1' or 'AWSv2'

service - the service name e.g. 'DynamoDb'

operation - the operation name e.g. 'ListTables'

requestEvent - the associated request event

Method Detail

getStatusCode

public abstract int getStatusCode()

Obtain the overall status code of the downstream call. If we can't obtain it, we return -1.

Returns:

The status code of the call

getHeaderMap

@Deprecated
public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getHeaderMap()

Deprecated. deprecated in favour of HeaderRetrievable which should be used wherever possible instead.

Obtain the header map that the particular event holds.

Specified by:

getHeaderMap in interface AwsServiceDownstreamEvent

Returns:

A key-value pairing map of the headers.

getRequestId

public java.lang.String getRequestId()

Retrieve the request ID of the downstream call

Returns:

the request ID

getRetryCount

public int getRetryCount()

Retrieve the number of times the downstream call had retried.

Returns:

The retry count.