Keycloak 24.0.0 · org.keycloak.representations.idm.authorization.ResourceRepresentation

Modifier and Type	Field and Description
private Map<String, List<String>>	attributes
private String	displayName
private String	iconUri
private String	id
private String	name
private ResourceOwnerRepresentation	owner
private Boolean	ownerManagedAccess
private Set<ScopeRepresentation>	scopes
private String	type
private Set<String>	uris

Constructor Summary

Access	Constructor and Description
public	ResourceRepresentation(String a human-readable string describing a set of one or more resources name, Set<ScopeRepresentation> the available scopes for this resource set scopes, Set<String> a `List` of `URI` that provides network locations for the resource set being registered uris, String a string uniquely identifying the semantics of the resource set type, String a `URI` for a graphic icon representing the resource set iconUri) Creates a new instance.
public	ResourceRepresentation(String name, Set<ScopeRepresentation> scopes, String uri, String type, String iconUri)
public	ResourceRepresentation(String a human-readable string describing a set of one or more resources name, Set<ScopeRepresentation> the available scopes for this resource set scopes, Set<String> a `List` of `URI` that provides the network location for the resource set being registered uris, String a string uniquely identifying the semantics of the resource set type) Creates a new instance.
public	ResourceRepresentation(String name, Set<ScopeRepresentation> scopes, String uri, String type)
public	ResourceRepresentation(String a human-readable string describing a set of one or more resources name, Set<ScopeRepresentation> the available scopes for this resource set scopes) Creates a new instance.
public	ResourceRepresentation(String name, String... scopes)
public	ResourceRepresentation() Creates a new instance.

Method Summary

Modifier and Type	Method and Description
public void	addScope(String... scopeNames)
public void	addScope(ScopeRepresentation scope)
public boolean	equals(Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public Map<String, List<String>>	getAttributes()
public String	getDisplayName()
public String	getIconUri()
public String	getId()
public String	getName()
public ResourceOwnerRepresentation	getOwner()
public Boolean	getOwnerManagedAccess()
public Set<ScopeRepresentation>	getScopes()
public String	getType()
public String	getUri() Deprecated
public Set<String>	getUris()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public void	setAttributes(Map<String, List<String>> attributes)
public void	setDisplayName(String displayName)
public void	setIconUri(String iconUri)
public void	setId(String id)
public void	setName(String name)
public void	setOwner(ResourceOwnerRepresentation owner)
public void	setOwner(String ownerId)
public void	setOwnerManagedAccess(Boolean ownerManagedAccess)
public void	setScopes(Set<ScopeRepresentation> scopes)
private void	setScopesUma(Set<ScopeRepresentation> scopes) TODO: This is a workaround to allow deserialization of UMA resource representation.
public void	setType(String type)
public void	setUri(String uri) Deprecated
public void	setUris(Set<String> uris)

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll toString wait wait wait

Field Detail

attributes	back to summary
private Map<String, List<String>> attributes Annotations @JsonDeserialize using:StringListMapDeserializer

displayName	back to summary
private String displayName

iconUri	back to summary
private String iconUri Annotations @JsonProperty:icon_uri

id	back to summary
private String id Annotations @JsonProperty:_id

name	back to summary
private String name

owner	back to summary
private ResourceOwnerRepresentation owner

ownerManagedAccess	back to summary
private Boolean ownerManagedAccess

scopes	back to summary
private Set<ScopeRepresentation> scopes Annotations @JsonInclude:NON_EMPTY @JsonProperty:scopes

type	back to summary
private String type

uris	back to summary
private Set<String> uris Annotations @JsonProperty:uris

Constructor Detail

ResourceRepresentation back to summary

ResourceRepresentation	back to summary
public ResourceRepresentation(String name, Set<ScopeRepresentation> scopes, Set<String> uris, String type, String iconUri) Creates a new instance. Parameters name:String a human-readable string describing a set of one or more resources scopes:Set<ScopeRepresentation> the available scopes for this resource set uris:Set<String> a `List` of `URI` that provides network locations for the resource set being registered type:String a string uniquely identifying the semantics of the resource set iconUri:String a `URI` for a graphic icon representing the resource set

public ResourceRepresentation(String name, Set<ScopeRepresentation> scopes, Set<String> uris, String type, String iconUri)

Creates a new instance.

Parameters

name:String: a human-readable string describing a set of one or more resources
scopes:Set<ScopeRepresentation>: the available scopes for this resource set
uris:Set<String>: a List of URI that provides network locations for the resource set being registered
type:String: a string uniquely identifying the semantics of the resource set
iconUri:String: a URI for a graphic icon representing the resource set

ResourceRepresentation	back to summary
public ResourceRepresentation(String name, Set<ScopeRepresentation> scopes, String uri, String type, String iconUri)

ResourceRepresentation back to summary

ResourceRepresentation	back to summary
public ResourceRepresentation(String name, Set<ScopeRepresentation> scopes, Set<String> uris, String type) Creates a new instance. Parameters name:String a human-readable string describing a set of one or more resources scopes:Set<ScopeRepresentation> the available scopes for this resource set uris:Set<String> a `List` of `URI` that provides the network location for the resource set being registered type:String a string uniquely identifying the semantics of the resource set

public ResourceRepresentation(String name, Set<ScopeRepresentation> scopes, Set<String> uris, String type)

Creates a new instance.

Parameters

name:String: a human-readable string describing a set of one or more resources
scopes:Set<ScopeRepresentation>: the available scopes for this resource set
uris:Set<String>: a List of URI that provides the network location for the resource set being registered
type:String: a string uniquely identifying the semantics of the resource set

ResourceRepresentation	back to summary
public ResourceRepresentation(String name, Set<ScopeRepresentation> scopes, String uri, String type)

ResourceRepresentation	back to summary
public ResourceRepresentation(String name, Set<ScopeRepresentation> scopes) Creates a new instance. Parameters name:String a human-readable string describing a set of one or more resources scopes:Set<ScopeRepresentation> the available scopes for this resource set

ResourceRepresentation

back to summary

public ResourceRepresentation(String name, Set<ScopeRepresentation> scopes)

Creates a new instance.

Parameters

name:String: a human-readable string describing a set of one or more resources
scopes:Set<ScopeRepresentation>: the available scopes for this resource set

ResourceRepresentation	back to summary
public ResourceRepresentation(String name, String... scopes)

ResourceRepresentation	back to summary
public ResourceRepresentation() Creates a new instance.

Method Detail

addScope	back to summary
public void addScope(String... scopeNames)

addScope	back to summary
public void addScope(ScopeRepresentation scope)

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise.

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

getAttributes	back to summary
public Map<String, List<String>> getAttributes()

getDisplayName	back to summary
public String getDisplayName()

getIconUri	back to summary
public String getIconUri()

getId	back to summary
public String getId()

getName	back to summary
public String getName()

getOwner	back to summary
public ResourceOwnerRepresentation getOwner()

getOwnerManagedAccess	back to summary
public Boolean getOwnerManagedAccess()

getScopes	back to summary
public Set<ScopeRepresentation> getScopes()

getType	back to summary
public String getType()

getUri	back to summary
public String getUri() Deprecated Annotations @Deprecated @JsonIgnore

getUris	back to summary
public Set<String> getUris()

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int: a hash code value for this object

setAttributes	back to summary
public void setAttributes(Map<String, List<String>> attributes)

setDisplayName	back to summary
public void setDisplayName(String displayName)

setIconUri	back to summary
public void setIconUri(String iconUri)

setId	back to summary
public void setId(String id)

setName	back to summary
public void setName(String name)

setOwner	back to summary
public void setOwner(ResourceOwnerRepresentation owner) Annotations @JsonProperty

setOwner	back to summary
public void setOwner(String ownerId) Annotations @JsonIgnore

setOwnerManagedAccess	back to summary
public void setOwnerManagedAccess(Boolean ownerManagedAccess)

setScopes	back to summary
public void setScopes(Set<ScopeRepresentation> scopes)

setScopesUma	back to summary
private void setScopesUma(Set<ScopeRepresentation> scopes) TODO: This is a workaround to allow deserialization of UMA resource representation. Jackson 2.19+ support aliases, once we upgrade, change this. Annotations @JsonSetter:resource_scopes

setScopesUma

back to summary

private void setScopesUma(Set<ScopeRepresentation> scopes)

TODO: This is a workaround to allow deserialization of UMA resource representation. Jackson 2.19+ support aliases, once we upgrade, change this.

Annotations

@JsonSetter:resource_scopes

setType	back to summary
public void setType(String type)

setUri	back to summary
public void setUri(String uri) Deprecated Annotations @Deprecated @JsonSetter:uri

setUris	back to summary
public void setUris(Set<String> uris)

public Class ResourceRepresentation

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail