org.keycloak.services.resources

## Class RealmsResource

- java.lang.Object
- - org.keycloak.services.resources.RealmsResource

-     @Path(value="/realms")
      public class RealmsResource
      extends Object

  Version:
    $Revision: 1 $
  Author:
    Bill Burke

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `protected ClientConnection` | `clientConnection`
    `protected javax.ws.rs.core.HttpHeaders` | `headers`
    `protected static org.jboss.logging.Logger` | `logger`
    `protected BruteForceProtector` | `protector`
    `protected KeycloakSession` | `session`
    `protected javax.ws.rs.core.UriInfo` | `uriInfo`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `RealmsResource()`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `static javax.ws.rs.core.UriBuilder` | `accountUrl(javax.ws.rs.core.UriBuilder base)`
    `AccountService` | `getAccountService(String name)`
    `ClientsManagementService` | `getClientsManagementService(String name)`
    `LoginActionsService` | `getLoginActionsService(String name)`
    `javax.ws.rs.core.Response` | `getLoginStatusIframe(String name, String client_id, String origin)` Deprecated.
    `Object` | `getProtocol(String name, String protocol)`
    `PublicRealmResource` | `getRealmResource(String name)`
    `Object` | `getTokenService(String name)` Deprecated.
    `protected RealmModel` | `locateRealm(String name, RealmManager realmManager)`
    `static javax.ws.rs.core.UriBuilder` | `protocolUrl(javax.ws.rs.core.UriBuilder base)`
    `static javax.ws.rs.core.UriBuilder` | `protocolUrl(javax.ws.rs.core.UriInfo uriInfo)`
    `static javax.ws.rs.core.UriBuilder` | `realmBaseUrl(javax.ws.rs.core.UriBuilder base)`
    `static javax.ws.rs.core.UriBuilder` | `realmBaseUrl(javax.ws.rs.core.UriInfo uriInfo)`

    - ### Methods inherited from class java.lang.Object

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

- - ### Field Detail

    - #### logger

          protected static org.jboss.logging.Logger logger

    - #### uriInfo

          @Context
          protected javax.ws.rs.core.UriInfo uriInfo

    - #### headers

          @Context
          protected javax.ws.rs.core.HttpHeaders headers

    - #### session

          @Context
          protected KeycloakSession session

    - #### clientConnection

          @Context
          protected ClientConnection clientConnection

    - #### protector

          @Context
          protected BruteForceProtector protector

  - ### Constructor Detail

    - #### RealmsResource

          public RealmsResource()

  - ### Method Detail

    - #### realmBaseUrl

          public static javax.ws.rs.core.UriBuilder realmBaseUrl(javax.ws.rs.core.UriInfo uriInfo)

    - #### realmBaseUrl

          public static javax.ws.rs.core.UriBuilder realmBaseUrl(javax.ws.rs.core.UriBuilder base)

    - #### accountUrl

          public static javax.ws.rs.core.UriBuilder accountUrl(javax.ws.rs.core.UriBuilder base)

    - #### protocolUrl

          public static javax.ws.rs.core.UriBuilder protocolUrl(javax.ws.rs.core.UriBuilder base)

    - #### protocolUrl

          public static javax.ws.rs.core.UriBuilder protocolUrl(javax.ws.rs.core.UriInfo uriInfo)

    - #### getLoginStatusIframe

          @Path(value="{realm}/login-status-iframe.html")
          @GET
          @Produces(value="text/html")
          @Deprecated
          public javax.ws.rs.core.Response getLoginStatusIframe(@PathParam(value="realm")
                                                                                    String name,
                                                                                    @QueryParam(value="client_id")
                                                                                    String client_id,
                                                                                    @QueryParam(value="origin")
                                                                                    String origin)

      Deprecated.

    - #### getProtocol

          @Path(value="{realm}/protocol/{protocol}")
          public Object getProtocol(@PathParam(value="realm")
                                String name,
                                @PathParam(value="protocol")
                                String protocol)

    - #### getTokenService

          @Path(value="{realm}/tokens")
          @Deprecated
          public Object getTokenService(@PathParam(value="realm")
                                               String name)

      Deprecated.

    - #### getLoginActionsService

          @Path(value="{realm}/login-actions")
          public LoginActionsService getLoginActionsService(@PathParam(value="realm")
                                                        String name)

    - #### getClientsManagementService

          @Path(value="{realm}/clients-managements")
          public ClientsManagementService getClientsManagementService(@PathParam(value="realm")
                                                                  String name)

    - #### locateRealm

          protected RealmModel locateRealm(String name,
                               RealmManager realmManager)

    - #### getAccountService

          @Path(value="{realm}/account")
          public AccountService getAccountService(@PathParam(value="realm")
                                              String name)

    - #### getRealmResource

          @Path(value="{realm}")
          public PublicRealmResource getRealmResource(@PathParam(value="realm")
                                                  String name)

Copyright © 2014. All Rights Reserved.