Class AdminRoot
- java.lang.Object
-
- org.keycloak.services.resources.admin.AdminRoot
-
@Path("/admin") public class AdminRoot extends Object
Root resource for admin console and admin REST API- Version:
- $Revision: 1 $
- Author:
- Bill Burke
-
-
Field Summary
Fields Modifier and Type Field Description protected org.keycloak.common.ClientConnection
clientConnection
protected static org.jboss.logging.Logger
logger
protected org.jboss.resteasy.spi.HttpRequest
request
protected org.jboss.resteasy.spi.HttpResponse
response
protected org.keycloak.models.KeycloakSession
session
protected TokenManager
tokenManager
-
Constructor Summary
Constructors Constructor Description AdminRoot()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static javax.ws.rs.core.UriBuilder
adminBaseUrl(javax.ws.rs.core.UriBuilder base)
static javax.ws.rs.core.UriBuilder
adminBaseUrl(javax.ws.rs.core.UriInfo uriInfo)
static javax.ws.rs.core.UriBuilder
adminConsoleUrl(javax.ws.rs.core.UriBuilder base)
static javax.ws.rs.core.UriBuilder
adminConsoleUrl(javax.ws.rs.core.UriInfo uriInfo)
protected AdminAuth
authenticateRealmAdminRequest(javax.ws.rs.core.HttpHeaders headers)
AdminConsole
getAdminConsole(String name)
path to realm admin console uistatic Properties
getMessages(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, String lang)
static Properties
getMessages(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, String lang, String... bundles)
Object
getRealmsAdmin(javax.ws.rs.core.HttpHeaders headers)
Base Path to realm admin REST interfaceObject
getServerInfo(javax.ws.rs.core.HttpHeaders headers)
General information about the serverstatic org.keycloak.theme.Theme
getTheme(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm)
protected org.keycloak.models.RealmModel
locateRealm(String name, RealmManager realmManager)
javax.ws.rs.core.Response
masterRealmAdminConsoleRedirect()
Convenience path to master realm admin consolejavax.ws.rs.core.Response
masterRealmAdminConsoleRedirectHtml()
Convenience path to master realm admin consolestatic javax.ws.rs.core.UriBuilder
realmsUrl(javax.ws.rs.core.UriBuilder base)
static javax.ws.rs.core.UriBuilder
realmsUrl(javax.ws.rs.core.UriInfo uriInfo)
-
-
-
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
-
tokenManager
protected TokenManager tokenManager
-
session
@Context protected org.keycloak.models.KeycloakSession session
-
-
Method Detail
-
adminBaseUrl
public static javax.ws.rs.core.UriBuilder adminBaseUrl(javax.ws.rs.core.UriInfo uriInfo)
-
adminBaseUrl
public static javax.ws.rs.core.UriBuilder adminBaseUrl(javax.ws.rs.core.UriBuilder base)
-
masterRealmAdminConsoleRedirect
@GET public javax.ws.rs.core.Response masterRealmAdminConsoleRedirect()
Convenience path to master realm admin console- Returns:
-
masterRealmAdminConsoleRedirectHtml
@Path("index.{html:html}") @GET public javax.ws.rs.core.Response masterRealmAdminConsoleRedirectHtml()
Convenience path to master realm admin console- Returns:
-
locateRealm
protected org.keycloak.models.RealmModel locateRealm(String name, RealmManager realmManager)
-
adminConsoleUrl
public static javax.ws.rs.core.UriBuilder adminConsoleUrl(javax.ws.rs.core.UriInfo uriInfo)
-
adminConsoleUrl
public static javax.ws.rs.core.UriBuilder adminConsoleUrl(javax.ws.rs.core.UriBuilder base)
-
getAdminConsole
@Path("{realm}/console") public AdminConsole getAdminConsole(@PathParam("realm") String name)
path to realm admin console ui- Parameters:
name
- Realm name (not id!)- Returns:
-
authenticateRealmAdminRequest
protected AdminAuth authenticateRealmAdminRequest(javax.ws.rs.core.HttpHeaders headers)
-
realmsUrl
public static javax.ws.rs.core.UriBuilder realmsUrl(javax.ws.rs.core.UriInfo uriInfo)
-
realmsUrl
public static javax.ws.rs.core.UriBuilder realmsUrl(javax.ws.rs.core.UriBuilder base)
-
getRealmsAdmin
@Path("realms") public Object getRealmsAdmin(@Context javax.ws.rs.core.HttpHeaders headers)
Base Path to realm admin REST interface- Parameters:
headers
-- Returns:
-
getServerInfo
@Path("serverinfo") public Object getServerInfo(@Context javax.ws.rs.core.HttpHeaders headers)
General information about the server- Parameters:
headers
-- Returns:
-
getTheme
public static org.keycloak.theme.Theme getTheme(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm) throws IOException
- Throws:
IOException
-
getMessages
public static Properties getMessages(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, String lang)
-
getMessages
public static Properties getMessages(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, String lang, String... bundles)
-
-