burp.IHttpService Maven / Gradle / Ivy

Go to download

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

API to reference when building extensions for Burp Suite Pro.

There is a newer version: 2.3

package burp;

/*
 * @(#)IHttpService.java
 *
 * Copyright PortSwigger Ltd. All rights reserved.
 *
 * This code may be used to extend the functionality of Burp Suite Free Edition
 * and Burp Suite Professional, provided that this usage does not violate the
 * license terms for those products.
 */
/**
 * This interface is used to provide details about an HTTP service, to which
 * HTTP requests can be sent.
 */
public interface IHttpService
{
    /**
     * This method returns the hostname or IP address for the service.
     *
     * @return The hostname or IP address for the service.
     */
    String getHost();

    /**
     * This method returns the port number for the service.
     *
     * @return The port number for the service.
     */
    int getPort();

    /**
     * This method returns the protocol for the service.
     *
     * @return The protocol for the service. Expected values are "http" or
     * "https".
     */
    String getProtocol();
}