burp.api.montoya.http.HttpService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of montoya-api Show documentation
The newest version!
/*
 * Copyright (c) 2022-2023. PortSwigger Ltd. All rights reserved.
 *
 * This code may be used to extend the functionality of Burp Suite Community Edition
 * and Burp Suite Professional, provided that this usage does not violate the
 * license terms for those products.
 */

package burp.api.montoya.http;

import static burp.api.montoya.internal.ObjectFactoryLocator.FACTORY;

/**
 * Burp HTTP service providing details about an HTTP service, to which HTTP requests can be sent.
 */
public interface HttpService
{

    /**
     * @return The hostname or IP address for the service.
     */
    String host();

    /**
     * @return The port number for the service.
     */
    int port();

    /**
     * @return True if a secure protocol is used for the connection, false otherwise.
     */
    boolean secure();

    /**
     * Dynamically resolve the host to an IP address.
     *
     * @return The IP address of the host.
     */
    String ipAddress();

    /**
     * @return The {@code String} representation of the service.
     */
    @Override
    String toString();

    /**
     * Create a new instance of {@code HttpService}.
     *
     * @param baseUrl The URL for the service.
     *
     * @return A new {@code HttpService} instance.
     *
     * @throws IllegalArgumentException If the provided URL is invalid.
     */
    static HttpService httpService(String baseUrl)
    {
        return FACTORY.httpService(baseUrl);
    }

    /**
     * Create a new instance of {@code HttpService}.
     *
     * @param host   The hostname or IP address for the service.
     * @param secure True if a secure connection is to be used.
     *
     * @return A new {@code HttpService} instance.
     */
    static HttpService httpService(String host, boolean secure)
    {
        return FACTORY.httpService(host, secure);
    }

    /**
     * Create a new instance of {@code HttpService}.
     *
     * @param host   The hostname or IP address for the service.
     * @param port   The port number for the service.
     * @param secure True if a secure connection is to be used.
     *
     * @return A new {@code HttpService} instance.
     */
    static HttpService httpService(String host, int port, boolean secure)
    {
        return FACTORY.httpService(host, port, secure);
    }
}