/*
* 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.synapse.transport.nhttp;
public class NhttpConstants {
public static final String TRUE = "TRUE";
/**
* A message context property indicating "TRUE", if a transport or the message builder
* has information that the current message is a fault (e.g. SOAP faults, non-HTTP 2xx, etc)
*/
public static final String FAULT_MESSAGE = "FAULT_MESSAGE"; // corresponds with BaseConstants
public static final String FAULTS_AS_HTTP_200 = "FAULTS_AS_HTTP_200";
public static final String SC_ACCEPTED = "SC_ACCEPTED";
public static final String HTTP_SC = "HTTP_SC";
/** Reason Phrase can be used to override the default English reason phrases for HTTP status codes
* Default reason codes and phrases are defined in RFC1945 (HTTP/1.0), RFC2616 (HTTP/1.1)
*/
public static final String HTTP_REASON_PHRASE = "HTTP_REASON_PHRASE";
public static final String FORCE_HTTP_1_0 = "FORCE_HTTP_1.0";
public static final String FORCE_HTTP_CONTENT_LENGTH = "FORCE_HTTP_CONTENT_LENGTH";
public static final String COPY_CONTENT_LENGTH_FROM_INCOMING =
"COPY_CONTENT_LENGTH_FROM_INCOMING";
public static final String DISABLE_CHUNKING = "DISABLE_CHUNKING";
public static final String POST_TO_URI = "POST_TO_URI";
public static final String NO_KEEPALIVE = "NO_KEEPALIVE";
public static final String DISABLE_KEEPALIVE = "http.connection.disable.keepalive";
public static final String IGNORE_SC_ACCEPTED = "IGNORE_SC_ACCEPTED";
public static final String FORCE_SC_ACCEPTED = "FORCE_SC_ACCEPTED";
public static final String DISCARD_ON_COMPLETE = "DISCARD_ON_COMPLETE";
public static final String MESSAGE_TYPE= "messageType";
public static final String ORIGINAL_MESSAGE_TYPE = "originalMessageType";
public static final String MC_CONTENT_TYPE = "ContentType";
public static final String WSDL_EPR_PREFIX = "WSDLEPRPrefix";
public static final String REMOTE_HOST ="REMOTE_HOST";
public static final String BIND_ADDRESS = "bind-address";
public static final String SERVICE_URI_LOCATION = "ServiceURI";
public static final String EPR_TO_SERVICE_NAME_MAP = "service.epr.map";
public static final String NON_BLOCKING_TRANSPORT = "NonBlockingTransport";
public static final String SERIALIZED_BYTES = "SerializedBytes";
public static final String REQUEST_READ = "REQUEST_READ";
public static final String CONTENT_TYPE = "CONTENT_TYPE";
public static final String REQUEST_CONTENT_TYPE = "DEFAULT_REQUEST_CONTENT_TYPE";
public static final String DEFAULT_CONTENT_TYPE = "application/octet-stream";
public static final String SEND_TIMEOUT = "SEND_TIMEOUT";
public static final String HIDDEN_SERVICE_PARAM_NAME = "hiddenService";
/** An Axis2 message context property indicating a transport send failure */
public static final String SENDING_FAULT = "SENDING_FAULT";
/** The message context property name which holds the error code for the last encountered exception */
public static final String ERROR_CODE = "ERROR_CODE";
/** The MC property name which holds the error message for the last encountered exception */
public static final String ERROR_MESSAGE = "ERROR_MESSAGE";
/** The message context property name which holds the error detail (stack trace) for the last encountered exception */
public static final String ERROR_DETAIL = "ERROR_DETAIL";
/** The message context property name which holds the exception (if any) for the last encountered exception */
public static final String ERROR_EXCEPTION = "ERROR_EXCEPTION";
/** Defines weather synapse needs to preserve the original User-Agent header. Configures
* through nhttp.properties file or via a system property
* */
public static final String USER_AGENT_HEADER_PRESERVE = "http.user.agent.preserve";
/** Defines weather synapse needs to preserve the original Server header. Configures
* through nhttp.properties file or via a system property
* */
public static final String SERVER_HEADER_PRESERVE = "http.server.preserve";
/**
* Defines weather synapse needs to preserve the original Http headers. Configures
* through nhttp.properties file
*/
public static final String HTTP_HEADERS_PRESERVE = "http.headers.preserve";
/** Denotes a connection close is forced if set at the NhttpContext */
public static final String FORCE_CLOSING = "forceClosing";
/** Denotes a message is being processed by the current connection if this is set at the context */
public static final String MESSAGE_IN_FLIGHT = "message-in-flight";
// ********** DO NOT CHANGE THESE UNLESS CORRESPONDING SYNAPSE CONSTANT ARE CHANGED ************
public static final int RCV_IO_ERROR_SENDING = 101000;
public static final int RCV_IO_ERROR_RECEIVING = 101001;
public static final int SND_IO_ERROR_SENDING = 101500;
public static final int SND_IO_ERROR_RECEIVING = 101501;
public static final int CONNECTION_FAILED = 101503;
public static final int CONNECTION_TIMEOUT = 101504;
public static final int CONNECTION_CLOSED = 101505;
public static final int PROTOCOL_VIOLATION = 101506;
public static final int CONNECT_CANCEL = 101507;
public static final int CONNECT_TIMEOUT = 101508;
public static final int SEND_ABORT = 101509;
public static final int RESPONSE_PROCESSING_FAILURE = 101510;
// ********** DO NOT CHANGE THESE UNLESS CORRESPONDING SYNAPSE CONSTANT ARE CHANGED ************
public static final String REST_URL_POSTFIX = "REST_URL_POSTFIX";
public static final String SERVICE_PREFIX = "SERVICE_PREFIX";
public static final String HTTP_REQ_METHOD = "HTTP_REQ_METHOD";
public static final String NO_ENTITY_BODY = "NO_ENTITY_BODY";
public static final String ENDPOINT_PREFIX = "ENDPOINT_PREFIX";
protected static final String PRIORITY_CONFIG_FILE_NAME = "priorityConfigFile";
/* This is a workaround for axis2 RestUtils behaviour */
public static final String REST_REQUEST_CONTENT_TYPE = "synapse.internal.rest.contentType";
/** This constant is used to hold the open connections map in the ConfigurationContext*/
public static final String OPEN_CONNNECTIONS_MAP = "OPEN_CONNNECTIONS_MAP";
/** Configuration in nhttp.properties file for enable connection counting */
public static final String COUNT_CONNECTIONS = "http.count.connections";
public static final String REQ_ARRIVAL_TIME = "REQ_ARRIVAL_TIME";
public static final String REQ_DEPARTURE_TIME = "REQ_DEPARTURE_TIME";
public static final String RES_ARRIVAL_TIME = "RES_ARRIVAL_TIME";
public static final String RES_HEADER_ARRIVAL_TIME = "RES_HEADER_ARRIVAL_TIME";
public static final String RES_DEPARTURE_TIME = "RES_DEPARTURE_TIME";
public static final String REQ_FROM_CLIENT_READ_START_TIME = "REQ_FROM_CLIENT_READ_START_TIME";
public static final String REQ_FROM_CLIENT_READ_END_TIME = "REQ_FROM_CLIENT_READ_END_TIME";
public static final String REQ_TO_BACKEND_WRITE_START_TIME = "REQ_TO_BACKEND_WRITE_START_TIME";
public static final String REQ_TO_BACKEND_WRITE_END_TIME = "REQ_TO_BACKEND_WRITE_END_TIME";
public static final String RES_FROM_BACKEND_READ_START_TIME = "RES_FROM_BACKEND_READ_START_TIME";
public static final String RES_FROM_BACKEND_READ_END_TIME = "RES_FROM_BACKEND_READ_END_TIME";
public static final String RES_TO_CLIENT_WRITE_START_TIME = "RES_TO_CLIENT_WRITE_START_TIME";
public static final String RES_TO_CLIENT_WRITE_END_TIME = "RES_TO_CLIENT_WRITE_END_TIME";
public static final String SERVER_WORKER_INIT_TIME = "SERVER_WORKER_INIT_TIME";
public static final String SERVER_WORKER_START_TIME = "SERVER_WORKER_START_TIME";
public static final String CLIENT_WORKER_INIT_TIME = "CLIENT_WORKER_INIT_TIME";
public static final String CLIENT_WORKER_START_TIME = "CLIENT_WORKER_START_TIME";
public static final String CLIENT_REMOTE_ADDR = "CLIENT_REMOTE_ADDR";
public static final String CLIENT_REMOTE_PORT = "CLIENT_REMOTE_PORT";
/**
* This is a name of a parameter in transportReceiver. If set it will disable service
* dispatching inside the transport for rest messages
* */
public static final String DISABLE_REST_SERVICE_DISPATCHING = "disableRestServiceDispatching";
/** Input stream of the message is set to this message context property */
public static final String NHTTP_INPUT_STREAM = "nhttp.input.stream";
/** Output stram of the message is set to this message context property */
public static final String NHTTP_OUTPUT_STREAM = "nhttp.output.stream";
/**
* A message context property indicating "TRUE", This will set on success scenarios
*/
public static final String HTTP_202_RECEIVED = "HTTP_202_RECEIVED";
/** This constant is used to plugin a custom WSDL processor for Get requests*/
public static final String HTTP_GET_PROCESSOR = "httpGetProcessor";
/** Use to flag a connection close */
public static final String FORCE_CONNECTION_CLOSE = "FORCE_CONNECTION_CLOSE";
public static final String PORT_OFFSET = "portOffset";
/** Ref X-Forwaded-For header*/
public static final String HEADER_X_FORWARDED_FOR = "X-Forwarded-For";
/** Ref X-Originating-IP Form 1*/
public static final String HEADER_X_ORIGINATING_IP_FORM_1 = "X-Originating-IP";
/** Ref X-Originating-IP Form 1*/
public static final String HEADER_X_ORIGINATING_IP_FORM_2 = "X-IP";
/**
* This holds a MultiValue Map, which keeps transport headers' values other than last value
* (in order they appear) against the transport header.
*/
public static final String EXCESS_TRANSPORT_HEADERS = "EXCESS_TRANSPORT_HEADERS";
/** This property can be used to set the HOST header sent from the client to synapse */
public static final String REQUEST_HOST_HEADER = "REQUEST_HOST_HEADER";
/**
* nhttp property that must be defined in nhttp.properties to set receiver timeout
* and sender timeout.
*/
public static final String SO_TIMEOUT_RECEIVER = "http.socket.timeout.receiver";
public static final String SO_TIMEOUT_SENDER = "http.socket.timeout.sender";
public static final String SERVER_WORKER_THREAD_ID = "SERVER_WORKER_THREAD_ID";
/**
* Default minimum interval which checks any configuration file updates for Dynamic SSL Profiles
* Default value is one minute in milliseconds.
*/
public static final int DYNAMIC_PROFILE_RELOAD_DEFAULT_INTERVAL = 60000;
/**
* Http method type constants to be used in synapse
*/
public static final String HTTP_HEAD = "HEAD";
/**
* Used to keep backend responses content length
*/
public static final String ORIGINAL_CONTENT_LEN = "ORIGINAL_CONTENT_LENGTH";
/**
* Holds the method type of the incoming request
*/
public static final String HTTP_REQUEST_METHOD = "HTTP_REQUEST_METHOD";
/**
* X509 certificate chain for Mutual SSL connections
*/
public static final String SSL_CLIENT_AUTH_CERT_X509 = "ssl.client.auth.cert.X509";
/**
* axis2 configuration to enable Mutual SSL - verify client's certificate
*/
public static final String SSL_VERIFY_CLIENT = "SSLVerifyClient";
public static final String DISTRIBUTED_TRANSACTION = "distributedTx";
public static final String DISTRIBUTED_TRANSACTION_MANAGER = "distributedTxMgr";
/**
* Proxy profile target host identification. This is the same value as the passthru constant
*/
public static final String PROXY_PROFILE_TARGET_HOST = "PROXY_PROFILE_TARGET_HOST";
}