org.mule.module.http.internal.domain.HttpMessage Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mule-module-http Show documentation

Provides components for exposing and consuming HTTP services

There is a newer version: 3.9.0

/*
 * Copyright (c) MuleSoft, Inc.  All rights reserved.  http://www.mulesoft.com
 * The software in this package is published under the terms of the CPAL v1.0
 * license, a copy of which has been included with this distribution in the
 * LICENSE.txt file.
 */
package org.mule.module.http.internal.domain;

import java.util.Collection;

/**
 * Represents common parts of an http message
 */
public interface HttpMessage
{

    /**
     * @return all headers name
     */
    Collection getHeaderNames();

    /**
     * @param headerName name of the header
     * @return first value of the header
     */
    String getHeaderValue(String headerName);

    /**
     * @param headerName name of the header
     * @return first value of the header, regardless of the case
     */
    String getHeaderValueIgnoreCase(String headerName);

    /**
     * @param headerName name of the header
     * @return all the values of that headers. If not such headers exists return null, otherwise the collection of header values
     */
    Collection getHeaderValues(String headerName);

    /**
     * @param headerName name of the header
     * @return all the values of that headers, regardless of the case. If not such headers exists return null, otherwise the collection of header values
     */
    Collection getHeaderValuesIgnoreCase(String headerName);

    /**
     * @return the entity of the message. If there's no entity an {@link org.mule.module.http.internal.domain.EmptyHttpEntity} is returned
     */
    HttpEntity getEntity();

}