org.keycloak.models

## Interface ClientModel

- All Known Subinterfaces:
    ApplicationModel, OAuthClientModel
  All Known Implementing Classes:
    ApplicationAdapter, ApplicationAdapter, ApplicationAdapter, ClientAdapter, ClientAdapter, ClientAdapter, OAuthClientAdapter, OAuthClientAdapter, OAuthClientAdapter

      public interface ClientModel

  Version:
    $Revision: 1 $
  Author:
    Bill Burke

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static String` | `PRIVATE_KEY`
    `static String` | `PUBLIC_KEY`
    `static String` | `X509CERTIFICATE`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `addRedirectUri(String redirectUri)`
    `void` | `addScopeMapping(RoleModel role)`
    `void` | `addWebOrigin(String webOrigin)`
    `void` | `deleteScopeMapping(RoleModel role)`
    `long` | `getAllowedClaimsMask()`
    `String` | `getAttribute(String name)`
    `Map<String,String>` | `getAttributes()`
    `String` | `getClientId()` String exposed to outside world
    `String` | `getId()` Internal database key
    `int` | `getNotBefore()` Time in seconds since epoc
    `String` | `getProtocol()`
    `RealmModel` | `getRealm()`
    `Set<RoleModel>` | `getRealmScopeMappings()`
    `Set<String>` | `getRedirectUris()`
    `Set<RoleModel>` | `getScopeMappings()`
    `String` | `getSecret()`
    `Set<String>` | `getWebOrigins()`
    `boolean` | `hasScope(RoleModel role)`
    `boolean` | `isDirectGrantsOnly()`
    `boolean` | `isEnabled()`
    `boolean` | `isFullScopeAllowed()`
    `boolean` | `isPublicClient()`
    `void` | `removeAttribute(String name)`
    `void` | `removeRedirectUri(String redirectUri)`
    `void` | `removeWebOrigin(String webOrigin)`
    `void` | `setAllowedClaimsMask(long mask)`
    `void` | `setAttribute(String name, String value)`
    `void` | `setDirectGrantsOnly(boolean flag)`
    `void` | `setEnabled(boolean enabled)`
    `void` | `setFullScopeAllowed(boolean value)`
    `void` | `setNotBefore(int notBefore)`
    `void` | `setProtocol(String protocol)`
    `void` | `setPublicClient(boolean flag)`
    `void` | `setRedirectUris(Set<String> redirectUris)`
    `void` | `setSecret(String secret)`
    `void` | `setWebOrigins(Set<String> webOrigins)`
    `boolean` | `validateSecret(String secret)`

- - ### Field Detail

    - #### PRIVATE_KEY

          static final String PRIVATE_KEY

      See Also:
        Constant Field Values

    - #### PUBLIC_KEY

          static final String PUBLIC_KEY

      See Also:
        Constant Field Values

    - #### X509CERTIFICATE

          static final String X509CERTIFICATE

      See Also:
        Constant Field Values

  - ### Method Detail

    - #### getId

          String getId()

      Internal database key
      Returns:

    - #### getClientId

          String getClientId()

      String exposed to outside world
      Returns:

    - #### getAllowedClaimsMask

          long getAllowedClaimsMask()

    - #### setAllowedClaimsMask

          void setAllowedClaimsMask(long mask)

    - #### getWebOrigins

          Set<String> getWebOrigins()

    - #### setWebOrigins

          void setWebOrigins(Set<String> webOrigins)

    - #### addWebOrigin

          void addWebOrigin(String webOrigin)

    - #### removeWebOrigin

          void removeWebOrigin(String webOrigin)

    - #### getRedirectUris

          Set<String> getRedirectUris()

    - #### setRedirectUris

          void setRedirectUris(Set<String> redirectUris)

    - #### addRedirectUri

          void addRedirectUri(String redirectUri)

    - #### removeRedirectUri

          void removeRedirectUri(String redirectUri)

    - #### isEnabled

          boolean isEnabled()

    - #### setEnabled

          void setEnabled(boolean enabled)

    - #### validateSecret

          boolean validateSecret(String secret)

    - #### getSecret

          String getSecret()

    - #### setSecret

          void setSecret(String secret)

    - #### isFullScopeAllowed

          boolean isFullScopeAllowed()

    - #### setFullScopeAllowed

          void setFullScopeAllowed(boolean value)

    - #### getProtocol

          String getProtocol()

    - #### setProtocol

          void setProtocol(String protocol)

    - #### setAttribute

          void setAttribute(String name,
                          String value)

    - #### removeAttribute

          void removeAttribute(String name)

    - #### getAttribute

          String getAttribute(String name)

    - #### getAttributes

          Map<String,String> getAttributes()

    - #### isPublicClient

          boolean isPublicClient()

    - #### setPublicClient

          void setPublicClient(boolean flag)

    - #### isDirectGrantsOnly

          boolean isDirectGrantsOnly()

    - #### setDirectGrantsOnly

          void setDirectGrantsOnly(boolean flag)

    - #### getScopeMappings

          Set<RoleModel> getScopeMappings()

    - #### addScopeMapping

          void addScopeMapping(RoleModel role)

    - #### deleteScopeMapping

          void deleteScopeMapping(RoleModel role)

    - #### getRealmScopeMappings

          Set<RoleModel> getRealmScopeMappings()

    - #### hasScope

          boolean hasScope(RoleModel role)

    - #### getRealm

          RealmModel getRealm()

    - #### getNotBefore

          int getNotBefore()

      Time in seconds since epoc
      Returns:

    - #### setNotBefore

          void setNotBefore(int notBefore)

Copyright © 2014. All Rights Reserved.