com.newrelic.api.agent.InboundHeaders Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of newrelic-api Show documentation

New Relics's Java Api Jar.

There is a newer version: 8.16.0

/*
 *
 *  * Copyright 2020 New Relic Corporation. All rights reserved.
 *  * SPDX-License-Identifier: Apache-2.0
 *
 */

package com.newrelic.api.agent;

/**
 * The type-specific headers collection of an inbound message.
 */
public interface InboundHeaders {

    /**
     * Return the type of header key syntax used for this.
     * 
     * @return An enum specifying the type of headers present.
     * @since 3.5.0
     */
    HeaderType getHeaderType();

    /**
     * Returns the value of the specified request header as a String. If the request does not include a
     * header with the specified input name, then this method returns null.
     * 
     * @param name The name of the desired request header.
     * @return A String containing the value of the specified input request header, or null if the request header is not present.
     * @since 3.5.0
     */
    String getHeader(String name);
}