NhttpConstants (Apache Synapse 3.0.1 API)

java.lang.Object
- org.apache.synapse.transport.nhttp.NhttpConstants

public class NhttpConstants
extends Object

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`BIND_ADDRESS`
`static String`	`CLIENT_REMOTE_ADDR`
`static String`	`CLIENT_REMOTE_PORT`
`static int`	`CONNECT_CANCEL`
`static int`	`CONNECT_TIMEOUT`
`static int`	`CONNECTION_CLOSED`
`static int`	`CONNECTION_FAILED`
`static int`	`CONNECTION_TIMEOUT`
`static String`	`CONTENT_TYPE`
`static String`	`COPY_CONTENT_LENGTH_FROM_INCOMING`
`static String`	`COUNT_CONNECTIONS` Configuration in nhttp.properties file for enable connection counting
`static String`	`DEFAULT_CONTENT_TYPE`
`static String`	`DISABLE_CHUNKING`
`static String`	`DISABLE_KEEPALIVE`
`static String`	`DISABLE_REST_SERVICE_DISPATCHING` This is a name of a parameter in transportReceiver.
`static String`	`DISCARD_ON_COMPLETE`
`static String`	`ENDPOINT_PREFIX`
`static String`	`ENDPOINTS_CONFIGURATION`
`static String`	`EPR_TO_SERVICE_NAME_MAP`
`static String`	`ERROR_CODE` The message context property name which holds the error code for the last encountered exception
`static String`	`ERROR_DETAIL` The message context property name which holds the error detail (stack trace) for the last encountered exception
`static String`	`ERROR_EXCEPTION` The message context property name which holds the exception (if any) for the last encountered exception
`static String`	`ERROR_MESSAGE` The MC property name which holds the error message for the last encountered exception
`static String`	`EXCESS_TRANSPORT_HEADERS` This holds a MultiValue Map, which keeps transport headers' values other than last value (in order they appear) against the transport header.
`static String`	`FAULT_MESSAGE` A message context property indicating "TRUE", if a transport or the message builder has information that the current message is a fault (e.g.
`static String`	`FAULTS_AS_HTTP_200`
`static String`	`FORCE_CLOSING` Denotes a connection close is forced if set at the NhttpContext
`static String`	`FORCE_CONNECTION_CLOSE` Use to flag a connection close
`static String`	`FORCE_HTTP_1_0`
`static String`	`FORCE_HTTP_CONTENT_LENGTH`
`static String`	`FORCE_SC_ACCEPTED`
`static String`	`HEADER_X_FORWARDED_FOR`
`static String`	`HIDDEN_SERVICE_PARAM_NAME`
`static String`	`HTTP_202_RECEIVED` A message context property indicating "TRUE", This will set on success scenarios
`static String`	`HTTP_GET_PROCESSOR` This constant is used to plugin a custom WSDL processor for Get requests
`static String`	`HTTP_HEADERS_PRESERVE` Defines weather synapse needs to preserve the original Http headers.
`static String`	`HTTP_REQ_METHOD`
`static String`	`HTTP_SC`
`static String`	`IGNORE_SC_ACCEPTED`
`static String`	`MESSAGE_IN_FLIGHT` Denotes a message is being processed by the current connection if this is set at the context
`static String`	`NHTTP_INPUT_STREAM` Input stream of the message is set to this message context property
`static String`	`NHTTP_LOG_DIRECTORY`
`static String`	`NHTTP_OUTPUT_STREAM` Output stram of the message is set to this message context property
`static String`	`NHTTP_PROPERTIES` The name of the system property used to specify/override the nhttp properties location
`static String`	`NO_ENTITY_BODY`
`static String`	`NO_KEEPALIVE`
`static String`	`NON_BLOCKING_TRANSPORT`
`static String`	`OPEN_CONNNECTIONS_MAP` This constant is used to hold the open connections map in the ConfigurationContext
`static String`	`PORT_OFFSET`
`static String`	`POST_TO_URI`
`protected static String`	`PRIORITY_CONFIG_FILE_NAME`
`static int`	`PROTOCOL_VIOLATION`
`static int`	`RCV_IO_ERROR_RECEIVING`
`static int`	`RCV_IO_ERROR_SENDING`
`static String`	`REMOTE_HOST`
`static String`	`REQ_ARRIVAL_TIME`
`static String`	`REQ_DEPARTURE_TIME`
`static String`	`REQUEST_CONTENT_TYPE`
`static String`	`REQUEST_HOST_HEADER` This property can be used to set the HOST header sent from the client to synapse
`static String`	`REQUEST_READ`
`static String`	`RES_ARRIVAL_TIME`
`static String`	`RES_DEPARTURE_TIME`
`static String`	`RES_HEADER_ARRIVAL_TIME`
`static int`	`RESPONSE_PROCESSING_FAILURE`
`static String`	`REST_REQUEST_CONTENT_TYPE`
`static String`	`REST_URL_POSTFIX`
`static String`	`SC_ACCEPTED`
`static int`	`SEND_ABORT`
`static String`	`SEND_TIMEOUT`
`static String`	`SENDING_FAULT` An Axis2 message context property indicating a transport send failure
`static String`	`SERIALIZED_BYTES`
`static String`	`SERVER_HEADER_PRESERVE` Defines weather synapse needs to preserve the original Server header.
`static String`	`SERVICE_PREFIX`
`static String`	`SERVICE_URI_LOCATION`
`static int`	`SND_IO_ERROR_RECEIVING`
`static int`	`SND_IO_ERROR_SENDING`
`static String`	`SO_TIMEOUT_RECEIVER` nhttp property that must be defined in nhttp.properties to set receiver timeout and sender timeout.
`static String`	`SO_TIMEOUT_SENDER`
`static String`	`TRUE`
`static String`	`USER_AGENT_HEADER_PRESERVE` Defines weather synapse needs to preserve the original User-Agent header.
`static String`	`WSDL_EPR_PREFIX`

Constructor Summary

Constructors
Constructor and Description

NhttpConstants()

Constructors
Constructor and Description
`NhttpConstants()`

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - TRUE
```
public static final String TRUE
```
    See Also:
    
    Constant Field Values
  - FAULT_MESSAGE
```
public static final String FAULT_MESSAGE
```
    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)
    
    See Also:
    
    Constant Field Values
  - FAULTS_AS_HTTP_200
```
public static final String FAULTS_AS_HTTP_200
```
    See Also:
    
    Constant Field Values
  - SC_ACCEPTED
```
public static final String SC_ACCEPTED
```
    See Also:
    
    Constant Field Values
  - HTTP_SC
```
public static final String HTTP_SC
```
    See Also:
    
    Constant Field Values
  - FORCE_HTTP_1_0
```
public static final String FORCE_HTTP_1_0
```
    See Also:
    
    Constant Field Values
  - FORCE_HTTP_CONTENT_LENGTH
```
public static final String FORCE_HTTP_CONTENT_LENGTH
```
    See Also:
    
    Constant Field Values
  - COPY_CONTENT_LENGTH_FROM_INCOMING
```
public static final String COPY_CONTENT_LENGTH_FROM_INCOMING
```
    See Also:
    
    Constant Field Values
  - DISABLE_CHUNKING
```
public static final String DISABLE_CHUNKING
```
    See Also:
    
    Constant Field Values
  - POST_TO_URI
```
public static final String POST_TO_URI
```
    See Also:
    
    Constant Field Values
  - NO_KEEPALIVE
```
public static final String NO_KEEPALIVE
```
    See Also:
    
    Constant Field Values
  - DISABLE_KEEPALIVE
```
public static final String DISABLE_KEEPALIVE
```
    See Also:
    
    Constant Field Values
  - IGNORE_SC_ACCEPTED
```
public static final String IGNORE_SC_ACCEPTED
```
    See Also:
    
    Constant Field Values
  - FORCE_SC_ACCEPTED
```
public static final String FORCE_SC_ACCEPTED
```
    See Also:
    
    Constant Field Values
  - DISCARD_ON_COMPLETE
```
public static final String DISCARD_ON_COMPLETE
```
    See Also:
    
    Constant Field Values
  - WSDL_EPR_PREFIX
```
public static final String WSDL_EPR_PREFIX
```
    See Also:
    
    Constant Field Values
  - REMOTE_HOST
```
public static final String REMOTE_HOST
```
    See Also:
    
    Constant Field Values
  - BIND_ADDRESS
```
public static final String BIND_ADDRESS
```
    See Also:
    
    Constant Field Values
  - SERVICE_URI_LOCATION
```
public static final String SERVICE_URI_LOCATION
```
    See Also:
    
    Constant Field Values
  - EPR_TO_SERVICE_NAME_MAP
```
public static final String EPR_TO_SERVICE_NAME_MAP
```
    See Also:
    
    Constant Field Values
  - NON_BLOCKING_TRANSPORT
```
public static final String NON_BLOCKING_TRANSPORT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_BYTES
```
public static final String SERIALIZED_BYTES
```
    See Also:
    
    Constant Field Values
  - REQUEST_READ
```
public static final String REQUEST_READ
```
    See Also:
    
    Constant Field Values
  - CONTENT_TYPE
```
public static final String CONTENT_TYPE
```
    See Also:
    
    Constant Field Values
  - REQUEST_CONTENT_TYPE
```
public static final String REQUEST_CONTENT_TYPE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_CONTENT_TYPE
```
public static final String DEFAULT_CONTENT_TYPE
```
    See Also:
    
    Constant Field Values
  - CLIENT_REMOTE_ADDR
```
public static final String CLIENT_REMOTE_ADDR
```
    See Also:
    
    Constant Field Values
  - CLIENT_REMOTE_PORT
```
public static final String CLIENT_REMOTE_PORT
```
    See Also:
    
    Constant Field Values
  - SEND_TIMEOUT
```
public static final String SEND_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - HIDDEN_SERVICE_PARAM_NAME
```
public static final String HIDDEN_SERVICE_PARAM_NAME
```
    See Also:
    
    Constant Field Values
  - SENDING_FAULT
```
public static final String SENDING_FAULT
```
    An Axis2 message context property indicating a transport send failure
    
    See Also:
    
    Constant Field Values
  - ERROR_CODE
```
public static final String ERROR_CODE
```
    The message context property name which holds the error code for the last encountered exception
    
    See Also:
    
    Constant Field Values
  - ERROR_MESSAGE
```
public static final String ERROR_MESSAGE
```
    The MC property name which holds the error message for the last encountered exception
    
    See Also:
    
    Constant Field Values
  - ERROR_DETAIL
```
public static final String ERROR_DETAIL
```
    The message context property name which holds the error detail (stack trace) for the last encountered exception
    
    See Also:
    
    Constant Field Values
  - ERROR_EXCEPTION
```
public static final String ERROR_EXCEPTION
```
    The message context property name which holds the exception (if any) for the last encountered exception
    
    See Also:
    
    Constant Field Values
  - USER_AGENT_HEADER_PRESERVE
```
public static final String USER_AGENT_HEADER_PRESERVE
```
    Defines weather synapse needs to preserve the original User-Agent header. Configures through nhttp.properties file or via a system property
    
    See Also:
    
    Constant Field Values
  - SERVER_HEADER_PRESERVE
```
public static final String SERVER_HEADER_PRESERVE
```
    Defines weather synapse needs to preserve the original Server header. Configures through nhttp.properties file or via a system property
    
    See Also:
    
    Constant Field Values
  - HTTP_HEADERS_PRESERVE
```
public static final String HTTP_HEADERS_PRESERVE
```
    Defines weather synapse needs to preserve the original Http headers. Configures through nhttp.properties file
    
    See Also:
    
    Constant Field Values
  - FORCE_CLOSING
```
public static final String FORCE_CLOSING
```
    Denotes a connection close is forced if set at the NhttpContext
    
    See Also:
    
    Constant Field Values
  - MESSAGE_IN_FLIGHT
```
public static final String MESSAGE_IN_FLIGHT
```
    Denotes a message is being processed by the current connection if this is set at the context
    
    See Also:
    
    Constant Field Values
  - RCV_IO_ERROR_SENDING
```
public static final int RCV_IO_ERROR_SENDING
```
    See Also:
    
    Constant Field Values
  - RCV_IO_ERROR_RECEIVING
```
public static final int RCV_IO_ERROR_RECEIVING
```
    See Also:
    
    Constant Field Values
  - SND_IO_ERROR_SENDING
```
public static final int SND_IO_ERROR_SENDING
```
    See Also:
    
    Constant Field Values
  - SND_IO_ERROR_RECEIVING
```
public static final int SND_IO_ERROR_RECEIVING
```
    See Also:
    
    Constant Field Values
  - CONNECTION_FAILED
```
public static final int CONNECTION_FAILED
```
    See Also:
    
    Constant Field Values
  - CONNECTION_TIMEOUT
```
public static final int CONNECTION_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - CONNECTION_CLOSED
```
public static final int CONNECTION_CLOSED
```
    See Also:
    
    Constant Field Values
  - PROTOCOL_VIOLATION
```
public static final int PROTOCOL_VIOLATION
```
    See Also:
    
    Constant Field Values
  - CONNECT_CANCEL
```
public static final int CONNECT_CANCEL
```
    See Also:
    
    Constant Field Values
  - CONNECT_TIMEOUT
```
public static final int CONNECT_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - SEND_ABORT
```
public static final int SEND_ABORT
```
    See Also:
    
    Constant Field Values
  - RESPONSE_PROCESSING_FAILURE
```
public static final int RESPONSE_PROCESSING_FAILURE
```
    See Also:
    
    Constant Field Values
  - REST_URL_POSTFIX
```
public static final String REST_URL_POSTFIX
```
    See Also:
    
    Constant Field Values
  - SERVICE_PREFIX
```
public static final String SERVICE_PREFIX
```
    See Also:
    
    Constant Field Values
  - HTTP_REQ_METHOD
```
public static final String HTTP_REQ_METHOD
```
    See Also:
    
    Constant Field Values
  - NO_ENTITY_BODY
```
public static final String NO_ENTITY_BODY
```
    See Also:
    
    Constant Field Values
  - ENDPOINT_PREFIX
```
public static final String ENDPOINT_PREFIX
```
    See Also:
    
    Constant Field Values
  - PRIORITY_CONFIG_FILE_NAME
```
protected static final String PRIORITY_CONFIG_FILE_NAME
```
    See Also:
    
    Constant Field Values
  - REST_REQUEST_CONTENT_TYPE
```
public static final String REST_REQUEST_CONTENT_TYPE
```
    See Also:
    
    Constant Field Values
  - OPEN_CONNNECTIONS_MAP
```
public static final String OPEN_CONNNECTIONS_MAP
```
    This constant is used to hold the open connections map in the ConfigurationContext
    
    See Also:
    
    Constant Field Values
  - COUNT_CONNECTIONS
```
public static final String COUNT_CONNECTIONS
```
    Configuration in nhttp.properties file for enable connection counting
    
    See Also:
    
    Constant Field Values
  - REQ_ARRIVAL_TIME
```
public static final String REQ_ARRIVAL_TIME
```
    See Also:
    
    Constant Field Values
  - REQ_DEPARTURE_TIME
```
public static final String REQ_DEPARTURE_TIME
```
    See Also:
    
    Constant Field Values
  - RES_ARRIVAL_TIME
```
public static final String RES_ARRIVAL_TIME
```
    See Also:
    
    Constant Field Values
  - RES_HEADER_ARRIVAL_TIME
```
public static final String RES_HEADER_ARRIVAL_TIME
```
    See Also:
    
    Constant Field Values
  - RES_DEPARTURE_TIME
```
public static final String RES_DEPARTURE_TIME
```
    See Also:
    
    Constant Field Values
  - DISABLE_REST_SERVICE_DISPATCHING
```
public static final String DISABLE_REST_SERVICE_DISPATCHING
```
    This is a name of a parameter in transportReceiver. If set it will disable service dispatching inside the transport for rest messages
    
    See Also:
    
    Constant Field Values
  - NHTTP_INPUT_STREAM
```
public static final String NHTTP_INPUT_STREAM
```
    Input stream of the message is set to this message context property
    
    See Also:
    
    Constant Field Values
  - NHTTP_OUTPUT_STREAM
```
public static final String NHTTP_OUTPUT_STREAM
```
    Output stram of the message is set to this message context property
    
    See Also:
    
    Constant Field Values
  - HTTP_202_RECEIVED
```
public static final String HTTP_202_RECEIVED
```
    A message context property indicating "TRUE", This will set on success scenarios
    
    See Also:
    
    Constant Field Values
  - HTTP_GET_PROCESSOR
```
public static final String HTTP_GET_PROCESSOR
```
    This constant is used to plugin a custom WSDL processor for Get requests
    
    See Also:
    
    Constant Field Values
  - FORCE_CONNECTION_CLOSE
```
public static final String FORCE_CONNECTION_CLOSE
```
    Use to flag a connection close
    
    See Also:
    
    Constant Field Values
  - PORT_OFFSET
```
public static final String PORT_OFFSET
```
    See Also:
    
    Constant Field Values
  - ENDPOINTS_CONFIGURATION
```
public static final String ENDPOINTS_CONFIGURATION
```
    See Also:
    
    Constant Field Values
  - HEADER_X_FORWARDED_FOR
```
public static final String HEADER_X_FORWARDED_FOR
```
    See Also:
    
    Constant Field Values
  - SO_TIMEOUT_RECEIVER
```
public static final String SO_TIMEOUT_RECEIVER
```
    nhttp property that must be defined in nhttp.properties to set receiver timeout and sender timeout.
    
    See Also:
    
    Constant Field Values
  - SO_TIMEOUT_SENDER
```
public static final String SO_TIMEOUT_SENDER
```
    See Also:
    
    Constant Field Values
  - REQUEST_HOST_HEADER
```
public static final String REQUEST_HOST_HEADER
```
    This property can be used to set the HOST header sent from the client to synapse
    
    See Also:
    
    Constant Field Values
  - NHTTP_PROPERTIES
```
public static final String NHTTP_PROPERTIES
```
    The name of the system property used to specify/override the nhttp properties location
    
    See Also:
    
    Constant Field Values
  - NHTTP_LOG_DIRECTORY
```
public static final String NHTTP_LOG_DIRECTORY
```
    See Also:
    
    Constant Field Values
  - EXCESS_TRANSPORT_HEADERS
```
public static final String EXCESS_TRANSPORT_HEADERS
```
    This holds a MultiValue Map, which keeps transport headers' values other than last value (in order they appear) against the transport header.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - NhttpConstants
```
public NhttpConstants()
```

Class NhttpConstants

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TRUE

FAULT_MESSAGE

FAULTS_AS_HTTP_200

SC_ACCEPTED

HTTP_SC

FORCE_HTTP_1_0

FORCE_HTTP_CONTENT_LENGTH

COPY_CONTENT_LENGTH_FROM_INCOMING

DISABLE_CHUNKING

POST_TO_URI

NO_KEEPALIVE

DISABLE_KEEPALIVE

IGNORE_SC_ACCEPTED

FORCE_SC_ACCEPTED

DISCARD_ON_COMPLETE

WSDL_EPR_PREFIX

REMOTE_HOST

BIND_ADDRESS

SERVICE_URI_LOCATION

EPR_TO_SERVICE_NAME_MAP

NON_BLOCKING_TRANSPORT

SERIALIZED_BYTES

REQUEST_READ

CONTENT_TYPE

REQUEST_CONTENT_TYPE

DEFAULT_CONTENT_TYPE

CLIENT_REMOTE_ADDR

CLIENT_REMOTE_PORT

SEND_TIMEOUT

HIDDEN_SERVICE_PARAM_NAME

SENDING_FAULT

ERROR_CODE

ERROR_MESSAGE

ERROR_DETAIL

ERROR_EXCEPTION

USER_AGENT_HEADER_PRESERVE

SERVER_HEADER_PRESERVE

HTTP_HEADERS_PRESERVE

FORCE_CLOSING

MESSAGE_IN_FLIGHT

RCV_IO_ERROR_SENDING

RCV_IO_ERROR_RECEIVING

SND_IO_ERROR_SENDING

SND_IO_ERROR_RECEIVING

CONNECTION_FAILED

CONNECTION_TIMEOUT

CONNECTION_CLOSED

PROTOCOL_VIOLATION

CONNECT_CANCEL

CONNECT_TIMEOUT

SEND_ABORT

RESPONSE_PROCESSING_FAILURE

REST_URL_POSTFIX

SERVICE_PREFIX

HTTP_REQ_METHOD

NO_ENTITY_BODY

ENDPOINT_PREFIX

PRIORITY_CONFIG_FILE_NAME

REST_REQUEST_CONTENT_TYPE

OPEN_CONNNECTIONS_MAP

COUNT_CONNECTIONS

REQ_ARRIVAL_TIME

REQ_DEPARTURE_TIME

RES_ARRIVAL_TIME

RES_HEADER_ARRIVAL_TIME

RES_DEPARTURE_TIME

DISABLE_REST_SERVICE_DISPATCHING

NHTTP_INPUT_STREAM

NHTTP_OUTPUT_STREAM

HTTP_202_RECEIVED

HTTP_GET_PROCESSOR

FORCE_CONNECTION_CLOSE

PORT_OFFSET

ENDPOINTS_CONFIGURATION