Top Description Inners Fields Constructors Methods
org.keycloak.representations.userprofile.config

public Class UPConfig

extends Object
implements Cloneable
Class Inheritance
All Implemented Interfaces
java.lang.Cloneable
Imports
java.util.ArrayList, .Collections, .List, .Objects, java.util.stream.Collectors, com.fasterxml.jackson.annotation.JsonIgnore

Configuration of the User Profile for one realm.
Author
Vlastimil Elias

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum

Field Summary

Modifier and TypeField and Description
private List<UPAttribute>
private List<UPGroup>
private UPConfig.UnmanagedAttributePolicy

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public UPConfig
public UPConfig
public UPConfig
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 UPAttribute
public List<UPAttribute>
public List<UPGroup>
public UPConfig.UnmanagedAttributePolicy
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.
public boolean
public void
public void
public void
public String
toString()

Overrides java.lang.Object.toString.

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

Field Detail

attributesback to summary
private List<UPAttribute> attributes
groupsback to summary
private List<UPGroup> groups
unmanagedAttributePolicyback to summary
private UPConfig.UnmanagedAttributePolicy unmanagedAttributePolicy

Constructor Detail

UPConfigback to summary
public UPConfig()

Method Detail

addGroupback to summary
public UPConfig addGroup(UPGroup group)
addOrReplaceAttributeback to summary
public UPConfig addOrReplaceAttribute(UPAttribute attribute)
cloneback to summary
public UPConfig 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:UPConfig

a clone of this instance.

Annotations
@Override
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
getAttributeback to summary
public UPAttribute getAttribute(String name)
Annotations
@JsonIgnore
getAttributesback to summary
public List<UPAttribute> getAttributes()
getGroupsback to summary
public List<UPGroup> getGroups()
getUnmanagedAttributePolicyback to summary
public UPConfig.UnmanagedAttributePolicy getUnmanagedAttributePolicy()
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
removeAttributeback to summary
public boolean removeAttribute(String name)
setAttributesback to summary
public void setAttributes(List<UPAttribute> attributes)
setGroupsback to summary
public void setGroups(List<UPGroup> groups)
setUnmanagedAttributePolicyback to summary
public void setUnmanagedAttributePolicy(UPConfig.UnmanagedAttributePolicy unmanagedAttributePolicy)
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.userprofile.config back to summary

public final Enum UPConfig.UnmanagedAttributePolicy

extends Enum<UPConfig.UnmanagedAttributePolicy>
Class Inheritance

Field Summary

Modifier and TypeField and Description
public static final UPConfig.UnmanagedAttributePolicy
ADMIN_EDIT

Unmanaged attributes are only available as read-write and only through the management interfaces.

public static final UPConfig.UnmanagedAttributePolicy
ADMIN_VIEW

Unmanaged attributes are only available as read-only and only through the management interfaces.

public static final UPConfig.UnmanagedAttributePolicy
ENABLED

Unmanaged attributes are enabled and available from any context.

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public static UPConfig.UnmanagedAttributePolicy
public static UPConfig.UnmanagedAttributePolicy[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

ADMIN_EDITback to summary
public static final UPConfig.UnmanagedAttributePolicy ADMIN_EDIT

Unmanaged attributes are only available as read-write and only through the management interfaces.

ADMIN_VIEWback to summary
public static final UPConfig.UnmanagedAttributePolicy ADMIN_VIEW

Unmanaged attributes are only available as read-only and only through the management interfaces.

ENABLEDback to summary
public static final UPConfig.UnmanagedAttributePolicy ENABLED

Unmanaged attributes are enabled and available from any context.

Constructor Detail

UnmanagedAttributePolicyback to summary
private UnmanagedAttributePolicy()

Method Detail

valueOfback to summary
public static UPConfig.UnmanagedAttributePolicy valueOf(String name)
valuesback to summary
public static UPConfig.UnmanagedAttributePolicy[] values()