org.zaproxy.zap.extension.script

Class ProxyListenerScript

java.lang.Object

org.zaproxy.zap.extension.script.ProxyListenerScript

All Implemented Interfaces:

ArrangeableProxyListener, ProxyListener

public class ProxyListenerScript
extends Object
implements ProxyListener

Field Summary

Fields

Modifier and Type	Field and Description
static int	PROXY_LISTENER_ORDER

Constructor Summary

Constructors

Constructor and Description
ProxyListenerScript(ExtensionScript extension)

Method Summary

Modifier and Type	Method and Description
int	getArrangeableListenerOrder() Gets the order of when this listener should be notified.
boolean	onHttpRequestSend(HttpMessage msg) Notifies the listener that a new request was received from the client and is ready to be forwarded to the server.
boolean	onHttpResponseReceive(HttpMessage msg) Notifies the listener that a new response was received from the server and is ready to be forwarded to the client.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PROXY_LISTENER_ORDER

public static final int PROXY_LISTENER_ORDER

See Also:

Constant Field Values

Constructor Detail

ProxyListenerScript

public ProxyListenerScript(ExtensionScript extension)

Method Detail

getArrangeableListenerOrder

public int getArrangeableListenerOrder()

Description copied from interface: ArrangeableProxyListener

Gets the order of when this listener should be notified.

The listeners are ordered in a natural order, the greater the order the later it will be notified.

Note: If two or more listeners have the same order, the order that those listeners will be notified is undefined.

Specified by:

getArrangeableListenerOrder in interface ArrangeableProxyListener

Returns:

an int with the value of the order that this listener should be notified about

onHttpRequestSend

public boolean onHttpRequestSend(HttpMessage msg)

Description copied from interface: ProxyListener

Notifies the listener that a new request was received from the client and is ready to be forwarded to the server.

The HttpMessage msg can be modified (only the request should be modified). If the return value is true the message may be forwarded and the following listeners will be notified, if the value is false the message will not be forwarded and no more listeners will be notified.

Note: In the presence of more than one listener there are no guarantees that:

• the HttpMessage msg is equal to the one forwarded to the server, as the following listeners may modify it;
• the message will really be forwarded to the server, even if the return value is true, as the following listeners may return false.

Specified by:

onHttpRequestSend in interface ProxyListener

Parameters:

msg - the HttpMessage that may be forwarded to the server

Returns:

true if the message should be forwarded to the server, false otherwise

onHttpResponseReceive

public boolean onHttpResponseReceive(HttpMessage msg)

Description copied from interface: ProxyListener

Notifies the listener that a new response was received from the server and is ready to be forwarded to the client.

The HttpMessage msg can be modified (only the response should be modified). If the return value is true the message may be forwarded and the following listeners will be notified, if the value is false the message will not be forwarded and no more listeners will be notified.

Note: In the presence of more than one listener there are no guarantees that:

• the HttpMessage msg is equal to the one forwarded to the client, as the following listeners may modify it;
• the message will really be forwarded to the client, even if the return value is true, as the following listeners may return false.

Specified by:

onHttpResponseReceive in interface ProxyListener

Parameters:

msg - the HttpMessage that may be forwarded to the client

Returns:

true if the message should be forwarded to the client, false otherwise