keycloak-service
公開メンバ関数 | 限定公開変数類 | 静的限定公開変数類 | 非公開変数類 | 全メンバ一覧
org.keycloak.services.resources.admin.ClientScopeResource クラス
org.keycloak.services.resources.admin.ClientScopeResource 連携図
Collaboration graph

公開メンバ関数

 ClientScopeResource (RealmModel realm, AdminPermissionEvaluator auth, ClientScopeModel clientScope, KeycloakSession session, AdminEventBuilder adminEvent)
 
ProtocolMappersResource getProtocolMappers ()
 
ScopeMappedResource getScopeMappedResource ()
 
Response update (final ClientScopeRepresentation rep)
 
ClientScopeRepresentation getClientScope ()
 
Response deleteClientScope ()
 

限定公開変数類

RealmModel realm
 
ClientScopeModel clientScope
 
KeycloakSession session
 

静的限定公開変数類

static final Logger logger = Logger.getLogger(ClientScopeResource.class)
 

非公開変数類

AdminPermissionEvaluator auth
 
AdminEventBuilder adminEvent
 

詳解

Base resource class for managing one particular client of a realm.

Client Scopes

著者
Bill Burke
バージョン
Revision
1

構築子と解体子

◆ ClientScopeResource()

org.keycloak.services.resources.admin.ClientScopeResource.ClientScopeResource ( RealmModel  realm,
AdminPermissionEvaluator  auth,
ClientScopeModel  clientScope,
KeycloakSession  session,
AdminEventBuilder  adminEvent 
)
inline
62  {
63  this.realm = realm;
64  this.auth = auth;
65  this.clientScope = clientScope;
66  this.session = session;
67  this.adminEvent = adminEvent.resource(ResourceType.CLIENT_SCOPE);
68 
69  }
ClientScopeModel clientScope
Definition: ClientScopeResource.java:59
AdminEventBuilder adminEvent
Definition: ClientScopeResource.java:58
AdminEventBuilder resource(ResourceType resourceType)
Definition: AdminEventBuilder.java:118
RealmModel realm
Definition: ClientScopeResource.java:56
AdminPermissionEvaluator auth
Definition: ClientScopeResource.java:57
KeycloakSession session
Definition: ClientScopeResource.java:60

関数詳解

◆ deleteClientScope()

Response org.keycloak.services.resources.admin.ClientScopeResource.deleteClientScope ( )
inline

Delete the client scope

136  {
138 
139  try {
140  realm.removeClientScope(clientScope.getId());
141  adminEvent.operation(OperationType.DELETE).resourcePath(session.getContext().getUri()).success();
142  return Response.noContent().build();
143  } catch (ModelException me) {
144  return ErrorResponse.error(me.getMessage(), Response.Status.BAD_REQUEST);
145  }
146  }
ClientScopeModel clientScope
Definition: ClientScopeResource.java:59
AdminEventBuilder adminEvent
Definition: ClientScopeResource.java:58
AdminEventBuilder operation(OperationType operationType)
Definition: AdminEventBuilder.java:113
AdminEventBuilder resourcePath(String... pathElements)
Definition: AdminEventBuilder.java:171
RealmModel realm
Definition: ClientScopeResource.java:56
AdminPermissionEvaluator auth
Definition: ClientScopeResource.java:57
KeycloakSession session
Definition: ClientScopeResource.java:60

◆ getClientScope()

ClientScopeRepresentation org.keycloak.services.resources.admin.ClientScopeResource.getClientScope ( )
inline

Get representation of the client scope

戻り値
123  {
125 
126 
127  return ModelToRepresentation.toRepresentation(clientScope);
128  }
ClientScopeModel clientScope
Definition: ClientScopeResource.java:59
AdminPermissionEvaluator auth
Definition: ClientScopeResource.java:57

◆ getProtocolMappers()

ProtocolMappersResource org.keycloak.services.resources.admin.ClientScopeResource.getProtocolMappers ( )
inline
72  {
73  AdminPermissionEvaluator.RequirePermissionCheck manageCheck = () -> auth.clients().requireManage(clientScope);
74  AdminPermissionEvaluator.RequirePermissionCheck viewCheck = () -> auth.clients().requireView(clientScope);
75  ProtocolMappersResource mappers = new ProtocolMappersResource(realm, clientScope, auth, adminEvent, manageCheck, viewCheck);
76  ResteasyProviderFactory.getInstance().injectProperties(mappers);
77  return mappers;
78  }
ClientScopeModel clientScope
Definition: ClientScopeResource.java:59
AdminEventBuilder adminEvent
Definition: ClientScopeResource.java:58
RealmModel realm
Definition: ClientScopeResource.java:56
AdminPermissionEvaluator auth
Definition: ClientScopeResource.java:57

◆ getScopeMappedResource()

ScopeMappedResource org.keycloak.services.resources.admin.ClientScopeResource.getScopeMappedResource ( )
inline

Base path for managing the role scope mappings for the client scope

戻り値
86  {
87  AdminPermissionEvaluator.RequirePermissionCheck manageCheck = () -> auth.clients().requireManage(clientScope);
88  AdminPermissionEvaluator.RequirePermissionCheck viewCheck = () -> auth.clients().requireView(clientScope);
89  return new ScopeMappedResource(realm, auth, clientScope, session, adminEvent, manageCheck, viewCheck);
90  }
ClientScopeModel clientScope
Definition: ClientScopeResource.java:59
AdminEventBuilder adminEvent
Definition: ClientScopeResource.java:58
RealmModel realm
Definition: ClientScopeResource.java:56
AdminPermissionEvaluator auth
Definition: ClientScopeResource.java:57
KeycloakSession session
Definition: ClientScopeResource.java:60

◆ update()

Response org.keycloak.services.resources.admin.ClientScopeResource.update ( final ClientScopeRepresentation  rep)
inline

Update the client scope

引数
rep
戻り値
99  {
101 
102  try {
103  RepresentationToModel.updateClientScope(rep, clientScope);
104  if (session.getTransactionManager().isActive()) {
105  session.getTransactionManager().commit();
106  }
107  adminEvent.operation(OperationType.UPDATE).resourcePath(session.getContext().getUri()).representation(rep).success();
108  return Response.noContent().build();
109  } catch (ModelDuplicateException e) {
110  return ErrorResponse.exists("Client Scope " + rep.getName() + " already exists");
111  }
112  }
ClientScopeModel clientScope
Definition: ClientScopeResource.java:59
AdminEventBuilder adminEvent
Definition: ClientScopeResource.java:58
AdminEventBuilder operation(OperationType operationType)
Definition: AdminEventBuilder.java:113
void success()
Definition: AdminEventBuilder.java:226
AdminEventBuilder resourcePath(String... pathElements)
Definition: AdminEventBuilder.java:171
AdminPermissionEvaluator auth
Definition: ClientScopeResource.java:57
KeycloakSession session
Definition: ClientScopeResource.java:60

メンバ詳解

◆ adminEvent

AdminEventBuilder org.keycloak.services.resources.admin.ClientScopeResource.adminEvent
private

◆ auth

AdminPermissionEvaluator org.keycloak.services.resources.admin.ClientScopeResource.auth
private

◆ clientScope

ClientScopeModel org.keycloak.services.resources.admin.ClientScopeResource.clientScope
protected

◆ logger

final Logger org.keycloak.services.resources.admin.ClientScopeResource.logger = Logger.getLogger(ClientScopeResource.class)
staticprotected

◆ realm

RealmModel org.keycloak.services.resources.admin.ClientScopeResource.realm
protected

◆ session

KeycloakSession org.keycloak.services.resources.admin.ClientScopeResource.session
protected

このクラス詳解は次のファイルから抽出されました: