org.zaproxy.clientapi.gen.Search Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of zap-clientapi Show documentation
Show all versions of zap-clientapi Show documentation
Java implementation to access ZAP API.
The newest version!
/*
* Zed Attack Proxy (ZAP) and its related class files.
*
* ZAP is an HTTP/HTTPS proxy for assessing web application security.
*
* Copyright 2017 The ZAP Development Team
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.zaproxy.clientapi.gen;
import java.util.HashMap;
import java.util.Map;
import org.zaproxy.clientapi.core.ApiResponse;
import org.zaproxy.clientapi.core.ClientApi;
import org.zaproxy.clientapi.core.ClientApiException;
/** This file was automatically generated. */
@SuppressWarnings("javadoc")
public class Search extends org.zaproxy.clientapi.gen.deprecated.SearchDeprecated {
private final ClientApi api;
public Search(ClientApi api) {
super(api);
this.api = api;
}
/**
* Returns the URLs of the HTTP messages that match the given regular expression in the URL
* optionally filtered by URL and paginated with 'start' position and 'count' of messages.
*/
public ApiResponse urlsByUrlRegex(String regex, String baseurl, String start, String count)
throws ClientApiException {
Map map = new HashMap<>();
map.put("regex", regex);
if (baseurl != null) {
map.put("baseurl", baseurl);
}
if (start != null) {
map.put("start", start);
}
if (count != null) {
map.put("count", count);
}
return api.callApi("search", "view", "urlsByUrlRegex", map);
}
/**
* Returns the URLs of the HTTP messages that match the given regular expression in their
* history Tags optionally filtered by URL and paginated with 'start' position and 'count' of
* messages.
*/
public ApiResponse urlsByTagRegex(String regex, String baseurl, String start, String count)
throws ClientApiException {
Map map = new HashMap<>();
map.put("regex", regex);
if (baseurl != null) {
map.put("baseurl", baseurl);
}
if (start != null) {
map.put("start", start);
}
if (count != null) {
map.put("count", count);
}
return api.callApi("search", "view", "urlsByTagRegex", map);
}
/**
* Returns the URLs of the HTTP messages that match the given regular expression in the request
* optionally filtered by URL and paginated with 'start' position and 'count' of messages.
*/
public ApiResponse urlsByRequestRegex(String regex, String baseurl, String start, String count)
throws ClientApiException {
Map map = new HashMap<>();
map.put("regex", regex);
if (baseurl != null) {
map.put("baseurl", baseurl);
}
if (start != null) {
map.put("start", start);
}
if (count != null) {
map.put("count", count);
}
return api.callApi("search", "view", "urlsByRequestRegex", map);
}
/**
* Returns the URLs of the HTTP messages that match the given regular expression in the response
* optionally filtered by URL and paginated with 'start' position and 'count' of messages.
*/
public ApiResponse urlsByResponseRegex(String regex, String baseurl, String start, String count)
throws ClientApiException {
Map map = new HashMap<>();
map.put("regex", regex);
if (baseurl != null) {
map.put("baseurl", baseurl);
}
if (start != null) {
map.put("start", start);
}
if (count != null) {
map.put("count", count);
}
return api.callApi("search", "view", "urlsByResponseRegex", map);
}
/**
* Returns the URLs of the HTTP messages that match the given regular expression in the
* header(s) optionally filtered by URL and paginated with 'start' position and 'count' of
* messages.
*/
public ApiResponse urlsByHeaderRegex(String regex, String baseurl, String start, String count)
throws ClientApiException {
Map map = new HashMap<>();
map.put("regex", regex);
if (baseurl != null) {
map.put("baseurl", baseurl);
}
if (start != null) {
map.put("start", start);
}
if (count != null) {
map.put("count", count);
}
return api.callApi("search", "view", "urlsByHeaderRegex", map);
}
/**
* Returns the HTTP messages that match the given regular expression in the URL optionally
* filtered by URL and paginated with 'start' position and 'count' of messages.
*/
public ApiResponse messagesByUrlRegex(String regex, String baseurl, String start, String count)
throws ClientApiException {
Map map = new HashMap<>();
map.put("regex", regex);
if (baseurl != null) {
map.put("baseurl", baseurl);
}
if (start != null) {
map.put("start", start);
}
if (count != null) {
map.put("count", count);
}
return api.callApi("search", "view", "messagesByUrlRegex", map);
}
/**
* Returns the HTTP messages that match the given regular expression in their history Tags
* optionally filtered by URL and paginated with 'start' position and 'count' of messages.
*/
public ApiResponse messagesByTagRegex(String regex, String baseurl, String start, String count)
throws ClientApiException {
Map map = new HashMap<>();
map.put("regex", regex);
if (baseurl != null) {
map.put("baseurl", baseurl);
}
if (start != null) {
map.put("start", start);
}
if (count != null) {
map.put("count", count);
}
return api.callApi("search", "view", "messagesByTagRegex", map);
}
/**
* Returns the HTTP messages that match the given regular expression in the request optionally
* filtered by URL and paginated with 'start' position and 'count' of messages.
*/
public ApiResponse messagesByRequestRegex(
String regex, String baseurl, String start, String count) throws ClientApiException {
Map map = new HashMap<>();
map.put("regex", regex);
if (baseurl != null) {
map.put("baseurl", baseurl);
}
if (start != null) {
map.put("start", start);
}
if (count != null) {
map.put("count", count);
}
return api.callApi("search", "view", "messagesByRequestRegex", map);
}
/**
* Returns the HTTP messages that match the given regular expression in the response optionally
* filtered by URL and paginated with 'start' position and 'count' of messages.
*/
public ApiResponse messagesByResponseRegex(
String regex, String baseurl, String start, String count) throws ClientApiException {
Map map = new HashMap<>();
map.put("regex", regex);
if (baseurl != null) {
map.put("baseurl", baseurl);
}
if (start != null) {
map.put("start", start);
}
if (count != null) {
map.put("count", count);
}
return api.callApi("search", "view", "messagesByResponseRegex", map);
}
/**
* Returns the HTTP messages that match the given regular expression in the header(s) optionally
* filtered by URL and paginated with 'start' position and 'count' of messages.
*/
public ApiResponse messagesByHeaderRegex(
String regex, String baseurl, String start, String count) throws ClientApiException {
Map map = new HashMap<>();
map.put("regex", regex);
if (baseurl != null) {
map.put("baseurl", baseurl);
}
if (start != null) {
map.put("start", start);
}
if (count != null) {
map.put("count", count);
}
return api.callApi("search", "view", "messagesByHeaderRegex", map);
}
/**
* Returns the HTTP messages, in HAR format, that match the given regular expression in the URL
* optionally filtered by URL and paginated with 'start' position and 'count' of messages.
*/
public byte[] harByUrlRegex(String regex, String baseurl, String start, String count)
throws ClientApiException {
Map map = new HashMap<>();
map.put("regex", regex);
if (baseurl != null) {
map.put("baseurl", baseurl);
}
if (start != null) {
map.put("start", start);
}
if (count != null) {
map.put("count", count);
}
return api.callApiOther("search", "other", "harByUrlRegex", map);
}
/**
* Returns the HTTP messages, in HAR format, that match the given regular expression in their
* history Tags optionally filtered by URL and paginated with 'start' position and 'count' of
* messages.
*/
public byte[] harByTagRegex(String regex, String baseurl, String start, String count)
throws ClientApiException {
Map map = new HashMap<>();
map.put("regex", regex);
if (baseurl != null) {
map.put("baseurl", baseurl);
}
if (start != null) {
map.put("start", start);
}
if (count != null) {
map.put("count", count);
}
return api.callApiOther("search", "other", "harByTagRegex", map);
}
/**
* Returns the HTTP messages, in HAR format, that match the given regular expression in the
* request optionally filtered by URL and paginated with 'start' position and 'count' of
* messages.
*/
public byte[] harByRequestRegex(String regex, String baseurl, String start, String count)
throws ClientApiException {
Map map = new HashMap<>();
map.put("regex", regex);
if (baseurl != null) {
map.put("baseurl", baseurl);
}
if (start != null) {
map.put("start", start);
}
if (count != null) {
map.put("count", count);
}
return api.callApiOther("search", "other", "harByRequestRegex", map);
}
/**
* Returns the HTTP messages, in HAR format, that match the given regular expression in the
* response optionally filtered by URL and paginated with 'start' position and 'count' of
* messages.
*/
public byte[] harByResponseRegex(String regex, String baseurl, String start, String count)
throws ClientApiException {
Map map = new HashMap<>();
map.put("regex", regex);
if (baseurl != null) {
map.put("baseurl", baseurl);
}
if (start != null) {
map.put("start", start);
}
if (count != null) {
map.put("count", count);
}
return api.callApiOther("search", "other", "harByResponseRegex", map);
}
/**
* Returns the HTTP messages, in HAR format, that match the given regular expression in the
* header(s) optionally filtered by URL and paginated with 'start' position and 'count' of
* messages.
*/
public byte[] harByHeaderRegex(String regex, String baseurl, String start, String count)
throws ClientApiException {
Map map = new HashMap<>();
map.put("regex", regex);
if (baseurl != null) {
map.put("baseurl", baseurl);
}
if (start != null) {
map.put("start", start);
}
if (count != null) {
map.put("count", count);
}
return api.callApiOther("search", "other", "harByHeaderRegex", map);
}
}