A B C D E F H I L M O P R S T W
All Classes All Packages

A

address() - Method in interface com.hsbc.cranker.mucranker.DarkHost

allow(String) - Method in interface com.hsbc.cranker.mucranker.IPValidator

Called when a connector attempts to register a route to this router.

AllowAll - Static variable in interface com.hsbc.cranker.mucranker.IPValidator

A validator that allows all IP addresses to connect

B

bytesReceived() - Method in interface com.hsbc.cranker.mucranker.ProxyInfo

bytesSent() - Method in interface com.hsbc.cranker.mucranker.ProxyInfo

C

collectInfo() - Method in interface com.hsbc.cranker.mucranker.CrankerRouter

Gets meta data about the connected services.

com.hsbc.cranker.mucranker - package com.hsbc.cranker.mucranker

componentName() - Method in interface com.hsbc.cranker.mucranker.ConnectorService

connections() - Method in interface com.hsbc.cranker.mucranker.ConnectorInstance

ConnectorConnection - Interface in com.hsbc.cranker.mucranker

Information about one of the connector sockets connected to this router.

ConnectorInstance - Interface in com.hsbc.cranker.mucranker

Information about a connector instance that is connected to this router.

connectorInstanceID() - Method in interface com.hsbc.cranker.mucranker.ConnectorInstance

connectorInstanceID() - Method in interface com.hsbc.cranker.mucranker.ProxyInfo

connectors() - Method in interface com.hsbc.cranker.mucranker.ConnectorService

ConnectorService - Interface in com.hsbc.cranker.mucranker

Information about a service that is connected to this router.

crankerRouter() - Static method in class com.hsbc.cranker.mucranker.CrankerRouterBuilder

CrankerRouter - Interface in com.hsbc.cranker.mucranker

This class creates MuHandler instances for receiving HTTP requests from clients, and a handler for receiving websocket registrations from cranker connectors.

CrankerRouterBuilder - Class in com.hsbc.cranker.mucranker

Use CrankerRouterBuilder.crankerRouter() to create a builder where you can configure your cranker router options.

CrankerRouterBuilder() - Constructor for class com.hsbc.cranker.mucranker.CrankerRouterBuilder

create(InetAddress, Instant, String) - Static method in interface com.hsbc.cranker.mucranker.DarkHost

Creates a new dark host

createHttpHandler() - Method in interface com.hsbc.cranker.mucranker.CrankerRouter

Creates the handler that receives HTTP requests from clients and then forwards them on to connectors.

createRegistrationHandler() - Method in interface com.hsbc.cranker.mucranker.CrankerRouter

Creates the endpoint that cranker connectors connect to.

D

DarkHost - Interface in com.hsbc.cranker.mucranker

A host that does not have requests forwarded to it.

darkHosts() - Method in interface com.hsbc.cranker.mucranker.DarkModeManager

The current dark hosts.

darkHosts() - Method in interface com.hsbc.cranker.mucranker.RouterInfo

darkMode() - Method in interface com.hsbc.cranker.mucranker.ConnectorInstance

darkModeManager() - Method in interface com.hsbc.cranker.mucranker.CrankerRouter

DarkModeManager - Interface in com.hsbc.cranker.mucranker

This class allows you to block certain hosts from receiving requests.

dateEnabled() - Method in interface com.hsbc.cranker.mucranker.DarkHost

disableDarkMode(DarkHost) - Method in interface com.hsbc.cranker.mucranker.DarkModeManager

Removes the target from the set of blocked hosts.

durationMillis() - Method in interface com.hsbc.cranker.mucranker.ProxyInfo

E

enableDarkMode(DarkHost) - Method in interface com.hsbc.cranker.mucranker.DarkModeManager

Specifies that the given target destination should not have any requests sent to it.

errorIfAny() - Method in interface com.hsbc.cranker.mucranker.ProxyInfo

If the response was not proxied successfully, then this has the exception.

F

FavIconHandler - Class in com.hsbc.cranker.mucranker

This is a convenience class to make it easy to serve a favicon.ico file for your router.

findHost(InetAddress) - Method in interface com.hsbc.cranker.mucranker.DarkModeManager

Finds the host associated with the given address, if it is in dark mode.

fromClassPath(String) - Static method in class com.hsbc.cranker.mucranker.FavIconHandler

Creates a Mu Handler that serves a favicon file.

H

handle(MuRequest, MuResponse) - Method in class com.hsbc.cranker.mucranker.FavIconHandler

I

idleConnectionCount() - Method in interface com.hsbc.cranker.mucranker.CrankerRouter

ip() - Method in interface com.hsbc.cranker.mucranker.ConnectorInstance

IPValidator - Interface in com.hsbc.cranker.mucranker

A validator that can be used to secure registration requests.

isCatchAll() - Method in interface com.hsbc.cranker.mucranker.ConnectorService

isCatchAll() - Method in interface com.hsbc.cranker.mucranker.ProxyInfo

L

LongestFirstRouteResolver - Class in com.hsbc.cranker.mucranker

A route resolver which using the longest route to match from the existing routes.

LongestFirstRouteResolver() - Constructor for class com.hsbc.cranker.mucranker.LongestFirstRouteResolver

M

muCrankerVersion() - Static method in interface com.hsbc.cranker.mucranker.CrankerRouter

O

onAfterProxyToTargetHeadersSent(ProxyInfo, Headers) - Method in interface com.hsbc.cranker.mucranker.ProxyListener

This is called if async method which used to send request headers has already called.

onAfterTargetToProxyHeadersReceived(ProxyInfo, int, Headers) - Method in interface com.hsbc.cranker.mucranker.ProxyListener

This is called if response headers has already received from target

onBeforeProxyToTarget(ProxyInfo, Headers) - Method in interface com.hsbc.cranker.mucranker.ProxyListener

This is called before sending a request to the target service

onBeforeRespondingToClient(ProxyInfo) - Method in interface com.hsbc.cranker.mucranker.ProxyListener

This is called before sending the response to the client.

onComplete(ProxyInfo) - Method in interface com.hsbc.cranker.mucranker.ProxyListener

This is called after a response has been completed.

onFailureToAcquireProxySocket(ProxyInfo) - Method in interface com.hsbc.cranker.mucranker.ProxyListener

This is called if a free socket could not be found for the target in which case: ProxyInfo.bytesReceived() will be 0. ProxyInfo.bytesSent() will be 0. ProxyInfo.connectorInstanceID() will be null. ProxyInfo.serviceAddress() will be null. ProxyInfo.errorIfAny() will be null.

onRequestBodyChunkSentToTarget(ProxyInfo, ByteBuffer) - Method in interface com.hsbc.cranker.mucranker.ProxyListener

Called when a chunk of request body data is sent to the target This will be called many times if the body has been fragmented

onRequestBodySentToTarget(ProxyInfo) - Method in interface com.hsbc.cranker.mucranker.ProxyListener

Called when the full request body has been received to the target

onResponseBodyChunkReceived(ProxyInfo) - Method in interface com.hsbc.cranker.mucranker.ProxyListener

Called when the full response body has been received from the target

onResponseBodyChunkReceivedFromTarget(ProxyInfo, ByteBuffer) - Method in interface com.hsbc.cranker.mucranker.ProxyListener

Called when a chunk of response body data is received from the target This will be called many times if the body has been fragmented

P

port() - Method in interface com.hsbc.cranker.mucranker.ConnectorConnection

proxyHostHeader(boolean) - Method in class com.hsbc.cranker.mucranker.CrankerRouterBuilder

Specifies whether or not to send the original Host header to the target server.

ProxyInfo - Interface in com.hsbc.cranker.mucranker

Information about a proxied request and response.

ProxyListener - Interface in com.hsbc.cranker.mucranker

Hooks to intercept, change and observe the proxying of requests from a client to a target and back.

R

reason() - Method in interface com.hsbc.cranker.mucranker.DarkHost

An optional description of why this host is in dark mode.

request() - Method in interface com.hsbc.cranker.mucranker.ProxyInfo

resolve(Set<String>, String) - Method in class com.hsbc.cranker.mucranker.LongestFirstRouteResolver

Algorithm: using the longest route to match from the existing routes.

resolve(Set<String>, String) - Method in interface com.hsbc.cranker.mucranker.RouteResolver

resolve the route which will decide which connector socket to be used

response() - Method in interface com.hsbc.cranker.mucranker.ProxyInfo

responseBodyFrames() - Method in interface com.hsbc.cranker.mucranker.ProxyInfo

Response bodies are sent from a connector to the router as a number of binary websocket frames.

route() - Method in interface com.hsbc.cranker.mucranker.ConnectorService

route() - Method in interface com.hsbc.cranker.mucranker.ProxyInfo

RouteResolver - Interface in com.hsbc.cranker.mucranker

Algorithm for resolving route, which will decide which connector socket to be used.

RouterInfo - Interface in com.hsbc.cranker.mucranker

Information about a cranker router

S

sameHost(InetAddress) - Method in interface com.hsbc.cranker.mucranker.DarkHost

Returns true if the given address matches this host

service(String) - Method in interface com.hsbc.cranker.mucranker.RouterInfo

Finds the service with the given route

serviceAddress() - Method in interface com.hsbc.cranker.mucranker.ProxyInfo

services() - Method in interface com.hsbc.cranker.mucranker.RouterInfo

socketID() - Method in interface com.hsbc.cranker.mucranker.ConnectorConnection

socketWaitInMillis() - Method in interface com.hsbc.cranker.mucranker.ProxyInfo

start() - Method in class com.hsbc.cranker.mucranker.CrankerRouterBuilder

stop() - Method in interface com.hsbc.cranker.mucranker.CrankerRouter

Disconnects all sockets and cleans up.

T

toMap() - Method in interface com.hsbc.cranker.mucranker.ConnectorConnection

toMap() - Method in interface com.hsbc.cranker.mucranker.ConnectorInstance

toMap() - Method in interface com.hsbc.cranker.mucranker.ConnectorService

toMap() - Method in interface com.hsbc.cranker.mucranker.DarkHost

Creates a map object holding the address, date and reason.

toMap() - Method in interface com.hsbc.cranker.mucranker.RouterInfo

A map containing the state of the router.

W

waitingTasks() - Method in interface com.hsbc.cranker.mucranker.RouterInfo

A map containing the tasks, which are waiting for available connector sockets

withConnectorMaxWaitInMillis(long) - Method in class com.hsbc.cranker.mucranker.CrankerRouterBuilder

When a request is made for a route that has no connectors connected currently, the router will wait for a period to see if a connector will connect that can service the request.

withDiscardClientForwardedHeaders(boolean) - Method in class com.hsbc.cranker.mucranker.CrankerRouterBuilder

If true, then any Forwarded or X-Forwarded-* headers that are sent from the client to this reverse proxy will be dropped (defaults to false).

withIdleTimeout(long, TimeUnit) - Method in class com.hsbc.cranker.mucranker.CrankerRouterBuilder

Sets the idle timeout.

withPingSentAfterNoWritesFor(int, TimeUnit) - Method in class com.hsbc.cranker.mucranker.CrankerRouterBuilder

Sets the amount of time to wait before sending a ping message if no messages having been sent.

withProxyListeners(List<ProxyListener>) - Method in class com.hsbc.cranker.mucranker.CrankerRouterBuilder

Registers proxy listeners to be called before, during and after requests are processed.

withRegistrationIpValidator(IPValidator) - Method in class com.hsbc.cranker.mucranker.CrankerRouterBuilder

Sets the IP validator for service registration requests.

withRouteResolver(RouteResolver) - Method in class com.hsbc.cranker.mucranker.CrankerRouterBuilder

Customized route resolver.

withRoutesKeepTime(long, TimeUnit) - Method in class com.hsbc.cranker.mucranker.CrankerRouterBuilder

Sets the routes keep time if no more connector registered.

withSendLegacyForwardedHeaders(boolean) - Method in class com.hsbc.cranker.mucranker.CrankerRouterBuilder

Mucranker always sends Forwarded headers, however by default does not send the non-standard X-Forwarded-* headers.

withSupportedCrankerProtocols(List<String>) - Method in class com.hsbc.cranker.mucranker.CrankerRouterBuilder

Set cranker protocols.

withViaName(String) - Method in class com.hsbc.cranker.mucranker.CrankerRouterBuilder

The name to add as the Via header, which defaults to muc.

A B C D E F H I L M O P R S T W
All Classes All Packages