com.atlassian.bitbucket.request

Interface RequestMetadata

All Known Subinterfaces:

RequestContext, RequestInfoProvider

public interface RequestMetadata

Interface for providing immutable request meta data to RequestManager. These details are used to set up auditing, logging and profiling.

Method Summary

Modifier and Type	Method and Description
String	getAction()
String	getDetails()
String	getProtocol()
String	getRemoteAddress()
String	getSessionId()
boolean	hasSessionId()
boolean	isSecure()

Method Detail

getAction

@Nonnull
String getAction()

Returns:

the URL or command which was requested, omitting any scheme, host, port and context path information. Query parameters for the request should also not be returned, as they may contain sensitive data

getDetails

@Nullable
String getDetails()

Returns:

any further details associated with the request that are relevant, or null if not relevant

getProtocol

@Nonnull
String getProtocol()

Returns:

the protocol of the request

getRemoteAddress

@Nullable
String getRemoteAddress()

Returns:

a comma-delimited string containing 1 or more IP addresses for the provided request, or null if this information is not available

getSessionId

@Nullable
String getSessionId()

Returns:

a unique identifier for the session associated with the provided request, or null if there is no session available

hasSessionId

boolean hasSessionId()

Returns:

true iff a session is available

isSecure

boolean isSecure()

Returns:

true if the request is being made over a secure protocol; otherwise, false