Package org.keycloak.url

Class DefaultHostnameProvider

java.lang.Object

org.keycloak.url.DefaultHostnameProvider

All Implemented Interfaces:

Provider, HostnameProvider

public class DefaultHostnameProvider
extends Object
implements HostnameProvider

Constructor Summary

Constructors

Constructor	Description
DefaultHostnameProvider(KeycloakSession session, URI frontendUri, URI adminUri, boolean forceBackendUrlToFrontendUrl)

Method Summary

Modifier and Type	Method	Description
String	getContextPath(jakarta.ws.rs.core.UriInfo originalUriInfo, UrlType type)	Returns the context-path for Keycloak.
String	getHostname(jakarta.ws.rs.core.UriInfo originalUriInfo, UrlType type)	Returns the host.
int	getPort(jakarta.ws.rs.core.UriInfo originalUriInfo, UrlType type)	Returns the port (or -1 for default port).
String	getScheme(jakarta.ws.rs.core.UriInfo originalUriInfo, UrlType type)	Returns the URL scheme.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.keycloak.urls.HostnameProvider

close, getContextPath, getHostname, getPort, getScheme

Constructor Details

DefaultHostnameProvider

public DefaultHostnameProvider(KeycloakSession session,
 URI frontendUri,
 URI adminUri,
 boolean forceBackendUrlToFrontendUrl)

Method Details

getScheme

public String getScheme(jakarta.ws.rs.core.UriInfo originalUriInfo,
 UrlType type)

Description copied from interface: HostnameProvider

Returns the URL scheme. If not implemented will delegate to HostnameProvider.getScheme(UriInfo).

Specified by:

getScheme in interface HostnameProvider

Parameters:

originalUriInfo - the original URI

type - type of the request

Returns:

the schema

getHostname

public String getHostname(jakarta.ws.rs.core.UriInfo originalUriInfo,
 UrlType type)

Description copied from interface: HostnameProvider

Returns the host. If not implemented will delegate to HostnameProvider.getHostname(UriInfo).

Specified by:

getHostname in interface HostnameProvider

Parameters:

originalUriInfo - the original URI

type - type of the request

Returns:

the host

getPort

public int getPort(jakarta.ws.rs.core.UriInfo originalUriInfo,
 UrlType type)

Description copied from interface: HostnameProvider

Returns the port (or -1 for default port). If not implemented will delegate to HostnameProvider.getPort(UriInfo)

Specified by:

getPort in interface HostnameProvider

Parameters:

originalUriInfo - the original URI

type - type of the request

Returns:

the port

getContextPath

public String getContextPath(jakarta.ws.rs.core.UriInfo originalUriInfo,
 UrlType type)

Description copied from interface: HostnameProvider

Returns the context-path for Keycloak. This is useful when Keycloak is exposed on a different context-path on a reverse proxy. If not implemented will delegate to HostnameProvider.getContextPath(UriInfo)

Specified by:

getContextPath in interface HostnameProvider

Parameters:

originalUriInfo - the original URI

type - type of the request

Returns:

the context-path