Top Inners Fields Constructors Methods
org.keycloak.representations.idm

public Class RoleRepresentation

extends Object
Class Inheritance
Imports
java.util.Arrays, .HashMap, .List, .Map, .Objects, .Set

Author
Bill Burke
Version
$Revision: 1 $

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
protected Map<String, List<String>>
private Boolean
protected boolean
protected RoleRepresentation.Composites
private String
protected String
protected String
protected String
protected Boolean
scopeParamRequired

Deprecated

Constructor Summary

AccessConstructor and Description
public
public
RoleRepresentation(String name, String description, boolean scopeParamRequired)

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
obj
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public Map<String, List<String>>
public Boolean
public RoleRepresentation.Composites
public String
public String
public String
public String
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.
public boolean
public Boolean
isScopeParamRequired()

Deprecated
public void
public void
setClientRole(Boolean clientRole)

public void
setComposite(boolean composite)

public void
public void
setContainerId(String containerId)

public void
setDescription(String description)

public void
public void
public RoleRepresentation
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

attributesback to summary
protected Map<String, List<String>> attributes
clientRoleback to summary
private Boolean clientRole
compositeback to summary
protected boolean composite
compositesback to summary
protected RoleRepresentation.Composites composites
containerIdback to summary
private String containerId
descriptionback to summary
protected String description
idback to summary
protected String id
nameback to summary
protected String name
scopeParamRequiredback to summary
protected Boolean scopeParamRequired

Deprecated

Annotations
@Deprecated

Constructor Detail

RoleRepresentationback to summary
public RoleRepresentation()
RoleRepresentationback to summary
public RoleRepresentation(String name, String description, boolean scopeParamRequired)

Method Detail

equalsback to summary
public boolean equals(Object obj)

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
obj:Object

the reference object with which to compare.

Returns:boolean

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

Annotations
@Override
getAttributesback to summary
public Map<String, List<String>> getAttributes()
getClientRoleback to summary
public Boolean getClientRole()
getCompositesback to summary
public RoleRepresentation.Composites getComposites()
getContainerIdback to summary
public String getContainerId()
getDescriptionback to summary
public String getDescription()
getIdback to summary
public String getId()
getNameback to summary
public String getName()
hashCodeback 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

Annotations
@Override
isCompositeback to summary
public boolean isComposite()
isScopeParamRequiredback to summary
public Boolean isScopeParamRequired()

Deprecated

Annotations
@Deprecated
setAttributesback to summary
public void setAttributes(Map<String, List<String>> attributes)
setClientRoleback to summary
public void setClientRole(Boolean clientRole)
setCompositeback to summary
public void setComposite(boolean composite)
setCompositesback to summary
public void setComposites(RoleRepresentation.Composites composites)
setContainerIdback to summary
public void setContainerId(String containerId)
setDescriptionback to summary
public void setDescription(String description)
setIdback to summary
public void setId(String id)
setNameback to summary
public void setName(String name)
singleAttributeback to summary
public RoleRepresentation singleAttribute(String name, String value)
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object

Annotations
@Override
org.keycloak.representations.idm back to summary

public Class RoleRepresentation.Composites

extends Object
Class Inheritance
  • java.lang.Object
  • org.keycloak.representations.idm.RoleRepresentation.Composites

Field Summary

Modifier and TypeField and Description
protected Map<String, List<String>>
application

Deprecated
protected Map<String, List<String>>
protected Set<String>

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public Map<String, List<String>>
getApplication()

Deprecated
public Map<String, List<String>>
public Set<String>
public void
public void
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

applicationback to summary
protected Map<String, List<String>> application

Deprecated

Annotations
@Deprecated
clientback to summary
protected Map<String, List<String>> client
realmback to summary
protected Set<String> realm

Constructor Detail

Compositesback to summary
public Composites()

Method Detail

getApplicationback to summary
public Map<String, List<String>> getApplication()

Deprecated

Annotations
@Deprecated
getClientback to summary
public Map<String, List<String>> getClient()
getRealmback to summary
public Set<String> getRealm()
setClientback to summary
public void setClient(Map<String, List<String>> client)
setRealmback to summary
public void setRealm(Set<String> realm)