MapClientScopeEntity (Keycloak Docs Distribution 21.0.2 API)

All Superinterfaces:

AbstractEntity, EntityWithAttributes, UpdatableEntity

All Known Implementing Classes:

HotRodClientScopeEntity.AbstractHotRodClientScopeEntityDelegate, HotRodClientScopeEntityDelegate, JpaClientScopeEntity, JpaClientScopeMetadata, MapClientScopeEntity.AbstractClientScopeEntity, MapClientScopeEntityDelegate, MapClientScopeEntityFieldDelegate, MapClientScopeEntityImpl, MapClientScopeEntityImpl.Empty
```
public interface MapClientScopeEntity
extends AbstractEntity, UpdatableEntity, EntityWithAttributes
```

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static class MapClientScopeEntity.AbstractClientScopeEntity
- Nested classes/interfaces inherited from interface org.keycloak.models.map.common.UpdatableEntity
  UpdatableEntity.Impl

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`addProtocolMapper(MapProtocolMapperEntity mapping)`
`void`	`addScopeMapping(String id)`
`String`	`getDescription()`
`String`	`getName()`
`String`	`getProtocol()`
`Optional<MapProtocolMapperEntity>`	`getProtocolMapper(String id)`
`Set<MapProtocolMapperEntity>`	`getProtocolMappers()`
`String`	`getRealmId()`
`Collection<String>`	`getScopeMappings()`
`void`	`removeProtocolMapper(String id)`
`void`	`removeScopeMapping(String id)`
`void`	`setDescription(String description)`
`void`	`setName(String name)`
`void`	`setProtocol(String protocol)`
`void`	`setRealmId(String realmId)`

Methods inherited from interface org.keycloak.models.map.common.AbstractEntity
getId, setId

Methods inherited from interface org.keycloak.models.map.common.EntityWithAttributes
getAttribute, getAttributes, removeAttribute, setAttribute, setAttributes

Methods inherited from interface org.keycloak.models.map.common.UpdatableEntity
clearUpdatedFlag, isUpdated

Method Detail

getName
```
String getName()
```

getDescription
```
String getDescription()
```

getProtocol
```
String getProtocol()
```

getRealmId
```
String getRealmId()
```

setName
```
void setName(String name)
```

setDescription

void setDescription(String description)

setProtocol
```
void setProtocol(String protocol)
```

setRealmId
```
void setRealmId(String realmId)
```

getProtocolMapper

Optional<MapProtocolMapperEntity> getProtocolMapper(String id)

getProtocolMappers

Set<MapProtocolMapperEntity> getProtocolMappers()

addProtocolMapper

void addProtocolMapper(MapProtocolMapperEntity mapping)

removeProtocolMapper

void removeProtocolMapper(String id)

addScopeMapping
```
void addScopeMapping(String id)
```

removeScopeMapping
```
void removeScopeMapping(String id)
```

getScopeMappings
```
Collection<String> getScopeMappings()
```