RedirectConfiguration Class

Definition

Describes Redirect Route.

public class RedirectConfiguration extends RouteConfiguration
Inheritance
java.lang.Object
RedirectConfiguration

Inherited Members

RouteConfiguration.validate() java.lang.Object.clone() java.lang.Object.equals(java.lang.Object) java.lang.Object.finalize() java.lang.Object.getClass() java.lang.Object.hashCode() java.lang.Object.notify() java.lang.Object.notifyAll() java.lang.Object.toString() java.lang.Object.wait() java.lang.Object.wait(long) java.lang.Object.wait(long,int)

Constructors

RedirectConfiguration()

Methods

customFragment()

Get the customFragment property: Fragment to add to the redirect URL. Fragment is the part of the URL that comes after #. Do not include the #.

customHost()

Get the customHost property: Host to redirect. Leave empty to use the incoming host as the destination host.

customPath()

Get the customPath property: The full path to redirect. Path cannot be empty and must start with /. Leave empty to use the incoming path as destination path.

customQueryString()

Get the customQueryString property: The set of query strings to be placed in the redirect URL. Setting this value would replace any existing query string; leave empty to preserve the incoming query string. Query string must be in = format. The first ? and & will be added automatically so do not include them in the front, but do separate multiple query strings with &.

redirectProtocol()

Get the redirectProtocol property: The protocol of the destination to where the traffic is redirected.

redirectType()

Get the redirectType property: The redirect type the rule will use when redirecting traffic.

validate()

Validates the instance.

withCustomFragment(String customFragment)

Set the customFragment property: Fragment to add to the redirect URL. Fragment is the part of the URL that comes after #. Do not include the #.

withCustomHost(String customHost)

Set the customHost property: Host to redirect. Leave empty to use the incoming host as the destination host.

withCustomPath(String customPath)

Set the customPath property: The full path to redirect. Path cannot be empty and must start with /. Leave empty to use the incoming path as destination path.

withCustomQueryString(String customQueryString)

Set the customQueryString property: The set of query strings to be placed in the redirect URL. Setting this value would replace any existing query string; leave empty to preserve the incoming query string. Query string must be in = format. The first ? and & will be added automatically so do not include them in the front, but do separate multiple query strings with &.

withRedirectProtocol(FrontDoorRedirectProtocol redirectProtocol)

Set the redirectProtocol property: The protocol of the destination to where the traffic is redirected.

withRedirectType(FrontDoorRedirectType redirectType)

Set the redirectType property: The redirect type the rule will use when redirecting traffic.

Applies to