Package org.keycloak.authorization.model
Interface ResourceServer
-
- All Known Implementing Classes:
AbstractResourceServerModel
,MapResourceServerAdapter
,ResourceServerAdapter
,ResourceServerAdapter
public interface ResourceServer
Represents a resource server, whose resources are managed and protected. A resource server is basically an existing client application in Keycloak that will also act as a resource server.- Author:
- Pedro Igor
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
ResourceServer.SearchableFields
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
getClientId()
Returns id of a client that thisResourceServer
is associated withDecisionStrategy
getDecisionStrategy()
Returns theDecisionStrategy
configured for this instance.String
getId()
Returns the unique identifier for this instance.PolicyEnforcementMode
getPolicyEnforcementMode()
Returns thePolicyEnforcementMode
configured for this instance.RealmModel
getRealm()
Returns reference of a realm that thisResourceServer
belongs to.boolean
isAllowRemoteResourceManagement()
Indicates if the resource server is allowed to manage its own resources remotely using the Protection API.void
setAllowRemoteResourceManagement(boolean allowRemoteResourceManagement)
Indicates if the resource server is allowed to manage its own resources remotely using the Protection API.void
setDecisionStrategy(DecisionStrategy decisionStrategy)
Defines aDecisionStrategy
for this instance, indicating how permissions should be granted depending on the givendecisionStrategy
.void
setPolicyEnforcementMode(PolicyEnforcementMode enforcementMode)
Defines aPolicyEnforcementMode
for this instance.
-
-
-
Method Detail
-
getId
String getId()
Returns the unique identifier for this instance.- Returns:
- the unique identifier for this instance
-
isAllowRemoteResourceManagement
boolean isAllowRemoteResourceManagement()
Indicates if the resource server is allowed to manage its own resources remotely using the Protection API.- Returns:
true
if the resource server is allowed to managed them remotely
-
setAllowRemoteResourceManagement
void setAllowRemoteResourceManagement(boolean allowRemoteResourceManagement)
Indicates if the resource server is allowed to manage its own resources remotely using the Protection API.- Parameters:
allowRemoteResourceManagement
-true
if the resource server is allowed to managed them remotely
-
getPolicyEnforcementMode
PolicyEnforcementMode getPolicyEnforcementMode()
Returns thePolicyEnforcementMode
configured for this instance.- Returns:
- the
PolicyEnforcementMode
configured for this instance.
-
setPolicyEnforcementMode
void setPolicyEnforcementMode(PolicyEnforcementMode enforcementMode)
Defines aPolicyEnforcementMode
for this instance.- Parameters:
enforcementMode
- one of the available options inPolicyEnforcementMode
-
setDecisionStrategy
void setDecisionStrategy(DecisionStrategy decisionStrategy)
Defines aDecisionStrategy
for this instance, indicating how permissions should be granted depending on the givendecisionStrategy
.- Parameters:
decisionStrategy
- the decision strategy
-
getDecisionStrategy
DecisionStrategy getDecisionStrategy()
Returns theDecisionStrategy
configured for this instance.- Returns:
- the decision strategy
-
getClientId
String getClientId()
Returns id of a client that thisResourceServer
is associated with- Returns:
- id of client
-
getRealm
RealmModel getRealm()
Returns reference of a realm that thisResourceServer
belongs to.- Returns:
- reference of a realm
-
-