Summary: Methods | [Expand All]
public interface

RequestMetadata

com.atlassian.bitbucket.request.RequestMetadata
Known Indirect Subclasses

Class Overview

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

Summary

Public Methods
@Nonnull String getAction()
@Nullable String getDetails()
@Nonnull String getProtocol()
@Nullable String getRemoteAddress()
@Nullable String getSessionId()
boolean hasSessionId()
boolean isSecure()

Public Methods

@Nonnull public 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

@Nullable public String getDetails ()

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

@Nonnull public String getProtocol ()

Returns
  • the protocol of the request

@Nullable public 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

@Nullable public String getSessionId ()

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

public boolean hasSessionId ()

Returns
  • true iff a session is available

public boolean isSecure ()

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