org.keycloak.admin.client

Class Keycloak

java.lang.Object

org.keycloak.admin.client.Keycloak

public class Keycloak
extends Object

Provides a Keycloak client. By default, this implementation uses a RESTEasy client with the default ResteasyClientBuilder settings. To customize the underling client, use a KeycloakBuilder to create a Keycloak client.

Author:

[email protected]

See Also:

KeycloakBuilder

Method Summary

Modifier and Type	Method and Description
void	close() Closes the underlying client.
static Keycloak	getInstance(String serverUrl, String realm, String username, String password, String clientId)
static Keycloak	getInstance(String serverUrl, String realm, String username, String password, String clientId, String clientSecret)
static Keycloak	getInstance(String serverUrl, String realm, String username, String password, String clientId, String clientSecret, SSLContext sslContext)
<T> T	proxy(Class<T> proxyClass, URI absoluteURI) Create a secure proxy based on an absolute URI.
RealmResource	realm(String realmName)
RealmsResource	realms()
ServerInfoResource	serverInfo()
TokenManager	tokenManager()

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static Keycloak getInstance(String serverUrl,
                                   String realm,
                                   String username,
                                   String password,
                                   String clientId,
                                   String clientSecret,
                                   SSLContext sslContext)

getInstance

public static Keycloak getInstance(String serverUrl,
                                   String realm,
                                   String username,
                                   String password,
                                   String clientId,
                                   String clientSecret)

getInstance

public static Keycloak getInstance(String serverUrl,
                                   String realm,
                                   String username,
                                   String password,
                                   String clientId)

realms

public RealmsResource realms()

realm

public RealmResource realm(String realmName)

serverInfo

public ServerInfoResource serverInfo()

tokenManager

public TokenManager tokenManager()

proxy

public <T> T proxy(Class<T> proxyClass,
                   URI absoluteURI)

Create a secure proxy based on an absolute URI. All set up with appropriate token

Type Parameters:

T -

Parameters:

proxyClass -

absoluteURI -

Returns:

close

public void close()

Closes the underlying client. After calling this method, this Keycloak instance cannot be reused.