org.hertsstack.http.HertsHttpRequest Maven / Gradle / Ivy

Go to download

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

Herts real time framework for Http

There is a newer version: 1.1.4

package org.hertsstack.http;

import javax.annotation.Nullable;
import javax.servlet.ServletRequest;

/**
 * Herts http request
 *
 * @author Herts Contributer
 */
public interface HertsHttpRequest {

    /**
     * Get ServletRequest.
     * Depends on jakarta.servlet.ServletRequest
     *
     * @return jakarta.servlet.ServletRequest
     */
    ServletRequest getRequest();

    /**
     * Get Header value
     *
     * @param headerName Header name
     * @return Value
     */
    @Nullable
    String getHeader(String headerName);

    /**
     * Get remote address
     *
     * @return Remote address
     */
    String getRemoteAddr();

    /**
     * Get local address
     *
     * @return Local address
     */
    String getLocalAddr();

    /**
     * Get header auth type
     *
     * @return Auth Type
     */
    String getAuthType();

    /**
     * Get Cookies
     *
     * @return Cookies
     */
    HertsHttpRequestImpl.Cookie[] getCookies();
}