Package org.keycloak.services.resources.admin

Class AdminConsole

java.lang.Object

org.keycloak.services.resources.admin.AdminConsole

public class AdminConsole
extends Object

Version:

$Revision: 1 $

Author:

Bill Burke

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AdminConsole.WhoAmI

Field Summary

Fields

Modifier and Type	Field	Description
protected org.keycloak.common.ClientConnection	clientConnection
protected static org.jboss.logging.Logger	logger
protected javax.ws.rs.ext.Providers	providers
protected org.keycloak.models.RealmModel	realm
protected org.jboss.resteasy.spi.HttpRequest	request
protected org.jboss.resteasy.spi.HttpResponse	response
protected org.keycloak.models.KeycloakSession	session

Constructor Summary

Constructors

Constructor	Description
AdminConsole(org.keycloak.models.RealmModel realm)

Method Summary

Modifier and Type	Method	Description
ClientManager.InstallationAdapterConfig	config()	Adapter configuration for the admin console for this realm
protected org.keycloak.models.RealmModel	getAdminstrationRealm(RealmManager realmManager)
javax.ws.rs.core.Response	getIndexHtmlRedirect()
javax.ws.rs.core.Response	getMainPage()	Main page of this realm's admin console
Properties	getMessages(String lang)
javax.ws.rs.core.Response	logout()	Logout from the admin console
javax.ws.rs.core.Response	whoAmI(javax.ws.rs.core.HttpHeaders headers)	Permission information
javax.ws.rs.core.Response	whoAmIPreFlight()

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final org.jboss.logging.Logger logger

clientConnection

@Context
protected org.keycloak.common.ClientConnection clientConnection

request

@Context
protected org.jboss.resteasy.spi.HttpRequest request

response

@Context
protected org.jboss.resteasy.spi.HttpResponse response

session

@Context
protected org.keycloak.models.KeycloakSession session

providers

@Context
protected javax.ws.rs.ext.Providers providers

realm

protected org.keycloak.models.RealmModel realm

Constructor Detail

AdminConsole

public AdminConsole(org.keycloak.models.RealmModel realm)

Method Detail

config

@Path("config")
@GET
@Produces("application/json")
public ClientManager.InstallationAdapterConfig config()

Adapter configuration for the admin console for this realm

Returns:

whoAmIPreFlight

@Path("whoami")
@OPTIONS
public javax.ws.rs.core.Response whoAmIPreFlight()

whoAmI

@Path("whoami")
@GET
@Produces("application/json")
public javax.ws.rs.core.Response whoAmI(@Context
                                        javax.ws.rs.core.HttpHeaders headers)

Permission information

Parameters:

headers -

Returns:

logout

@Path("logout")
@GET
public javax.ws.rs.core.Response logout()

Logout from the admin console

Returns:

getAdminstrationRealm

protected org.keycloak.models.RealmModel getAdminstrationRealm(RealmManager realmManager)

getMainPage

@GET
public javax.ws.rs.core.Response getMainPage()
                                      throws IOException,
                                             FreeMarkerException

Main page of this realm's admin console

Returns:

Throws:

URISyntaxException

IOException

FreeMarkerException

getIndexHtmlRedirect

@GET
@Path("{indexhtml: index.html}")
public javax.ws.rs.core.Response getIndexHtmlRedirect()

getMessages

@GET
@Path("messages.json")
@Produces("application/json")
public Properties getMessages(@QueryParam("lang")
                              String lang)