httpRedirector (HTTP Redirector)

An HTTP redirector gives out HTTP code 302 redirection notices in response to HTTP requests, but only according to certain rules. This stateful behaviour, if matching to the provided host header, can redirect elsewhere.

The new location is a mandatory field.

class names

scala: code.data.HttpRedirectorFactory
javascript: code_data_HttpRedirectorFactory

aliases

httpRedirect redirector redirect

config

{"categories":[{"defaultCollapsed":true,"fields":["poolSize","sharedPoolName","streamType","mutualReentranceKey","nonReentrant","killOnStop","orchestrationTimeout","orchestratorName","env","isRunning","runOnlyOnHosts","runOnlyOnRanks","runOnlyOnRoles","deepDiagnostics","startupPriority"],"name":"Advanced Run Configuration"}],"fieldName":"httpRedirector","fields":[{"default":302,"fieldName":"httpRedirector.statusCode","hidden":false,"hideLabel":false,"name":"statusCode","readonly":false,"renderStrategies":[],"type":"I","validators":[]},{"default":null,"fieldName":"httpRedirector.runOnlyOnRanks","hidden":false,"hideLabel":false,"itemType":{"default":null,"fieldName":"httpRedirector.runOnlyOnRanks.runOnlyOnRanks","hidden":false,"hideLabel":false,"name":"runOnlyOnRanks","readonly":false,"renderStrategies":[],"type":"I","validators":[]},"name":"runOnlyOnRanks","readonly":false,"renderStrategies":[],"type":"A"},{"default":null,"fieldName":"httpRedirector.name","hidden":false,"hideLabel":false,"name":"name","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":"httpRedirector","fieldName":"httpRedirector.classPath","hidden":false,"hideLabel":false,"name":"classPath","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":null,"fieldName":"httpRedirector.bundle","hidden":false,"hideLabel":false,"name":"bundle","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":null,"fieldName":"httpRedirector.mutualReentrancyKey","hidden":false,"hideLabel":false,"name":"mutualReentrancyKey","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":"","fieldName":"httpRedirector.path","hidden":false,"hideLabel":false,"name":"path","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":"collecting","fieldName":"httpRedirector.streamType","hidden":false,"hideLabel":false,"name":"streamType","readonly":false,"renderStrategies":[],"type":"S","validators":[{"choices":["collecting","eager","forgetful"],"displayOverride":{},"rule":"choices","unenforced":false}]},{"default":false,"fieldName":"httpRedirector.deepDiagnostics","hidden":false,"hideLabel":false,"name":"deepDiagnostics","readonly":false,"renderStrategies":[],"type":"B","validators":[]},{"default":null,"fieldName":"httpRedirector.runOnlyOnRoles","hidden":false,"hideLabel":false,"itemType":{"default":null,"fieldName":"httpRedirector.runOnlyOnRoles.runOnlyOnRoles","hidden":false,"hideLabel":false,"name":"runOnlyOnRoles","readonly":false,"renderStrategies":[],"type":"S","validators":[{"choices":["frontend","backend","viewer"],"displayOverride":{},"rule":"choices","unenforced":false}]},"name":"runOnlyOnRoles","readonly":false,"renderStrategies":[],"type":"A"},{"default":"","fieldName":"httpRedirector.description","hidden":false,"hideLabel":false,"name":"description","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":false,"fieldName":"httpRedirector.stateful","hidden":false,"hideLabel":false,"name":"stateful","readonly":false,"renderStrategies":[],"type":"B","validators":[]},{"bindingHint":"the size of the threadpool. If this is set to a positive number, this trigger will use a dedicated threadpool. If this is set to zero or less, it will use the default shared threadpool.","canReference":true,"default":null,"fieldName":"httpRedirector.poolSize","hidden":false,"hideLabel":false,"label":"threadpool size","name":"poolSize","readonly":false,"renderStrategies":[],"type":"I","validators":[]},{"default":false,"fieldName":"httpRedirector.nonReentrant","hidden":false,"hideLabel":false,"name":"nonReentrant","readonly":false,"renderStrategies":[],"type":"B","validators":[]},{"default":null,"fieldName":"httpRedirector.orchestratorName","hidden":false,"hideLabel":false,"name":"orchestratorName","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"bindingHint":"If this trigger is set to use a dedicated threadpool (using the poolSize attribute), then this name will override which threadpool this trigger uses. By default, triggers using dedicated threadpools will use a threadpool each, but if you set multiple triggers with the same name and pool size, they will share that pool.","canReference":true,"default":null,"fieldName":"httpRedirector.sharedPoolName","hidden":false,"hideLabel":false,"label":"shared threadpool","name":"sharedPoolName","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":"${generatedId}","fieldName":"httpRedirector.id","hidden":false,"hideLabel":false,"name":"id","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":null,"fieldName":"httpRedirector.newLoc","hidden":false,"hideLabel":false,"name":"newLoc","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"bindingHint":"This is the order of startup when multiple stateful behaviours are being started at the same time. This is usually when a recipe is being run, or a bundle is being loaded, but is especially relevant when the server is being started.","default":400,"fieldName":"httpRedirector.startupPriority","hidden":false,"hideLabel":false,"name":"startupPriority","readonly":false,"renderStrategies":[],"type":"I","validators":[{"max":449.0,"min":350.0,"rule":"numberRange"}]},{"default":null,"fieldName":"httpRedirector.runOnlyOnHosts","hidden":false,"hideLabel":false,"itemType":{"default":null,"fieldName":"httpRedirector.runOnlyOnHosts.runOnlyOnHosts","hidden":false,"hideLabel":false,"name":"runOnlyOnHosts","readonly":false,"renderStrategies":[],"type":"S","validators":[]},"name":"runOnlyOnHosts","readonly":false,"renderStrategies":[],"type":"A"},{"default":false,"fieldName":"httpRedirector.isRunning","hidden":false,"hideLabel":false,"name":"isRunning","readonly":false,"renderStrategies":[],"type":"B","validators":[]},{"default":false,"fieldName":"httpRedirector.killOnStop","hidden":false,"hideLabel":false,"name":"killOnStop","readonly":false,"renderStrategies":[],"type":"B","validators":[]},{"default":null,"fieldName":"httpRedirector.excludedQueryParams","hidden":false,"hideLabel":false,"itemType":{"default":null,"fieldName":"httpRedirector.excludedQueryParams.excludedQueryParams","hidden":false,"hideLabel":false,"name":"excludedQueryParams","readonly":false,"renderStrategies":[],"type":"S","validators":[]},"name":"excludedQueryParams","readonly":false,"renderStrategies":[],"type":"A"},{"canReference":false,"default":180000,"fieldName":"httpRedirector.orchestrationTimeout","hidden":false,"hideLabel":false,"label":"Orchestration Timeout","name":"orchestrationTimeout","readonly":false,"renderStrategies":[{"config":{"precision":3,"timeUnit":"ms"},"type":"valueAsTimeSpan"}],"type":"L","validators":[]},{"default":"statefulBehaviour","fieldName":"httpRedirector.type","hidden":false,"hideLabel":false,"name":"type","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":null,"fieldName":"httpRedirector.env","hidden":false,"hideLabel":false,"name":"env","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":"","fieldName":"httpRedirector.hostHeader","hidden":false,"hideLabel":false,"name":"hostHeader","readonly":false,"renderStrategies":[],"type":"S","validators":[]}],"hidden":false,"hideLabel":false,"label":"Triggerer Configuration","name":"httpRedirector","readonly":false,"renderStrategies":[],"type":"O"}