com.oracle.bmc.loadbalancer.model

Class RedirectUri

java.lang.Object

com.oracle.bmc.loadbalancer.model.RedirectUri

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20170115")
public final class RedirectUri
extends Object

An object that defines the redirect URI applied to the original request. The object property values compose the redirect URI.

*NOTE:** The Load Balancing service cannot automatically detect or avoid infinite redirects. Be sure to provide meaningful, complete, and correct field values. If any component field of this object has no value, the system retains the value from the incoming HTTP request URI.

For example, if you specify only the protocol field https, and the incoming request URI is http://example.com:8080, the resulting runtime redirect URI is https://example.com:8080. The system retains the host and port from the incoming URI and does not automatically change the port setting from 8080 to 443.

Be sure to configure valid percent-encoding (URL encoding) when needed.

In addition to static string values, you can use the following tokens to construct the redirect URI. These tokens extract values from the incoming HTTP request URI.

{protocol} : The protocol from the incoming HTTP request URI. * {host} : The domain name from the incoming HTTP request URI. * {port} : The port from the incoming HTTP request URI. * {path} : The path from the incoming HTTP request URI. * {query} : The query string from the incoming HTTP request URI.

The tokens are case sensitive. For example, {host} is a valid token, but {HOST} is not.

You can retain the literal characters of a token when you specify values for the path and query properties of the redirect URI. Use a backslash (\\\\) as the escape character for the \\\\, {, and } characters. For example, if the incoming HTTP request URI is /video, the path property value:

/example{path}123\\{path\\}

appears in the constructed redirect URI as:

/example/video123{path}
Note: Objects should always be created or deserialized using the RedirectUri.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the RedirectUri.Builder, which maintain a set of all explicitly set fields called __explicitlySet__. The hashCode() and equals(Object) methods are implemented to take __explicitlySet__ into account. The constructor, on the other hand, does not set __explicitlySet__ (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RedirectUri.Builder

Constructor Summary

Constructors

Constructor and Description
RedirectUri(String protocol, String host, Integer port, String path, String query) Deprecated.

Method Summary

Modifier and Type	Method and Description
static RedirectUri.Builder	builder() Create a new builder.
boolean	equals(Object o)
Set<String>	get__explicitlySet__()
String	getHost() The valid domain name (hostname) or IP address to use in the redirect URI.
String	getPath() The HTTP URI path to use in the redirect URI.
Integer	getPort() The communication port to use in the redirect URI.
String	getProtocol() The HTTP protocol to use in the redirect URI.
String	getQuery() The query string to use in the redirect URI.
int	hashCode()
RedirectUri.Builder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RedirectUri

@ConstructorProperties(value={"protocol","host","port","path","query"})
 @Deprecated
public RedirectUri(String protocol,
                                                                                                        String host,
                                                                                                        Integer port,
                                                                                                        String path,
                                                                                                        String query)

Deprecated.

Method Detail

builder

public static RedirectUri.Builder builder()

Create a new builder.

toBuilder

public RedirectUri.Builder toBuilder()

getProtocol

public String getProtocol()

The HTTP protocol to use in the redirect URI.

When this value is null, not set, or set to {protocol}, the service preserves the original protocol from the incoming HTTP request URI. Allowed values are:

HTTP * HTTPS * {protocol}

{protocol} is the only valid token for this property. It can appear only once in the value string.

Example: HTTPS

getHost

public String getHost()

The valid domain name (hostname) or IP address to use in the redirect URI.

When this value is null, not set, or set to {host}, the service preserves the original domain name from the incoming HTTP request URI.

All RedirectUri tokens are valid for this property. You can use any token more than once.

Curly braces are valid in this property only to surround tokens, such as {host}

Examples:

**example.com** appears as example.com in the redirect URI.

**in{host}** appears as inexample.com in the redirect URI if example.com is the hostname in the incoming HTTP request URI.

**{port}{host}** appears as 8081example.com in the redirect URI if example.com is the hostname and the port is 8081 in the incoming HTTP request URI.

getPort

public Integer getPort()

The communication port to use in the redirect URI.

Valid values include integers from 1 to 65535.

When this value is null, the service preserves the original port from the incoming HTTP request URI.

Example: 8081

getPath

public String getPath()

The HTTP URI path to use in the redirect URI.

When this value is null, not set, or set to {path}, the service preserves the original path from the incoming HTTP request URI. To omit the path from the redirect URI, set this value to an empty string, "".

All RedirectUri tokens are valid for this property. You can use any token more than once.

The path string must begin with / if it does not begin with the {path} token.

Examples:

__/example/video/123__ appears as /example/video/123 in the redirect URI.

__/example{path}__ appears as /example/video/123 in the redirect URI if /video/123 is the path in the incoming HTTP request URI.

__{path}/123__ appears as /example/video/123 in the redirect URI if /example/video is the path in the incoming HTTP request URI.

__{path}123__ appears as /example/video123 in the redirect URI if /example/video is the path in the incoming HTTP request URI.

__/{host}/123__ appears as /example.com/123 in the redirect URI if example.com is the hostname in the incoming HTTP request URI.

__/{host}/{port}__ appears as /example.com/123 in the redirect URI if example.com is the hostname and 123 is the port in the incoming HTTP request URI.

__/{query}__ appears as /lang=en in the redirect URI if the query is lang=en in the incoming HTTP request URI.

getQuery

public String getQuery()

The query string to use in the redirect URI.

When this value is null, not set, or set to {query}, the service preserves the original query parameters from the incoming HTTP request URI.

All RedirectUri tokens are valid for this property. You can use any token more than once.

If the query string does not begin with the {query} token, it must begin with the question mark (?) character.

You can specify multiple query parameters as a single string. Separate each query parameter with an ampersand (&) character. To omit all incoming query parameters from the redirect URI, set this value to an empty string, "".

If the specified query string results in a redirect URI ending with ? or &, the last character is truncated. For example, if the incoming URI is http://host.com:8080/documents and the query property value is ?lang=en&{query}, the redirect URI is http://host.com:8080/documents?lang=en. The system truncates the final ampersand (&) because the incoming URI included no value to replace the {query} token.

Examples: * **lang=en&time_zone=PST** appears as lang=en&time_zone=PST in the redirect URI.

**{query}** appears as lang=en&time_zone=PST in the redirect URI if lang=en&time_zone=PST is the query string in the incoming HTTP request. If the incoming HTTP request has no query parameters, the {query} token renders as an empty string.

**lang=en&{query}&time_zone=PST** appears as lang=en&country=us&time_zone=PST in the redirect URI if country=us is the query string in the incoming HTTP request. If the incoming HTTP request has no query parameters, this value renders as lang=en&time_zone=PST.

**protocol={protocol}&hostname={host}** appears as protocol=http&hostname=example.com in the redirect URI if the protocol is HTTP and the hostname is example.com in the incoming HTTP request.

**port={port}&hostname={host}** appears as port=8080&hostname=example.com in the redirect URI if the port is 8080 and the hostname is example.com in the incoming HTTP request URI.

get__explicitlySet__

public Set<String> get__explicitlySet__()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object