Package org.keycloak.adapters.installed

Class KeycloakInstalled

java.lang.Object

org.keycloak.adapters.installed.KeycloakInstalled

public class KeycloakInstalled
extends Object

Author:

Stian Thorgersen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	KeycloakInstalled.Console
static class	KeycloakInstalled.DesktopProvider
static class	KeycloakInstalled.Pkce

Constructor Summary

Constructors

Constructor	Description
KeycloakInstalled()
KeycloakInstalled(InputStream config)
KeycloakInstalled(KeycloakDeployment deployment)

Method Summary

Modifier and Type	Method	Description
void	close()
static KeycloakInstalled.Console	console()
protected String	createAuthUrl(String redirectUri, String state, KeycloakInstalled.Pkce pkce)
protected org.jboss.resteasy.client.jaxrs.ResteasyClient	createResteasyClient()
protected KeycloakInstalled.Pkce	generatePkce()
KeycloakDeployment	getDeployment()
IDToken	getIdToken()
String	getIdTokenString()
String	getListenHostname()
int	getListenPort()
Locale	getLocale()
String	getRefreshToken()
protected org.jboss.resteasy.client.jaxrs.ResteasyClient	getResteasyClient()
AccessToken	getToken()
AccessTokenResponse	getTokenResponse()
String	getTokenString()
String	getTokenString(long minValidity, TimeUnit unit)
boolean	isDesktopSupported()
void	login()
void	login(PrintStream printer, Reader reader)
boolean	loginCommandLine()
boolean	loginCommandLine(String redirectUri)	Experimental proprietary WWW-Authentication challenge protocol.
void	loginDesktop()
void	loginManual()
void	loginManual(PrintStream printer, Reader reader)
void	logout()
void	refreshToken()
void	refreshToken(String refreshToken)
void	setDesktopProvider(KeycloakInstalled.DesktopProvider desktopProvider)
void	setListenHostname(String listenHostname)	Configures the local hostname to listen for callbacks.
void	setListenPort(int listenPort)	Configures the local port to listen for callbacks.
void	setLocale(Locale locale)
void	setResteasyClient(org.jboss.resteasy.client.jaxrs.ResteasyClient resteasyClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

KeycloakInstalled

public KeycloakInstalled()

KeycloakInstalled

public KeycloakInstalled(InputStream config)

KeycloakInstalled

public KeycloakInstalled(KeycloakDeployment deployment)

Method Detail

setResteasyClient

public void setResteasyClient(org.jboss.resteasy.client.jaxrs.ResteasyClient resteasyClient)

getLocale

public Locale getLocale()

setLocale

public void setLocale(Locale locale)

getListenPort

public int getListenPort()

setListenPort

public void setListenPort(int listenPort)

Configures the local port to listen for callbacks. The value 0 will choose a random port. Defaults to 0.

Parameters:

listenPort - a valid port number

getListenHostname

public String getListenHostname()

setListenHostname

public void setListenHostname(String listenHostname)

Configures the local hostname to listen for callbacks. The value 0 will choose a random port

Parameters:

listenHostname - a valid local hostname

login

public void login()
           throws IOException,
                  ServerRequest.HttpFailure,
                  org.keycloak.common.VerificationException,
                  InterruptedException,
                  OAuthErrorException,
                  URISyntaxException

Throws:

IOException

ServerRequest.HttpFailure

org.keycloak.common.VerificationException

InterruptedException

OAuthErrorException

URISyntaxException

login

public void login(PrintStream printer,
                  Reader reader)
           throws IOException,
                  ServerRequest.HttpFailure,
                  org.keycloak.common.VerificationException,
                  InterruptedException,
                  OAuthErrorException,
                  URISyntaxException

Throws:

IOException

ServerRequest.HttpFailure

org.keycloak.common.VerificationException

InterruptedException

OAuthErrorException

URISyntaxException

logout

public void logout()
            throws IOException,
                   InterruptedException,
                   URISyntaxException

Throws:

IOException

InterruptedException

URISyntaxException

loginDesktop

public void loginDesktop()
                  throws IOException,
                         org.keycloak.common.VerificationException,
                         OAuthErrorException,
                         URISyntaxException,
                         ServerRequest.HttpFailure,
                         InterruptedException

Throws:

IOException

org.keycloak.common.VerificationException

OAuthErrorException

URISyntaxException

ServerRequest.HttpFailure

InterruptedException

close

public void close()

createAuthUrl

protected String createAuthUrl(String redirectUri,
                               String state,
                               KeycloakInstalled.Pkce pkce)

generatePkce

protected KeycloakInstalled.Pkce generatePkce()

loginManual

public void loginManual()
                 throws IOException,
                        ServerRequest.HttpFailure,
                        org.keycloak.common.VerificationException

Throws:

IOException

ServerRequest.HttpFailure

org.keycloak.common.VerificationException

loginManual

public void loginManual(PrintStream printer,
                        Reader reader)
                 throws IOException,
                        ServerRequest.HttpFailure,
                        org.keycloak.common.VerificationException

Throws:

IOException

ServerRequest.HttpFailure

org.keycloak.common.VerificationException

console

public static KeycloakInstalled.Console console()

loginCommandLine

public boolean loginCommandLine()
                         throws IOException,
                                ServerRequest.HttpFailure,
                                org.keycloak.common.VerificationException

Throws:

IOException

ServerRequest.HttpFailure

org.keycloak.common.VerificationException

loginCommandLine

public boolean loginCommandLine(String redirectUri)
                         throws IOException,
                                ServerRequest.HttpFailure,
                                org.keycloak.common.VerificationException

Experimental proprietary WWW-Authentication challenge protocol. WWW-Authentication: X-Text-Form-Challenge callback="{url}" param="{param-name}" label="{param-display-label}"

Parameters:

redirectUri -

Returns:

Throws:

IOException

ServerRequest.HttpFailure

org.keycloak.common.VerificationException

getResteasyClient

protected org.jboss.resteasy.client.jaxrs.ResteasyClient getResteasyClient()

createResteasyClient

protected org.jboss.resteasy.client.jaxrs.ResteasyClient createResteasyClient()

getTokenString

public String getTokenString()

getTokenString

public String getTokenString(long minValidity,
                             TimeUnit unit)
                      throws org.keycloak.common.VerificationException,
                             IOException,
                             ServerRequest.HttpFailure

Throws:

org.keycloak.common.VerificationException

IOException

ServerRequest.HttpFailure

refreshToken

public void refreshToken()
                  throws IOException,
                         ServerRequest.HttpFailure,
                         org.keycloak.common.VerificationException

Throws:

IOException

ServerRequest.HttpFailure

org.keycloak.common.VerificationException

refreshToken

public void refreshToken(String refreshToken)
                  throws IOException,
                         ServerRequest.HttpFailure,
                         org.keycloak.common.VerificationException

Throws:

IOException

ServerRequest.HttpFailure

org.keycloak.common.VerificationException

getToken

public AccessToken getToken()

getIdToken

public IDToken getIdToken()

getIdTokenString

public String getIdTokenString()

getRefreshToken

public String getRefreshToken()

getTokenResponse

public AccessTokenResponse getTokenResponse()

setDesktopProvider

public void setDesktopProvider(KeycloakInstalled.DesktopProvider desktopProvider)

isDesktopSupported

public boolean isDesktopSupported()

getDeployment

public KeycloakDeployment getDeployment()