# All Classes and Interfaces

Class
Description
AbstractConnectionDebug
Access
The class to handle the HTTP Access Logs, patterns and the major functionality.
Access.AcceptCharSetElement
write the Accept Character Set Element - %S
Access.AcceptElement
write the Accept Element - %C
Access.AcceptEncodingElement
write the Accept Encoding Element - %e
Access.AcceptLanguageElement
write the Accept Language Element - %L
Access.AccessLogElement
AccessLogElement writes the partial message into the buffer.
Access.ByteSentElement
write bytes sent, excluding HTTP headers - %b, %B
Access.ConnectionElement
write the Connection Element - %x
Access.ContentEncodingElement
write the Content Encoding Element - %n
Access.ContentTypeElement
write the Content Type Element - %T
Access.CookieElement
write a specific cookie - %{xxx}c
Access.HeaderElement
write incoming headers - %{xxx}i
Access.HostElement
write remote host name - %h
Access.HttpStatusCodeElement
write HTTP status code of the response - %s
Access.KeepAliveElement
write the Keep Alive Element - %k
Access.LocalAddrElement
write local IP address - %A
Access.LocalServerNameElement
write local server name - %v
Access.LogicalUserNameElement
write remote logical username from identd (always returns '-') - %l
Access.MethodElement
write request method (GET, POST, etc.) - %m
Access.RefererElement
write the referer - %f
Access.RequestAttributeElement
write an attribute in the ServletRequest - %{xxx}r %R
Access.RequestElement
write first line of the request (method and request URI) - %r
Access.RequestURIElement
write requested URL path - %U
Access.ResponseHeaderElement
write a specific response header - %{xxx}o
Access.ServerElement
write the Server Element - %Z
Access.StringElement
write any string
Access.TransferEncodingElement
write the Transfer Encoding Element - %E
Access.UserAgentElement
write the user agent - %a
Access.UserElement
write remote user that was authenticated (if any), else '-' - %u
Access.VaryElement
write the Vary Element - %V
AccessConfiguration
Copyright (c) 2015, WSO2 Inc.
AccessConstants
Constants used in the Access Class
AccessHandler
Handles the Access, providing an Access object.
AccessLogger
Class that logs the Http Accesses to the access log files.
AccessTimeUtil
Utility methods related to the Access Time
ActiveConnectionMonitor
ActiveConnectionMonitor
PassThroughTransport ActiveConnectionMonitor
AliasBasedKeyManager
Custom X509KeyManager that selects a specific alias for client and server certificates
Axis2HttpConnectorListener
`PassThroughHttpConnectorListener` receives the `HttpCarbonMessage` coming from the Netty HTTP transport, hands it over to the `HttpRequestWorker` to convert it to `MessageContext` and finally deliver it to the axis engine.
Axis2HttpRequest
Represents an outgoing Axis2 HTTP/s request.
Axis2HttpSSLTransportListener
`Axis2HttpsTransportListener` is the Axis2 Transport Listener implementation for Netty based HTTPs transport.
Axis2HttpSSLTransportSender
`Axis2HttpSSLTransportSender` is the sender class of the HTTP Transport, and it sends out HTTPS outbound requests.
Axis2HttpTargetRespListener
`Axis2HttpTargetRespListener` listens for the response expected for the sent request.
Axis2HttpTransportListener
`Axis2HttpTransportListener` is the Axis2 Transport Listener implementation for HTTP transport based on Netty.
Axis2HttpTransportSender
`Axis2HttpTransportSender` receives the outgoing axis2 `MessageContext`, convert it into a `HttpCarbonMessage` and deliver it to the Http Client connector.
Axis2ServerPushListener
`Axis2ServerPushListener` is the class which listens for HTTP/2 server pushes from the backend.
BaseConfiguration
This class has common configurations for both sender and receiver.
BaseConfiguration
This class has common configurations for both sender and receiver.
BasicHttpEntityPossibleEnclosingRequest
wrapper class for HTTP requests with may or may not contain entity extending org.apache.http.message.BasicHttpEntityEnclosingRequest Added to support body for HTTP DELETE requests
BinaryRelayBuilder
BridgeConstants
`BridgeConstants` contains the constants related to netty axis2 bridge.
BufferFactory
CacheController
CacheControllerMBean
CacheManager
Cache Manager takes care and maintains an LRU cache which implements ManageableCache Interface.
CacheMessageBuilderDispatchandler
CacheUtils
A utility class for HTTP caching related tasks.
CertCache
This is a cache to store a certificate against a unique string (can be a serial number).
CertificatePathValidator
Used to validate the revocation status of a certificate chain acquired from the peer.
CertificateVerificationException
CertificateVerificationManager
Manager class responsible for verifying certificates.
ClientConnectionDebug
A connection debug object would be accumulated during processing, but only made use of if the connection encounters issues during processing.
ClientConnFactory
This custom client connection factory can keep a map of SSLContexts and use the correct SSLContext when connecting to different servers.
ClientConnFactoryBuilder
ClientHandler
The client connection handler.
ClientSSLConfigurationBuilder
Builder class for the Client SSLConfiguration.
ClientSSLSetupHandler
ClientWorker
Performs processing of the HTTP response received for our outgoing request.
ClientWorker
ConfigurationBuilderUtil
ConnectCallback
ConnectionPool
ConnectionsView
ConnectionsView MBean can be used to collect and monitor statistics on HTTP connections created by the NHTTP transport.
ConnectionsView
ConnectionsView MBean can be used to collect and monitor statistics on HTTP connections created by the NHTTP transport.
ConnectionsViewMBean
Provides metrics related to the number of connections created and maintained by the NHTTP transport.
ConnectionsViewMBean
ConnectionTimeoutConfiguration
This class holds the parameters related to control the connection removal.
Constants
ControlledByteBuffer
CRLCache
Since a CRL maps to a CRL URL, the CRLCache should have x509CRL entries against CRL URLs.
CRLVerifier
This is used to verify a certificate is revoked or not by using the Certificate Revocation List published by the CA.
CustomLogSetter
DefaultHttpGetProcessor
Default http Get processor implementation for Synapse.
DefaultProxyAuthenticator
DefaultProxyAuthenticator will be initialized when proxy is configured with http.proxyHost
DefaultStreamInterceptor
Default class implementing the methods of `StreamInterceptor`.
DeferredMessageBuilder
Class DeferredMessageBuilder contains the tools required to build the payload.
DeferredMessageBuilder
DeliveryAgent
This class acts as a gateway for differed delivery of the messages.
DynamicProfileReloader
Abstract class to use as Profile Reloader Subscribers.
DynamicProfileReloaderHolder
Class which holds all DynamicProfileReloaders created.
ErrorCodes
Error codes exposed by this transport.
FileUpdateNotificationHandler
Periodically checks on configuration file updates and notify respective listeners
GzipMessageFormatterDecorator
This is the decorator for message formatter and it is need because there isn't any mechanism that can process the message before formatting is occurred.
HostConnections
This stores connections for a particular host + port.
HttpCoreNIOListener
NIO transport listener for Axis2 based on HttpCore and NIO extensions
HttpCoreNIOMultiSSLListener
HttpCoreNIOSender
NIO transport sender for Axis2 based on HttpCore and NIO extensions
HttpCoreNIOSSLListener
HttpCoreNIOSSLSender
HttpCoreRequestResponseTransport
This interface is a point of control for Axis2 to control the behaviour of a Request-Response transport such as HTTP/s For nhttp, this does not make much of a difference, as we are capable of keeping a socket open and writing to it from a different thread, while letting the initial thread that read the request go free.
HttpGetRequestProcessor
This HTTP transport level interface is used for plugging in different implementations for special processing of some HTTP GET requests.
HttpGetRequestProcessor
This interface is used for plugging in different implementations for special processing of some HTTP GET requests.
HttpGetRequestProcessor
This Passthrough transport level interface is used for plugging in different implementations for special processing of some HTTP GET requests.
HttpMessageHandler
Message handler to handle the messages coming through Netty based HTTP transport.
HttpRequestWorker
`HttpRequestWorker` is the Thread that does the request processing.
HttpRequestWrapper
Wrapper to hold the time stamp and the request
HttpResponseWrapper
Wrapper to hold the time stamp and the Response
HttpServerPushWorker
`HttpServerPushWorker` is the Thread which does the server push processing.
HttpTargetResponseWorker
`HttpTargetResponseWorker` is the Thread which does the response processing.
HttpUtils
Utility class providing HTTP utility methods.
HttpWebSocketInboundEndpointConfiguration
`HttpWebSocketInboundEndpointConfiguration` encapsulates the configurations that are passed from the inbound endpoints to be used when initializing and starting the listener.
HttpWebSocketInboundEndpointHandler
API class to access Pass-Through (HTTP) and WebSocket Core Inbound Endpoint management classes.
IKeyStoreLoader
InvalidConfigurationException
This class is used for handling SSL configuration error which is identify at runtime
IOReactorSharingMode
States of the IOReactor sharing among HTTP Axis2 Listeners and Inbound Endpoints
KeyStoreReloader
KeyStoreReloaderHolder
LatencyCollector
LatencyCollector
Class responsible for collect Latency values per request
LatencyParameter
LatencyParameter
Class responsible for update LatencyParameters
LatencyView
LatencyView provides statistical information related to the latency (overhead) incurred by the Synapse NHTTP transport, when mediating messages back and forth.
LatencyView
LatencyView provides statistical information related to the latency (overhead) incurred by the Synapse NHTTP transport, when mediating messages back and forth.
LatencyViewMBean
Provides metrics related to the latency added by the NHTTP transport while mediating messages through.
LatencyViewMBean
Provides metrics related to the latency added by the NHTTP transport while mediating messages through.
ListenerContext
This class is being used to hold the different runtime objects used by the Listeners
ListenerProfileReloader
Profile re-loader for nhttp and pass-through SSL receivers
LoggingNHttpClientConnection
LoggingNHttpServerConnection
LoggingStreamInterceptor
Sample stream interceptor, which intercepts source and target request to print the stream passing via the engine.
LoggingUtils
ManageableCache
A cache which needs to be managed by CacheManager needs to implement this interface.
ManageableCacheValue
A cache which needs to be managed by a CacheManager should have values which implement this interface.
MBeanRegistrar
MessageDiscardWorker
MessageFormatterDecoratorFactory
Factory for getting Decorator to Message Formatter .
MessageHandler
Message handler for different transports.
MessageHandlerProvider
Provider class for the `MessageHandler`.
MessageUtils
Class MessageUtils contains helper methods that are used to build the payload.
MultiListenerServerIODispatch
Class Responsible for dispatch IOEvents to mapping EventHandler according to InboundEndpoint port
MultiListenerSSLServerIODispatch
MultiSSLProfileReloader
MultiSSLProfileReloaderMBean
NettyConfigPropertyNames
This class contains the names of Netty transport related configuration properties.
NettyConfiguration
This class encapsulates netty transport tuning configurations specified via a configurations file or system properties.
NHttpConfiguration
Store and manage properties that tune the nhttp transport
NhttpConnectionDebugConfig
NhttpConstants
NhttpMetricsCollector
This simple extension of the Axis2 transport MetricsCollector implementation, maintains a ConnectionsView instance, which is updated based on the events fired by the NHTTP transport implementation.
NhttpSharedOutputBuffer
Implementation of the `ContentOutputBuffer` interface that can be shared by multiple threads, usually the I/O dispatch of an I/O reactor and a worker thread.
NhttpUtil
A useful set of utility methods for the HTTP transport
NoValidateCertTrustManager
Trust manager accepting any certificate.
OCSPCache
This is a cache to store OSCP responses against Certificate Serial Number since an OCSP response depends on the certificate.
OCSPVerifier
Used to check if a Certificate is revoked or not by its CA using Online Certificate Status Protocol (OCSP).
PassThroughConfigPNames
Defines configuration parameter names for Pass-through HTTP Transport.
PassThroughConfiguration
This class encapsulates pass-through http transport tuning configurations specified via a configurations file or system properties.
PassThroughConstants
PassThroughCorrelationConfigDataHolder
PassThroughHttpListener
This is the TransportListener listening for incoming connections.
PassThroughHttpMultiSSLListener
PassThroughHttpSender
PassThroughHttpSender for Synapse based on HttpCore and NIO extensions
PassThroughHttpSSLListener
PassThroughHttpSSLSender
PassThroughInboundEndpointHandler
API class for access PassThrough Core Inbound Endpoint management classes
PassThroughListeningIOReactorManager
PassThroughMessageHandler
Message handler to handle the messages coming through Pass-Through transport.
PassThroughNHttpGetProcessor
PassThroughOutboundEndpointHandler
API class for access PassThrough Core outbound management classes
PassThroughSenderManager
Class responsible for handle outBound side shared PassThroughHttpSender
PassThroughSharedListenerConfiguration
This class is a representation of configuration used when creating ListeningIOReactor
PassThroughTransportMetricsCollector
This simple extension of the Axis2 transport MetricsCollector implementation, maintains a ConnectionsView instance, which is updated based on the events fired by the pass-through transport implementation.
PassThroughTransportUtils
Utility methods used by the transport.
PathChecker
This class is used by CertificatePathValidator to check revocation status of the certificate chain.
Pipe
This is a buffer shared by both producers and consumers.
ProfileProxyAuthenticator
ProfileProxyAuthenticator will be initialized when proxy profile is configured
ProtocolState
State of a request or a response in transport receiver or sender is represented in these values.
ProxyAuthenticator
If proxy server is configured with username and password, appropriate implementation of ProxyAuthenticator will be initialised based on the proxy configuration (profile / default)
ProxyConfig
ProxyConfigBuilder
ProxyProfileConfig
Represents a proxy profile configured in the axis2.xml
ProxyTunnelHandler
RelayConstants
RelaySecuirtyMessageBuilderDispatchandler
RelayUtils
ReplayDataWriter
Defines the contract for writing replay data within the HTTP transport layer.
ReplayDispatcher
Singleton manager class responsible for buffering replay data and asynchronously writing it to a configured ReplayDataWriter.
ReplayIOSession
ReplayRecord
Represents a single replay record that encapsulates message content and associated metadata for replay purposes.
RequestDescriptor
RequestResponseUtils
`RequestResponseUtils` contains utilities used in request and response message flow.
RESTUtil
This class provides a set of utility methods to manage the REST invocation calls going out from the nhttp transport in the HTTP GET method
RevocationStatus
RevocationVerifier
All the revocation verifiers should implement this interface.
RouteRequestMapping
Scheme
SecureVaultValueReader
This class provides the functionality to read the value from SecureVault.
SenderProfileReloader
Profile re-loader for nhttp and pass-through SSL senders
ServerConnectionDebug
A connection debug object would be accumulated during request processing, but only made use of if the connection encounters issues during processing.
ServerConnFactory
ServerConnFactoryBuilder
ServerHandler
The server connection handler.
ServerIODispatch
ServerIODispatch
ServerSSLSetupHandler
ServerWorker
Processes an incoming request through Axis2.
ServerWorker
This is a worker thread for executing an incoming request in to the transport.
SessionContextUtil
This manages session context in the message context
SourceConfiguration
This class stores the configurations specific to the Listener.
SourceConfiguration
This class stores configurations specific to the Listeners
SourceConnections
Keeps track of the connections coming in to the transport.
SourceContext
This class represents the information about a TCP Connection at a given point in time.
SourceHandler
This is the class where transport interacts with the client.
SourceRequest
Represents a Http Request.
SourceResponse
SourceResponseFactory
SourceResponseHandler
`SourceResponseHandler` have utilities for creating and preparing an outbound response to be sent to the HTTP client.
SSLClientAuth
SSLConfiguration
`SSLConfiguration` encapsulates the transport level security related configurations.
SSLConfiguration
SSLConfiguration.SSLConfigurationBuilder
Builder class for the SSLConfiguration.
SSLConnectionUtils
SSLContextDetails
SSLProfileInvoker
SSL Profile Invoker which is used with JMX support for Dynamic Profile Re-loading
SSLProfileInvokerMBean
JMX Compliant MBean interface for SSL Profile Invoker
SSLProfileLoader
Interface to be implemented by all SSL senders and listeners in order to receive notifications on config file changes at runtime
SslSenderTrustStoreHolder
The SSL Sender TrustStore Holder class to store the client trust store's configurable details.
SSLServerConnFactoryBuilder
StreamingOnRequestDataSource
This class has a special flag, which says this is it's last use and not to cache data if it did not have done so already.
StreamInterceptor
Interface For Stream Interceptors
StreamInterceptorsLoader
SynapseBackEndWireLogs
This class holds wirelog information per mediator
SynapseDebugInfoHolder
This class is to hold debug information for wire level debug in transport level
SynapseHTTPRequestFactory
SynapseWireLogHolder
This class is used to store wirelog information for all the relevant mediators and request wirelog, response wirelog as well
SynapseWireLogHolder.PHASE
These are the phases to determine request responses in wire level
SynapseWireLogHolder.RequestType
TargetConfiguration
This class stores the configurations specific to the Sender.
TargetConfiguration
This class stores configuration specific to HTTP Connectors (Senders)
TargetConnections
Manages the connection from transport to the back end servers.
TargetContext
When a connection is created, an object of this class is stored in the Connection Context.
TargetErrorHandler
`TargetErrorHandler` will report back failure to the message receiver.
TargetErrorHandler
TargetHandler
This class is handling events from the transport -- > client.
TargetRequest
This is a class for representing a request to be sent to a target.
TargetRequestFactory
TargetRequestHandler
`TargetRequestHandler` have utilities for creating and preparing an outbound request to be sent to the backend service.
TargetResponse
This class represents a response coming from the target server.
TraceMessageBuilderDispatchHandler
This enables the persist full in come message for SOAP tracing facility provided
TransportView
TransportViewMBean
TrustStoreHolder
A data holder class to store the client trust store.
UpgradableNHttpConnection
WorkerState
State of workers in pass-through transport.
WSAddressingHandler