org.zaproxy.clientapi.gen

Class Websocket

java.lang.Object

org.zaproxy.clientapi.gen.Websocket

public class Websocket
extends java.lang.Object

This file was automatically generated.

Constructor Summary

Constructors

Constructor and Description
Websocket(ClientApi api)

Method Summary

Modifier and Type	Method and Description
ApiResponse	breakTextMessage() Returns a text representation of an intercepted websockets message
ApiResponse	channels() Returns all of the registered web socket channels
ApiResponse	message(java.lang.String channelid, java.lang.String messageid) Returns full details of the message specified by the channelId and messageId
ApiResponse	messages(java.lang.String channelid, java.lang.String start, java.lang.String count, java.lang.String payloadpreviewlength) Returns a list of all of the messages that meet the given criteria (all optional), where channelId is a channel identifier, start is the offset to start returning messages from (starting from 0), count is the number of messages to return (default no limit) and payloadPreviewLength is the maximum number bytes to return for the payload contents
ApiResponse	sendTextMessage(java.lang.String channelid, java.lang.String outgoing, java.lang.String message) Sends the specified message on the channel specified by channelId, if outgoing is 'True' then the message will be sent to the server and if it is 'False' then it will be sent to the client
ApiResponse	setBreakTextMessage(java.lang.String message, java.lang.String outgoing) Sets the text message for an intercepted websockets message

Methods inherited from class java.lang.Object

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

Constructor Detail

Websocket

public Websocket(ClientApi api)

Method Detail

channels

public ApiResponse channels()
                     throws ClientApiException

Returns all of the registered web socket channels

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

message

public ApiResponse message(java.lang.String channelid,
                           java.lang.String messageid)
                    throws ClientApiException

Returns full details of the message specified by the channelId and messageId

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

messages

public ApiResponse messages(java.lang.String channelid,
                            java.lang.String start,
                            java.lang.String count,
                            java.lang.String payloadpreviewlength)
                     throws ClientApiException

Returns a list of all of the messages that meet the given criteria (all optional), where channelId is a channel identifier, start is the offset to start returning messages from (starting from 0), count is the number of messages to return (default no limit) and payloadPreviewLength is the maximum number bytes to return for the payload contents

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

breakTextMessage

public ApiResponse breakTextMessage()
                             throws ClientApiException

Returns a text representation of an intercepted websockets message

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

sendTextMessage

public ApiResponse sendTextMessage(java.lang.String channelid,
                                   java.lang.String outgoing,
                                   java.lang.String message)
                            throws ClientApiException

Sends the specified message on the channel specified by channelId, if outgoing is 'True' then the message will be sent to the server and if it is 'False' then it will be sent to the client

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

setBreakTextMessage

public ApiResponse setBreakTextMessage(java.lang.String message,
                                       java.lang.String outgoing)
                                throws ClientApiException

Sets the text message for an intercepted websockets message

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException