Examples with HTTPArgument org.apache.jmeter.protocol.http.util.HTTPArgument used on opensource projects

Example 6 with HTTPArgument

use of org.apache.jmeter.protocol.http.util.HTTPArgument in project jmeter by apache.

the class HTTPHC4Impl method sendPostData.

// TODO needs cleaning up
/**
     * 
     * @param post {@link HttpPost}
     * @return String posted body if computable
     * @throws IOException if sending the data fails due to I/O
     */
protected String sendPostData(HttpPost post) throws IOException {
    // Buffer to hold the post body, except file content
    StringBuilder postedBody = new StringBuilder(1000);
    HTTPFileArg[] files = getHTTPFiles();
    final String contentEncoding = getContentEncodingOrNull();
    final boolean haveContentEncoding = contentEncoding != null;
    // application/x-www-form-urlencoded post request
    if (getUseMultipartForPost()) {
        // If a content encoding is specified, we use that as the
        // encoding of any parameter values
        Charset charset = null;
        if (haveContentEncoding) {
            charset = Charset.forName(contentEncoding);
        } else {
            charset = MIME.DEFAULT_CHARSET;
        }
        if (log.isDebugEnabled()) {
            log.debug("Building multipart with:getDoBrowserCompatibleMultipart(): {}, with charset:{}, haveContentEncoding:{}", getDoBrowserCompatibleMultipart(), charset, haveContentEncoding);
        }
        // Write the request to our own stream
        MultipartEntityBuilder multipartEntityBuilder = MultipartEntityBuilder.create().setCharset(charset);
        if (getDoBrowserCompatibleMultipart()) {
            multipartEntityBuilder.setLaxMode();
        } else {
            multipartEntityBuilder.setStrictMode();
        }
        // Add any parameters
        for (JMeterProperty jMeterProperty : getArguments()) {
            HTTPArgument arg = (HTTPArgument) jMeterProperty.getObjectValue();
            String parameterName = arg.getName();
            if (arg.isSkippable(parameterName)) {
                continue;
            }
            StringBody stringBody = new StringBody(arg.getValue(), ContentType.create("text/plain", charset));
            FormBodyPart formPart = FormBodyPartBuilder.create(parameterName, stringBody).build();
            multipartEntityBuilder.addPart(formPart);
        }
        // Add any files
        // Cannot retrieve parts once added to the MultiPartEntity, so have to save them here.
        ViewableFileBody[] fileBodies = new ViewableFileBody[files.length];
        for (int i = 0; i < files.length; i++) {
            HTTPFileArg file = files[i];
            File reservedFile = FileServer.getFileServer().getResolvedFile(file.getPath());
            fileBodies[i] = new ViewableFileBody(reservedFile, file.getMimeType());
            multipartEntityBuilder.addPart(file.getParamName(), fileBodies[i]);
        }
        HttpEntity entity = multipartEntityBuilder.build();
        post.setEntity(entity);
        if (entity.isRepeatable()) {
            ByteArrayOutputStream bos = new ByteArrayOutputStream();
            for (ViewableFileBody fileBody : fileBodies) {
                fileBody.hideFileData = true;
            }
            entity.writeTo(bos);
            for (ViewableFileBody fileBody : fileBodies) {
                fileBody.hideFileData = false;
            }
            bos.flush();
            // We get the posted bytes using the encoding used to create it
            postedBody.append(bos.toString(// $NON-NLS-1$ this is the default used by HttpClient
            contentEncoding == null ? // $NON-NLS-1$ this is the default used by HttpClient
            "US-ASCII" : contentEncoding));
            bos.close();
        } else {
            // $NON-NLS-1$
            postedBody.append("<Multipart was not repeatable, cannot view what was sent>");
        }
    //            // Set the content type TODO - needed?
    //            String multiPartContentType = multiPart.getContentType().getValue();
    //            post.setHeader(HEADER_CONTENT_TYPE, multiPartContentType);
    } else {
        // not multipart
        // Check if the header manager had a content type header
        // This allows the user to specify his own content-type for a POST request
        Header contentTypeHeader = post.getFirstHeader(HTTPConstants.HEADER_CONTENT_TYPE);
        boolean hasContentTypeHeader = contentTypeHeader != null && contentTypeHeader.getValue() != null && contentTypeHeader.getValue().length() > 0;
        // TODO: needs a multiple file upload scenerio
        if (!hasArguments() && getSendFileAsPostBody()) {
            // If getSendFileAsPostBody returned true, it's sure that file is not null
            HTTPFileArg file = files[0];
            if (!hasContentTypeHeader) {
                // Allow the mimetype of the file to control the content type
                if (file.getMimeType() != null && file.getMimeType().length() > 0) {
                    post.setHeader(HTTPConstants.HEADER_CONTENT_TYPE, file.getMimeType());
                } else {
                    post.setHeader(HTTPConstants.HEADER_CONTENT_TYPE, HTTPConstants.APPLICATION_X_WWW_FORM_URLENCODED);
                }
            }
            // TODO is null correct?
            FileEntity fileRequestEntity = new FileEntity(new File(file.getPath()), (ContentType) null);
            post.setEntity(fileRequestEntity);
            // We just add placeholder text for file content
            postedBody.append("<actual file content, not shown here>");
        } else {
            // the post body will be encoded in the specified content encoding
            if (haveContentEncoding) {
                post.getParams().setParameter(CoreProtocolPNames.HTTP_CONTENT_CHARSET, contentEncoding);
            }
            // just send all the values as the post body
            if (getSendParameterValuesAsPostBody()) {
                // TODO: needs a multiple file upload scenerio
                if (!hasContentTypeHeader) {
                    HTTPFileArg file = files.length > 0 ? files[0] : null;
                    if (file != null && file.getMimeType() != null && file.getMimeType().length() > 0) {
                        post.setHeader(HTTPConstants.HEADER_CONTENT_TYPE, file.getMimeType());
                    } else {
                        // TODO - is this the correct default?
                        post.setHeader(HTTPConstants.HEADER_CONTENT_TYPE, HTTPConstants.APPLICATION_X_WWW_FORM_URLENCODED);
                    }
                }
                // Just append all the parameter values, and use that as the post body
                StringBuilder postBody = new StringBuilder();
                for (JMeterProperty jMeterProperty : getArguments()) {
                    HTTPArgument arg = (HTTPArgument) jMeterProperty.getObjectValue();
                    // Note: if "Encoded?" is not selected, arg.getEncodedValue is equivalent to arg.getValue
                    if (haveContentEncoding) {
                        postBody.append(arg.getEncodedValue(contentEncoding));
                    } else {
                        postBody.append(arg.getEncodedValue());
                    }
                }
                // Let StringEntity perform the encoding
                StringEntity requestEntity = new StringEntity(postBody.toString(), contentEncoding);
                post.setEntity(requestEntity);
                postedBody.append(postBody.toString());
            } else {
                // Set the content type
                if (!hasContentTypeHeader) {
                    post.setHeader(HTTPConstants.HEADER_CONTENT_TYPE, HTTPConstants.APPLICATION_X_WWW_FORM_URLENCODED);
                }
                // Add the parameters
                PropertyIterator args = getArguments().iterator();
                List<NameValuePair> nvps = new ArrayList<>();
                String urlContentEncoding = contentEncoding;
                if (urlContentEncoding == null || urlContentEncoding.length() == 0) {
                    // Use the default encoding for urls
                    urlContentEncoding = EncoderCache.URL_ARGUMENT_ENCODING;
                }
                while (args.hasNext()) {
                    HTTPArgument arg = (HTTPArgument) args.next().getObjectValue();
                    // The HTTPClient always urlencodes both name and value,
                    // so if the argument is already encoded, we have to decode
                    // it before adding it to the post request
                    String parameterName = arg.getName();
                    if (arg.isSkippable(parameterName)) {
                        continue;
                    }
                    String parameterValue = arg.getValue();
                    if (!arg.isAlwaysEncoded()) {
                        // The value is already encoded by the user
                        // Must decode the value now, so that when the
                        // httpclient encodes it, we end up with the same value
                        // as the user had entered.
                        parameterName = URLDecoder.decode(parameterName, urlContentEncoding);
                        parameterValue = URLDecoder.decode(parameterValue, urlContentEncoding);
                    }
                    // Add the parameter, httpclient will urlencode it
                    nvps.add(new BasicNameValuePair(parameterName, parameterValue));
                }
                UrlEncodedFormEntity entity = new UrlEncodedFormEntity(nvps, urlContentEncoding);
                post.setEntity(entity);
                if (entity.isRepeatable()) {
                    ByteArrayOutputStream bos = new ByteArrayOutputStream();
                    post.getEntity().writeTo(bos);
                    bos.flush();
                    // We get the posted bytes using the encoding used to create it
                    postedBody.append(bos.toString(contentEncoding != null ? contentEncoding : SampleResult.DEFAULT_HTTP_ENCODING));
                    bos.close();
                } else {
                    postedBody.append("<RequestEntity was not repeatable, cannot view what was sent>");
                }
            }
        }
    }
    return postedBody.toString();
}

Example 7 with HTTPArgument

use of org.apache.jmeter.protocol.http.util.HTTPArgument in project jmeter by apache.

the class URLRewritingModifier method modify.

private void modify(HTTPSamplerBase sampler, String value) {
    if (isPathExtension()) {
        if (isPathExtensionNoEquals()) {
            // $NON-NLS-1$
            sampler.setPath(sampler.getPath() + SEMI_COLON + getArgumentName() + value);
        } else {
            // $NON-NLS-1$ // $NON-NLS-2$
            sampler.setPath(sampler.getPath() + SEMI_COLON + getArgumentName() + "=" + value);
        }
    } else {
        sampler.getArguments().removeArgument(getArgumentName());
        sampler.getArguments().addArgument(new HTTPArgument(getArgumentName(), value, !encode()));
    }
}

Example 8 with HTTPArgument

use of org.apache.jmeter.protocol.http.util.HTTPArgument in project jmeter by apache.

the class HTTPSamplerBase method getSendParameterValuesAsPostBody.

/**
     * Determine if none of the parameters have a name, and if that is the case,
     * it means that the parameter values should be sent as the entity body
     *
     * @return {@code true} if there are parameters and none of these have a
     *         name specified, or {@link HTTPSamplerBase#getPostBodyRaw()} returns
     *         {@code true}
     */
public boolean getSendParameterValuesAsPostBody() {
    if (getPostBodyRaw()) {
        return true;
    } else {
        boolean hasArguments = false;
        for (JMeterProperty jMeterProperty : getArguments()) {
            hasArguments = true;
            HTTPArgument arg = (HTTPArgument) jMeterProperty.getObjectValue();
            if (arg.getName() != null && arg.getName().length() > 0) {
                return false;
            }
        }
        return hasArguments;
    }
}

Example 9 with HTTPArgument

use of org.apache.jmeter.protocol.http.util.HTTPArgument in project jmeter by apache.

the class HTTPSamplerBase method replace.

/**
     * Replace by replaceBy in path and body (arguments) properties
     */
@Override
public int replace(String regex, String replaceBy, boolean caseSensitive) throws Exception {
    int totalReplaced = 0;
    for (JMeterProperty jMeterProperty : getArguments()) {
        HTTPArgument arg = (HTTPArgument) jMeterProperty.getObjectValue();
        String value = arg.getValue();
        if (!StringUtils.isEmpty(value)) {
            Object[] result = JOrphanUtils.replaceAllWithRegex(value, regex, replaceBy, caseSensitive);
            // check if there is anything to replace
            int nbReplaced = ((Integer) result[1]).intValue();
            if (nbReplaced > 0) {
                String replacedText = (String) result[0];
                arg.setValue(replacedText);
                totalReplaced += nbReplaced;
            }
        }
    }
    String value = getPath();
    if (!StringUtils.isEmpty(value)) {
        Object[] result = JOrphanUtils.replaceAllWithRegex(value, regex, replaceBy, caseSensitive);
        // check if there is anything to replace
        int nbReplaced = ((Integer) result[1]).intValue();
        if (nbReplaced > 0) {
            String replacedText = (String) result[0];
            setPath(replacedText);
            totalReplaced += nbReplaced;
        }
    }
    if (!StringUtils.isEmpty(getDomain())) {
        Object[] result = JOrphanUtils.replaceAllWithRegex(getDomain(), regex, replaceBy, caseSensitive);
        // check if there is anything to replace
        int nbReplaced = ((Integer) result[1]).intValue();
        if (nbReplaced > 0) {
            String replacedText = (String) result[0];
            setDomain(replacedText);
            totalReplaced += nbReplaced;
        }
    }
    return totalReplaced;
}

Example 10 with HTTPArgument

use of org.apache.jmeter.protocol.http.util.HTTPArgument in project jmeter by apache.

the class HTTPSamplerBase method addEncodedArgument.

/**
     * Creates an HTTPArgument and adds it to the current set {@link #getArguments()} of arguments.
     *
     * @param name - the parameter name
     * @param value - the parameter value
     * @param metaData - normally just '='
     * @param contentEncoding - the encoding, may be null
     */
public void addEncodedArgument(String name, String value, String metaData, String contentEncoding) {
    if (log.isDebugEnabled()) {
        log.debug("adding argument: name: " + name + " value: " + value + " metaData: " + metaData + " contentEncoding: " + contentEncoding);
    }
    HTTPArgument arg;
    final boolean nonEmptyEncoding = !StringUtils.isEmpty(contentEncoding);
    if (nonEmptyEncoding) {
        arg = new HTTPArgument(name, value, metaData, true, contentEncoding);
    } else {
        arg = new HTTPArgument(name, value, metaData, true);
    }
    // Check if there are any difference between name and value and their encoded name and value
    String valueEncoded;
    if (nonEmptyEncoding) {
        try {
            valueEncoded = arg.getEncodedValue(contentEncoding);
        } catch (UnsupportedEncodingException e) {
            // NOSONAR 
            log.warn("Unable to get encoded value using encoding " + contentEncoding);
            valueEncoded = arg.getEncodedValue();
        }
    } else {
        valueEncoded = arg.getEncodedValue();
    }
    // If there is no difference, we mark it as not needing encoding
    if (arg.getName().equals(arg.getEncodedName()) && arg.getValue().equals(valueEncoded)) {
        arg.setAlwaysEncoded(false);
    }
    this.getArguments().addArgument(arg);
}