Package org.keycloak.models.map.authorization.adapter

Class MapScopeAdapter

java.lang.Object

org.keycloak.authorization.model.AbstractAuthorizationModel

org.keycloak.models.map.authorization.adapter.AbstractScopeModel<MapScopeEntity>

org.keycloak.models.map.authorization.adapter.MapScopeAdapter

All Implemented Interfaces:

Scope

public class MapScopeAdapter
extends AbstractScopeModel<MapScopeEntity>

Nested Class Summary

Nested classes/interfaces inherited from interface org.keycloak.authorization.model.Scope

Scope.FilterOption, Scope.SearchableFields

Field Summary

Fields inherited from class org.keycloak.models.map.authorization.adapter.AbstractScopeModel

entity

Fields inherited from class org.keycloak.authorization.model.AbstractAuthorizationModel

storeFactory

Constructor Summary

Constructors

Constructor	Description
MapScopeAdapter(RealmModel realm, ResourceServer resourceServer, MapScopeEntity entity, StoreFactory storeFactory)

Method Summary

Modifier and Type	Method	Description
String	getDisplayName()	Returns the end user friendly name for this scope.
String	getIconUri()	Returns an icon URI for this scope.
String	getId()	Returns the unique identifier for this instance.
String	getName()	Returns the name of this scope.
ResourceServer	getResourceServer()	Returns the ResourceServer instance to where this scope belongs to.
void	setDisplayName(String name)	Sets an end user friendly name for this scope.
void	setIconUri(String iconUri)	Sets an icon URI for this scope.
void	setName(String name)	Sets a name for this scope.
String	toString()

Methods inherited from class org.keycloak.models.map.authorization.adapter.AbstractScopeModel

equals, hashCode

Methods inherited from class org.keycloak.authorization.model.AbstractAuthorizationModel

throwExceptionIfReadonly

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

MapScopeAdapter

public MapScopeAdapter(RealmModel realm,
 ResourceServer resourceServer,
 MapScopeEntity entity,
 StoreFactory storeFactory)

Method Details

getId

public String getId()

Description copied from interface: Scope

Returns the unique identifier for this instance.

Returns:

the unique identifier for this instance

getName

public String getName()

Description copied from interface: Scope

Returns the name of this scope.

Returns:

the name of this scope

setName

public void setName(String name)

Description copied from interface: Scope

Sets a name for this scope. The name must be unique.

Parameters:

name - the name of this scope

getDisplayName

public String getDisplayName()

Description copied from interface: Scope

Returns the end user friendly name for this scope. If not defined, value for Scope.getName() is returned.

Returns:

the friendly name for this scope

setDisplayName

public void setDisplayName(String name)

Description copied from interface: Scope

Sets an end user friendly name for this scope.

Parameters:

name - the name of this scope

getIconUri

public String getIconUri()

Description copied from interface: Scope

Returns an icon URI for this scope.

Returns:

a uri for an icon

setIconUri

public void setIconUri(String iconUri)

Description copied from interface: Scope

Sets an icon URI for this scope.

getResourceServer

public ResourceServer getResourceServer()

Description copied from interface: Scope

Returns the ResourceServer instance to where this scope belongs to.

Returns:

toString

public String toString()

Overrides:

toString in class Object