HttpSender (OWASP Zed Attack Proxy)

java.lang.Object
- org.parosproxy.paros.network.HttpSender

```
public class HttpSender
extends Object
```

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ACCESS_CONTROL_SCANNER_INITIATOR`
`static int`	`ACTIVE_SCANNER_INITIATOR`
`static int`	`AJAX_SPIDER_INITIATOR`
`static int`	`AUTHENTICATION_HELPER_INITIATOR`
`static int`	`AUTHENTICATION_INITIATOR`
`static int`	`AUTHENTICATION_POLL_INITIATOR`
`static int`	`BEAN_SHELL_INITIATOR`
`static int`	`CHECK_FOR_UPDATES_INITIATOR`
`static int`	`FORCED_BROWSE_INITIATOR`
`static int`	`FUZZER_INITIATOR`
`static int`	`MANUAL_REQUEST_INITIATOR`
`static int`	`PROXY_INITIATOR`
`static int`	`SPIDER_INITIATOR`
`static int`	`TOKEN_GENERATOR_INITIATOR`
`static int`	`WEB_SOCKET_INITIATOR`

Constructor Summary

Constructors
Constructor and Description

HttpSender(ConnectionParam connectionParam, boolean useGlobalState, int initiator)
Constructs an HttpSender.

Constructors
Constructor and Description
`HttpSender(ConnectionParam connectionParam, boolean useGlobalState, int initiator)` Constructs an `HttpSender`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static void`	`addListener(HttpSenderListener listener)`
`int`	`executeMethod(org.apache.commons.httpclient.HttpMethod method, org.apache.commons.httpclient.HttpState state)`
`org.apache.commons.httpclient.HttpClient`	`getClient()` Deprecated. (2.8.0) Do not use, this exposes implementation details which might change without warning. It will be removed in a following version.
`static SSLConnector`	`getSSLConnector()`
`User`	`getUser(HttpMessage msg)`
`static String`	`getUserAgent()`
`static void`	`removeListener(HttpSenderListener listener)`
`void`	`sendAndReceive(HttpMessage msg)`
`void`	`sendAndReceive(HttpMessage msg, boolean isFollowRedirect)` Send and receive a HttpMessage.
`void`	`sendAndReceive(HttpMessage message, HttpRequestConfig requestConfig)` Sends the request of given HTTP `message` with the given configurations.
`void`	`setAllowCircularRedirects(boolean allow)` Sets whether or not circular redirects are allowed.
`void`	`setFollowRedirect(boolean followRedirect)`
`void`	`setMaxRedirects(int maxRedirects)` Sets the maximum number of redirects that will be followed before failing with an exception.
`void`	`setMaxRetriesOnIOError(int retries)` Sets the maximum number of retries of an unsuccessful request caused by I/O errors.
`void`	`setRemoveUserDefinedAuthHeaders(boolean removeHeaders)` Sets whether or not the authentication headers ("Authorization" and "Proxy-Authorization") already present in the request should be removed if received an authentication challenge (status codes 401 and 407).
`void`	`setUseCookies(boolean shouldUseCookies)` Sets whether or not the requests sent should keep track of cookies.
`void`	`setUseGlobalState(boolean enableGlobalState)` Sets whether or not the global state should be used.
`void`	`setUser(User user)` Set the user to scan as.
`static void`	`setUserAgent(String userAgent)`
`void`	`shutdown()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PROXY_INITIATOR
```
public static final int PROXY_INITIATOR
```
    See Also:
    
    Constant Field Values
  - ACTIVE_SCANNER_INITIATOR
```
public static final int ACTIVE_SCANNER_INITIATOR
```
    See Also:
    
    Constant Field Values
  - SPIDER_INITIATOR
```
public static final int SPIDER_INITIATOR
```
    See Also:
    
    Constant Field Values
  - FUZZER_INITIATOR
```
public static final int FUZZER_INITIATOR
```
    See Also:
    
    Constant Field Values
  - AUTHENTICATION_INITIATOR
```
public static final int AUTHENTICATION_INITIATOR
```
    See Also:
    
    Constant Field Values
  - MANUAL_REQUEST_INITIATOR
```
public static final int MANUAL_REQUEST_INITIATOR
```
    See Also:
    
    Constant Field Values
  - CHECK_FOR_UPDATES_INITIATOR
```
public static final int CHECK_FOR_UPDATES_INITIATOR
```
    See Also:
    
    Constant Field Values
  - BEAN_SHELL_INITIATOR
```
public static final int BEAN_SHELL_INITIATOR
```
    See Also:
    
    Constant Field Values
  - ACCESS_CONTROL_SCANNER_INITIATOR
```
public static final int ACCESS_CONTROL_SCANNER_INITIATOR
```
    See Also:
    
    Constant Field Values
  - AJAX_SPIDER_INITIATOR
```
public static final int AJAX_SPIDER_INITIATOR
```
    See Also:
    
    Constant Field Values
  - FORCED_BROWSE_INITIATOR
```
public static final int FORCED_BROWSE_INITIATOR
```
    See Also:
    
    Constant Field Values
  - TOKEN_GENERATOR_INITIATOR
```
public static final int TOKEN_GENERATOR_INITIATOR
```
    See Also:
    
    Constant Field Values
  - WEB_SOCKET_INITIATOR
```
public static final int WEB_SOCKET_INITIATOR
```
    See Also:
    
    Constant Field Values
  - AUTHENTICATION_HELPER_INITIATOR
```
public static final int AUTHENTICATION_HELPER_INITIATOR
```
    See Also:
    
    Constant Field Values
  - AUTHENTICATION_POLL_INITIATOR
```
public static final int AUTHENTICATION_POLL_INITIATOR
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - HttpSender
```
public HttpSender(ConnectionParam connectionParam,
                  boolean useGlobalState,
                  int initiator)
```
    Constructs an HttpSender.
    If useGlobalState is true the HttpSender will use the HTTP state given by ConnectionParam#getHttpState() iff ConnectionParam#isHttpStateEnabled() returns true otherwise it doesn't have any state (i.e. cookies are disabled). If useGlobalState is false it uses a non shared HTTP state. The actual state used is overridden, per message, when HttpMessage#getRequestingUser() returns non null.
    The initiator is used to indicate the component that is sending the messages when the HttpSenderListeners are notified of messages sent and received.
    
    Parameters:
    
    connectionParam - the parameters used to setup the connections to target hosts
    
    useGlobalState - true if the messages sent/received should use the global HTTP state, false if should use a non shared HTTP state
    
    initiator - the ID of the initiator of the HTTP messages sent
    
    See Also:
    
    ConnectionParam.getHttpState(), HttpSenderListener, HttpMessage.getRequestingUser()
- Method Detail
  - getSSLConnector
```
public static SSLConnector getSSLConnector()
```
  - setUseGlobalState
```
public void setUseGlobalState(boolean enableGlobalState)
```
    Sets whether or not the global state should be used.
    Refer to HttpSender(ConnectionParam, boolean, int) for details on how the global state is used.
    
    Parameters:
    
    enableGlobalState - true if the global state should be used, false otherwise.
    
    Since:
    
    2.8.0
  - setUseCookies
```
public void setUseCookies(boolean shouldUseCookies)
```
    Sets whether or not the requests sent should keep track of cookies.
    
    Parameters:
    
    shouldUseCookies - true if cookies should be used, false otherwise.
    
    Since:
    
    2.9.0
  - executeMethod
```
public int executeMethod(org.apache.commons.httpclient.HttpMethod method,
                         org.apache.commons.httpclient.HttpState state)
                  throws IOException
```
    Throws:
    
    IOException
  - shutdown
```
public void shutdown()
```
  - sendAndReceive
```
public void sendAndReceive(HttpMessage msg)
                    throws IOException
```
    Throws:
    
    IOException
  - sendAndReceive
```
public void sendAndReceive(HttpMessage msg,
                           boolean isFollowRedirect)
                    throws IOException
```
    Send and receive a HttpMessage.
    
    Parameters:
    
    msg -
    
    isFollowRedirect -
    
    Throws:
    
    org.apache.commons.httpclient.HttpException
    
    IOException
    
    See Also:
    
    sendAndReceive(HttpMessage, HttpRequestConfig)
  - getUser
```
public User getUser(HttpMessage msg)
```
  - setFollowRedirect
```
public void setFollowRedirect(boolean followRedirect)
```
  - getUserAgent
```
public static String getUserAgent()
```
    Returns:
    
    Returns the userAgent.
  - setUserAgent
```
public static void setUserAgent(String userAgent)
```
    Parameters:
    
    userAgent - The userAgent to set.
  - addListener
```
public static void addListener(HttpSenderListener listener)
```
  - removeListener
```
public static void removeListener(HttpSenderListener listener)
```
  - setUser
```
public void setUser(User user)
```
    Set the user to scan as. If null then the current session will be used.
    
    Parameters:
    
    user -
  - getClient
```
@Deprecated
public org.apache.commons.httpclient.HttpClient getClient()
```
    Deprecated. (2.8.0) Do not use, this exposes implementation details which might change without warning. It will be removed in a following version.
    
    Returns:
    
    the HTTP client implementation.
  - setRemoveUserDefinedAuthHeaders
```
public void setRemoveUserDefinedAuthHeaders(boolean removeHeaders)
```
    Sets whether or not the authentication headers ("Authorization" and "Proxy-Authorization") already present in the request should be removed if received an authentication challenge (status codes 401 and 407).
    If true new authentication headers will be generated and the old ones removed otherwise the authentication headers already present in the request will be used to authenticate.
    Default is false, i.e. use the headers already present in the request header.
    Processes that reuse messages previously sent should consider setting this to true, otherwise new authentication challenges might fail.
    
    Parameters:
    
    removeHeaders - true if the the authentication headers already present should be removed when challenged, false otherwise
  - setMaxRetriesOnIOError
```
public void setMaxRetriesOnIOError(int retries)
```
    Sets the maximum number of retries of an unsuccessful request caused by I/O errors.
    The default number of retries is 3.
    
    Parameters:
    
    retries - the number of retries
    
    Throws:
    
    IllegalArgumentException - if retries is negative.
    
    Since:
    
    2.4.0
  - setMaxRedirects
```
public void setMaxRedirects(int maxRedirects)
```
    Sets the maximum number of redirects that will be followed before failing with an exception.
    The default maximum number of redirects is 100.
    
    Parameters:
    
    maxRedirects - the maximum number of redirects
    
    Throws:
    
    IllegalArgumentException - if maxRedirects is negative.
    
    Since:
    
    2.4.0
  - setAllowCircularRedirects
```
public void setAllowCircularRedirects(boolean allow)
```
    Sets whether or not circular redirects are allowed.
    Circular redirects happen when a request redirects to itself, or when a same request was already accessed in a chain of redirects.
    Since 2.5.0, the default is to allow circular redirects.
    
    Parameters:
    
    allow - true if circular redirects should be allowed, false otherwise
    
    Since:
    
    2.4.0
  - sendAndReceive
```
public void sendAndReceive(HttpMessage message,
                           HttpRequestConfig requestConfig)
                    throws IOException
```
    Sends the request of given HTTP message with the given configurations.
    
    Parameters:
    
    message - the message that will be sent
    
    requestConfig - the request configurations.
    
    Throws:
    
    IllegalArgumentException - if any of the parameters is null
    
    IOException - if an error occurred while sending the message or following the redirections
    
    Since:
    
    2.6.0
    
    See Also:
    
    sendAndReceive(HttpMessage, boolean)

Class HttpSender

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROXY_INITIATOR

ACTIVE_SCANNER_INITIATOR

SPIDER_INITIATOR

FUZZER_INITIATOR

AUTHENTICATION_INITIATOR

MANUAL_REQUEST_INITIATOR

CHECK_FOR_UPDATES_INITIATOR

BEAN_SHELL_INITIATOR

ACCESS_CONTROL_SCANNER_INITIATOR

AJAX_SPIDER_INITIATOR

FORCED_BROWSE_INITIATOR

TOKEN_GENERATOR_INITIATOR

WEB_SOCKET_INITIATOR

AUTHENTICATION_HELPER_INITIATOR

AUTHENTICATION_POLL_INITIATOR

Constructor Detail

HttpSender

Method Detail

getSSLConnector

setUseGlobalState

setUseCookies

executeMethod

shutdown

sendAndReceive

sendAndReceive

getUser

setFollowRedirect

getUserAgent

setUserAgent

addListener

removeListener

setUser

getClient

setRemoveUserDefinedAuthHeaders

setMaxRetriesOnIOError

setMaxRedirects

setAllowCircularRedirects

sendAndReceive