org.zaproxy.clientapi.gen.deprecated.HttpSessionsDeprecated 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
Java implementation to access OWASP ZAP API.
There is a newer version: 1.14.0
/*
 * 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.deprecated;

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;

/** API implementation with deprecated methods, (re)moved from generated class. */
@SuppressWarnings("javadoc")
public class HttpSessionsDeprecated {

    private final ClientApi api;

    public HttpSessionsDeprecated(ClientApi api) {
        this.api = api;
    }

    /**
     * @deprecated (1.1.0) Use the method without the API key and use one of the {@code ClientApi}
     *     constructors that allow to set the API key (e.g. {@link ClientApi#ClientApi(String, int,
     *     String)}).
     */
    @Deprecated
    public ApiResponse createEmptySession(String apikey, String site, String session)
            throws ClientApiException {
        Map map = new HashMap<>();
        if (apikey != null) {
            map.put("apikey", apikey);
        }
        map.put("site", site);
        if (session != null) {
            map.put("session", session);
        }
        return api.callApi("httpSessions", "action", "createEmptySession", map);
    }

    /**
     * @deprecated (1.1.0) Use the method without the API key and use one of the {@code ClientApi}
     *     constructors that allow to set the API key (e.g. {@link ClientApi#ClientApi(String, int,
     *     String)}).
     */
    @Deprecated
    public ApiResponse removeSession(String apikey, String site, String session)
            throws ClientApiException {
        Map map = new HashMap<>();
        if (apikey != null) {
            map.put("apikey", apikey);
        }
        map.put("site", site);
        map.put("session", session);
        return api.callApi("httpSessions", "action", "removeSession", map);
    }

    /**
     * @deprecated (1.1.0) Use the method without the API key and use one of the {@code ClientApi}
     *     constructors that allow to set the API key (e.g. {@link ClientApi#ClientApi(String, int,
     *     String)}).
     */
    @Deprecated
    public ApiResponse setActiveSession(String apikey, String site, String session)
            throws ClientApiException {
        Map map = new HashMap<>();
        if (apikey != null) {
            map.put("apikey", apikey);
        }
        map.put("site", site);
        map.put("session", session);
        return api.callApi("httpSessions", "action", "setActiveSession", map);
    }

    /**
     * @deprecated (1.1.0) Use the method without the API key and use one of the {@code ClientApi}
     *     constructors that allow to set the API key (e.g. {@link ClientApi#ClientApi(String, int,
     *     String)}).
     */
    @Deprecated
    public ApiResponse unsetActiveSession(String apikey, String site) throws ClientApiException {
        Map map = new HashMap<>();
        if (apikey != null) {
            map.put("apikey", apikey);
        }
        map.put("site", site);
        return api.callApi("httpSessions", "action", "unsetActiveSession", map);
    }

    /**
     * @deprecated (1.1.0) Use the method without the API key and use one of the {@code ClientApi}
     *     constructors that allow to set the API key (e.g. {@link ClientApi#ClientApi(String, int,
     *     String)}).
     */
    @Deprecated
    public ApiResponse addSessionToken(String apikey, String site, String sessiontoken)
            throws ClientApiException {
        Map map = new HashMap<>();
        if (apikey != null) {
            map.put("apikey", apikey);
        }
        map.put("site", site);
        map.put("sessionToken", sessiontoken);
        return api.callApi("httpSessions", "action", "addSessionToken", map);
    }

    /**
     * @deprecated (1.1.0) Use the method without the API key and use one of the {@code ClientApi}
     *     constructors that allow to set the API key (e.g. {@link ClientApi#ClientApi(String, int,
     *     String)}).
     */
    @Deprecated
    public ApiResponse removeSessionToken(String apikey, String site, String sessiontoken)
            throws ClientApiException {
        Map map = new HashMap<>();
        if (apikey != null) {
            map.put("apikey", apikey);
        }
        map.put("site", site);
        map.put("sessionToken", sessiontoken);
        return api.callApi("httpSessions", "action", "removeSessionToken", map);
    }

    /**
     * @deprecated (1.1.0) Use the method without the API key and use one of the {@code ClientApi}
     *     constructors that allow to set the API key (e.g. {@link ClientApi#ClientApi(String, int,
     *     String)}).
     */
    @Deprecated
    public ApiResponse setSessionTokenValue(
            String apikey, String site, String session, String sessiontoken, String tokenvalue)
            throws ClientApiException {
        Map map = new HashMap<>();
        if (apikey != null) {
            map.put("apikey", apikey);
        }
        map.put("site", site);
        map.put("session", session);
        map.put("sessionToken", sessiontoken);
        map.put("tokenValue", tokenvalue);
        return api.callApi("httpSessions", "action", "setSessionTokenValue", map);
    }

    /**
     * @deprecated (1.1.0) Use the method without the API key and use one of the {@code ClientApi}
     *     constructors that allow to set the API key (e.g. {@link ClientApi#ClientApi(String, int,
     *     String)}).
     */
    @Deprecated
    public ApiResponse renameSession(
            String apikey, String site, String oldsessionname, String newsessionname)
            throws ClientApiException {
        Map map = new HashMap<>();
        if (apikey != null) {
            map.put("apikey", apikey);
        }
        map.put("site", site);
        map.put("oldSessionName", oldsessionname);
        map.put("newSessionName", newsessionname);
        return api.callApi("httpSessions", "action", "renameSession", map);
    }
}