Package org.keycloak.url

Class HostnameV2Provider

java.lang.Object

org.keycloak.url.HostnameV2Provider

All Implemented Interfaces:

Provider, HostnameProvider

public class HostnameV2Provider
extends Object
implements HostnameProvider

Author:

Vaclav Muzikar <vmuzikar@redhat.com>

Constructor Summary

Constructors

Constructor	Description
HostnameV2Provider(KeycloakSession session, String hostname, URI hostnameUrl, URI adminUrl, Boolean backchannelDynamic)

Method Summary

Modifier and Type	Method	Description
String	getContextPath(jakarta.ws.rs.core.UriInfo originalUriInfo)	Returns the context-path for Keycloak This is useful when Keycloak is exposed on a different context-path on a reverse proxy.
String	getContextPath(jakarta.ws.rs.core.UriInfo originalUriInfo, UrlType type)	Returns the context-path for Keycloak.
String	getHostname(jakarta.ws.rs.core.UriInfo originalUriInfo)	Returns the host.
String	getHostname(jakarta.ws.rs.core.UriInfo originalUriInfo, UrlType type)	Returns the host.
int	getPort(jakarta.ws.rs.core.UriInfo originalUriInfo)	Returns the port (or -1 for default port).
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)	Returns the URL scheme.
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

Constructor Details

HostnameV2Provider

public HostnameV2Provider(KeycloakSession session,
 String hostname,
 URI hostnameUrl,
 URI adminUrl,
 Boolean backchannelDynamic)

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

getScheme

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

Description copied from interface: HostnameProvider

Returns the URL scheme. If not implemented will get the scheme from the request.

Specified by:

getScheme in interface HostnameProvider

Parameters:

originalUriInfo - the original URI

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

getHostname

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

Description copied from interface: HostnameProvider

Returns the host. If not implemented will get the host from the request.

Specified by:

getHostname in interface HostnameProvider

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

getPort

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

Description copied from interface: HostnameProvider

Returns the port (or -1 for default port). If not implemented will get the port from the request.

Specified by:

getPort in interface HostnameProvider

Parameters:

originalUriInfo - the original URI

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

getContextPath

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

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 use the context-path from the request, which by default is /auth

Specified by:

getContextPath in interface HostnameProvider

Parameters:

originalUriInfo - the original URI

Returns:

the context-path