org.apache.camel.component.http.HttpConstants Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of camel-http Show documentation
Camel HTTP support
The newest version!
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.apache.camel.component.http;

import org.apache.camel.Exchange;
import org.apache.camel.spi.Metadata;
import org.apache.hc.core5.http.ContentType;
import org.apache.hc.core5.http.HttpHeaders;

public final class HttpConstants {

    public static final String CONTENT_TYPE_JAVA_SERIALIZED_OBJECT = "application/x-java-serialized-object";
    public static final ContentType JAVA_SERIALIZED_OBJECT = ContentType.create(CONTENT_TYPE_JAVA_SERIALIZED_OBJECT);
    public static final String CONTENT_TYPE_WWW_FORM_URLENCODED = "application/x-www-form-urlencoded";

    @Metadata(description = "The HTTP content encoding. Is set on both the IN and OUT message to\n" +
                            "provide a content encoding, such as `gzip`.",
              javaType = "String")
    public static final String CONTENT_ENCODING = Exchange.CONTENT_ENCODING;
    @Metadata(description = "The HTTP response code from the external server. Is 200 for OK.", javaType = "int")
    public static final String HTTP_RESPONSE_CODE = Exchange.HTTP_RESPONSE_CODE;
    @Metadata(description = "The HTTP response text from the external server.", javaType = "String")
    public static final String HTTP_RESPONSE_TEXT = Exchange.HTTP_RESPONSE_TEXT;
    @Metadata(label = "producer", description = "URI parameters. Will override existing URI parameters set directly on\n" +
                                                "the endpoint.",
              javaType = "String")
    public static final String HTTP_QUERY = Exchange.HTTP_QUERY;
    @Metadata(label = "producer", description = "The version of the http protocol used.", javaType = "String")
    public static final String HTTP_PROTOCOL_VERSION = Exchange.HTTP_PROTOCOL_VERSION;
    @Metadata(label = "producer", description = "The target host.", javaType = "String")
    public static final String HTTP_HEADER_HOST = HttpHeaders.HOST;
    @Metadata(label = "producer", description = "The rest http URI.", javaType = "String")
    public static final String REST_HTTP_URI = Exchange.REST_HTTP_URI;
    @Metadata(label = "producer", description = "URI to call. Will override existing URI set directly on the endpoint.\n" +
                                                "This uri is the uri of the http server to call. Its not the same as the\n" +
                                                "Camel endpoint uri, where you can configure endpoint options such as\n" +
                                                "security etc. This header does not support that, its only the uri of the\n" +
                                                "http server.",
              javaType = "String")
    public static final String HTTP_URI = Exchange.HTTP_URI;
    @Metadata(label = "producer", description = "Request URI's path, the header will be used to build the request URI\n" +
                                                "with the HTTP_URI.",
              javaType = "String")
    public static final String HTTP_PATH = Exchange.HTTP_PATH;
    @Metadata(label = "producer", description = "The rest http query.", javaType = "String")
    public static final String REST_HTTP_QUERY = Exchange.REST_HTTP_QUERY;
    @Metadata(label = "producer", description = "The http raw query.", javaType = "String")
    public static final String HTTP_RAW_QUERY = "CamelHttpRawQuery";
    @Metadata(label = "producer", description = "The http method to use.",
              javaType = "org.apache.camel.component.http.HttpMethods")
    public static final String HTTP_METHOD = Exchange.HTTP_METHOD;
    @Metadata(description = "The character encoding.", javaType = "String")
    public static final String HTTP_CHARACTER_ENCODING = Exchange.HTTP_CHARACTER_ENCODING;
    @Metadata(description = "The HTTP content type. Is set on both the IN and OUT message to provide\n" +
                            "a content type, such as `text/html`.",
              javaType = "String")
    public static final String CONTENT_TYPE = Exchange.CONTENT_TYPE;

    private HttpConstants() {
    }
}