Keycloak Core 24.0.0 · org.keycloak.representations.userprofile.config.UPAttribute

Modifier and Type	Field and Description
private Map<String, Object>	annotations
private String	displayName
private String	group
private boolean	multivalued
private String	name
private UPAttributePermissions	permissions null means everyone can view and edit the attribute
private UPAttributeRequired	required null means it is not required
private UPAttributeSelector	selector null means it is always selected
private Map<String, Map<String, Object>>	validations key in the Map is name of the validator, value is its configuration

Access	Constructor and Description
public	UPAttribute()
public	UPAttribute(String name)
public	UPAttribute(String name, UPGroup group)
public	UPAttribute(String name, UPAttributePermissions permissions, UPAttributeRequired required, UPAttributeSelector selector)
public	UPAttribute(String name, UPAttributePermissions permissions, UPAttributeRequired required)
public	UPAttribute(String name, UPAttributePermissions permissions)
public	UPAttribute(String name, boolean multivalued, UPAttributePermissions permissions)

Method Summary

Modifier and Type	Method and Description
public void	addValidation(String validator, Map<String, Object> config)
protected UPAttribute	clone() Overrides java.lang.Object.clone. Creates and returns a copy of this object.
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, Object>	getAnnotations()
public String	getDisplayName()
public String	getGroup()
public String	getName()
public UPAttributePermissions	getPermissions()
public UPAttributeRequired	getRequired()
public UPAttributeSelector	getSelector()
public Map<String, Map<String, Object>>	getValidations()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
public boolean	isMultivalued()
public void	setAnnotations(Map<String, Object> annotations)
public void	setDisplayName(String displayName)
public void	setGroup(String group)
public void	setMultivalued(boolean multivalued)
public void	setName(String name)
public void	setPermissions(UPAttributePermissions permissions)
public void	setRequired(UPAttributeRequired required)
public void	setSelector(UPAttributeSelector selector)
public void	setValidations(Map<String, Map<String, Object>> validations)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

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

annotations	back to summary
private Map<String, Object> annotations

displayName	back to summary
private String displayName

group	back to summary
private String group

multivalued	back to summary
private boolean multivalued

name	back to summary
private String name

permissions	back to summary
private UPAttributePermissions permissions null means everyone can view and edit the attribute

required	back to summary
private UPAttributeRequired required null means it is not required

selector	back to summary
private UPAttributeSelector selector null means it is always selected

validations	back to summary
private Map<String, Map<String, Object>> validations key in the Map is name of the validator, value is its configuration

UPAttribute	back to summary
public UPAttribute()

UPAttribute	back to summary
public UPAttribute(String name)

UPAttribute	back to summary
public UPAttribute(String name, UPGroup group)

UPAttribute	back to summary
public UPAttribute(String name, UPAttributePermissions permissions, UPAttributeRequired required, UPAttributeSelector selector)

UPAttribute	back to summary
public UPAttribute(String name, UPAttributePermissions permissions, UPAttributeRequired required)

UPAttribute	back to summary
public UPAttribute(String name, UPAttributePermissions permissions)

UPAttribute	back to summary
public UPAttribute(String name, boolean multivalued, UPAttributePermissions permissions)

Method Detail

addValidation	back to summary
public void addValidation(String validator, Map<String, Object> config)

clone back to summary

clone	back to summary
protected UPAttribute clone() Overrides java.lang.Object.clone. Doc from java.lang.Object.clone. Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object `x`, the expression: x.clone() != x will be true, and that the expression: x.clone().getClass() == x.getClass() will be `true`, but these are not absolute requirements. While it is typically the case that: x.clone().equals(x) will be `true`, this is not an absolute requirement. By convention, the returned object should be obtained by calling `super.clone`. If a class and all of its superclasses (except `Object`) obey this convention, it will be the case that `x.clone().getClass() == x.getClass()`. By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by `super.clone` before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by `super.clone` need to be modified. Returns:UPAttribute a clone of this instance. Annotations @Override

protected UPAttribute clone()

Overrides java.lang.Object.clone.

Doc from java.lang.Object.clone.

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

x.clone() != x

will be true, and that the expression:

x.clone().getClass() == x.getClass()

will be true, but these are not absolute requirements. While it is typically the case that:

x.clone().equals(x)

will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Returns:UPAttribute

a clone of this instance.

Annotations

@Override

equals back to summary

equals	back 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

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

getAnnotations	back to summary
public Map<String, Object> getAnnotations()

getDisplayName	back to summary
public String getDisplayName()

getGroup	back to summary
public String getGroup()

getName	back to summary
public String getName()

getPermissions	back to summary
public UPAttributePermissions getPermissions()

getRequired	back to summary
public UPAttributeRequired getRequired()

getSelector	back to summary
public UPAttributeSelector getSelector()

getValidations	back to summary
public Map<String, Map<String, Object>> getValidations()

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 the 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

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the 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

isMultivalued	back to summary
public boolean isMultivalued()

setAnnotations	back to summary
public void setAnnotations(Map<String, Object> annotations)

setDisplayName	back to summary
public void setDisplayName(String displayName)

setGroup	back to summary
public void setGroup(String group)

setMultivalued	back to summary
public void setMultivalued(boolean multivalued)

setName	back to summary
public void setName(String name)

setPermissions	back to summary
public void setPermissions(UPAttributePermissions permissions)

setRequired	back to summary
public void setRequired(UPAttributeRequired required)

setSelector	back to summary
public void setSelector(UPAttributeSelector selector)

setValidations	back to summary
public void setValidations(Map<String, Map<String, Object>> validations)

toString	back 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

toString

back 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

public Class UPAttribute

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail