org.zaproxy.zap.extension.api.ApiResponseElement Maven / Gradle / Ivy

Go to download
/*
 * Zed Attack Proxy (ZAP) and its related class files.
 *
 * ZAP is an HTTP/HTTPS proxy for assessing web application security.
 *
 * Copyright 2012 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.zap.extension.api;

import net.sf.json.JSON;
import net.sf.json.JSONNull;
import net.sf.json.JSONObject;
import org.apache.commons.text.StringEscapeUtils;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.zaproxy.zap.utils.JsonUtil;
import org.zaproxy.zap.utils.XMLStringUtil;

public class ApiResponseElement extends ApiResponse {

    public static final ApiResponseElement OK = new ApiResponseElement("Result", "OK");
    public static final ApiResponseElement FAIL = new ApiResponseElement("Result", "FAIL");

    private String value = null;
    private ApiResponse apiResponse;

    public ApiResponseElement(String name) {
        super(name);
    }

    public ApiResponseElement(String name, String value) {
        super(name);
        this.value = value;
    }

    public ApiResponseElement(ApiResponse value) {
        super(value.getName());
        this.apiResponse = value;
    }

    public ApiResponseElement(Node node, ApiResponse template) {
        super(node.getNodeName());
        this.value = node.getTextContent();
    }

    public ApiResponseElement(Node node) {
        super(node.getNodeName());
        this.value = node.getTextContent();
    }

    public String getValue() {
        return value;
    }

    @Override
    public JSON toJSON() {
        JSONObject jo = new JSONObject();
        if (apiResponse == null) {
            jo.put(
                    this.getName(),
                    this.value == null
                            ? JSONNull.getInstance()
                            : JsonUtil.getJsonFriendlyString(this.value));
        } else {
            // toString() is required to prevent auto conversion of text values to JSON
            jo.put(this.getName(), apiResponse.toJSON().toString());
        }
        return jo;
    }

    @Override
    public void toXML(Document doc, Element parent) {
        if (apiResponse == null) {
            parent.appendChild(
                    doc.createTextNode(
                            getValue() != null
                                    ? XMLStringUtil.escapeControlChrs(this.getValue())
                                    : ""));
        } else {
            apiResponse.toXML(doc, parent);
        }
    }

    @Override
    public void toHTML(StringBuilder sb) {
        if (apiResponse == null) {
            sb.append("\n");
            sb.append("\n");
            sb.append("\n");
            sb.append(StringEscapeUtils.escapeHtml4(this.getName()));
            sb.append(" \n");
            sb.append(StringEscapeUtils.escapeHtml4(this.getValue()));
            sb.append("\n");
        } else {
            apiResponse.toHTML(sb);
        }
    }

    @Override
    public String toString(int indent) {
        StringBuilder sb = new StringBuilder();
        for (int i = 0; i < indent; i++) {
            sb.append("\t");
        }
        sb.append("ApiResponseElement ");
        sb.append(this.getName());
        sb.append(" = ");
        if (apiResponse == null) {
            sb.append(this.getValue());
        } else {
            sb.append(apiResponse.toString(indent + 1));
        }
        sb.append("\n");
        return sb.toString();
    }
}