Package org.apache.hadoop.fs.store.audit

Class HttpReferrerAuditHeader

java.lang.Object

org.apache.hadoop.fs.store.audit.HttpReferrerAuditHeader

@Private
@Unstable
public final class HttpReferrerAuditHeader
extends java.lang.Object

Contains all the logic for generating an HTTP "Referer" entry; includes escaping query params. Tests for this are in org.apache.hadoop.fs.s3a.audit.TestHttpReferrerAuditHeader so as to verify that header generation in the S3A auditors, and S3 log parsing, all work.

This header may be shared across multiple threads at the same time. so some methods are marked as synchronized, specifically those reading or writing the attribute map.

For the same reason, maps and lists passed down during construction are copied into thread safe structures.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HttpReferrerAuditHeader.Builder	Builder.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	REFERRER_PATH_FORMAT	Format of path to build: "/hadoop/1/%3$s/%2$s/".

Method Summary

Modifier and Type	Method	Description
static HttpReferrerAuditHeader.Builder	builder()	Get a builder.
java.lang.String	buildHttpReferrer()	Build the referrer string.
static java.lang.String	escapeToPathElement(java.lang.CharSequence source)	Perform any escaping to valid path elements in advance of new URI() doing this itself.
static java.util.Map<java.lang.String,java.lang.String>	extractQueryParameters(java.lang.String header)	Split up the string.
java.lang.String	getContextId()
java.lang.String	getOperationName()
java.lang.String	getPath1()
java.lang.String	getPath2()
java.lang.String	getSpanId()
static java.lang.String	maybeStripWrappedQuotes(java.lang.String header)	Strip any quotes from around a header.
void	set(java.lang.String key, java.lang.String value)	Set an attribute.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

REFERRER_PATH_FORMAT

public static final java.lang.String REFERRER_PATH_FORMAT

Format of path to build: "/hadoop/1/%3$s/%2$s/". the params passed in are (context ID, span ID, op). Update TestHttpReferrerAuditHeader.SAMPLE_LOG_ENTRY on changes

See Also:

Constant Field Values

Method Detail

buildHttpReferrer

public java.lang.String buildHttpReferrer()

Build the referrer string. This includes dynamically evaluating all of the evaluated attributes. If there is an error creating the string it will be logged once per entry, and "" returned.

Returns:

a referrer string or ""

set

public void set(java.lang.String key,
                java.lang.String value)

Set an attribute. If the value is non-null/empty, it will be used as a query parameter.

Parameters:

key - key to set

value - value.

getContextId

public java.lang.String getContextId()

getOperationName

public java.lang.String getOperationName()

getSpanId

public java.lang.String getSpanId()

getPath1

public java.lang.String getPath1()

getPath2

public java.lang.String getPath2()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

escapeToPathElement

public static java.lang.String escapeToPathElement(java.lang.CharSequence source)

Perform any escaping to valid path elements in advance of new URI() doing this itself. Only path separators need to be escaped/converted at this point.

Parameters:

source - source string

Returns:

an escaped path element.

maybeStripWrappedQuotes

public static java.lang.String maybeStripWrappedQuotes(java.lang.String header)

Strip any quotes from around a header. This is needed when processing log entries.

Parameters:

header - field.

Returns:

field without quotes.

extractQueryParameters

public static java.util.Map<java.lang.String,java.lang.String> extractQueryParameters(java.lang.String header)
                                                                                     throws java.net.URISyntaxException

Split up the string. Uses httpClient: make sure it is on the classpath. Any query param with a name but no value, e.g ?something is returned in the map with an empty string as the value.

Parameters:

header - URI to parse

Returns:

a map of parameters.

Throws:

java.net.URISyntaxException - failure to build URI from header.

builder

public static HttpReferrerAuditHeader.Builder builder()

Get a builder.

Returns:

a new builder.