Package se.curity.identityserver.sdk.attribute

Class MapAttributeValue

Object

se.curity.identityserver.sdk.attribute.MapAttributeValue

All Implemented Interfaces:

Iterable<Attribute>, AttributeContainer<MapAttributeValue>, AttributeOrAttributeValue<AttributeValue>, AttributeValue

Direct Known Subclasses:

AuthorizationActionAttributes, AuthorizationResourceAttributes, ComplexAttributeValue, ContextAttributes, Meta, Name, SubjectAttributes

public class MapAttributeValue
extends Object
implements AttributeValue, AttributeContainer<MapAttributeValue>

An AttributeValue representing multiple Attribute instances, similar to a Map where the keys are the names of the attributes, and the values the Attributes themselves.

Since version 5.0.0, instances of this class can contain multiple attributes with the same name, as long as they have distinct authorities. However, some accessor methods will only expose one of them (e.g. get(String).

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MapAttributeValue(Iterable<Attribute> attributes)

Method Summary

Modifier and Type	Method	Description
MapAttributeValue	append(Iterable<Attribute> attributes)	Appends the given attribute to a copy of this, returning the result.
MapAttributeValue	append(Attribute attribute)	Appends the given attribute to a copy of this, returning the result.
MapAttributeValue	delete(String attributeKey)
boolean	equals(Object other)
@Nullable Attribute	get(String name)	Get the attribute with the given name if it exists, or null otherwise.
@Nullable Attribute	get(String... pathParts)
Collection<Attribute>	getAll(String name)	Get a collection containing all attributes with the given name and distinct authorities.
Map<String,Attribute>	getAttributesByName()	Returns a Map where the keys are attribute names and the values are attributes.
<T extends Comparable<T>> T	getMandatory(Class<T> type, String... pathParts)
final @Nonnull Map<String,Object>	getValue()
final Map<String,Object>	getValueWithAuthorities()	Returns a map-based representation of the attribute value allowing for multiple nested attributes with the same name and different authorities.
final @Nonnull Map<String,Object>	getValueWithMetadata()
int	hashCode()
boolean	isEmpty()
@Nonnull Iterator<Attribute>	iterator()
Set<String>	keys()
protected static <T, R> R	map(@Nullable T value, Function<T,R> transform, Supplier<R> defaultValueSupplier)
protected static <T, R> R	map(@Nullable T value, NullableFunction<T,R> transform)
@Nullable AttributeValue	map(String path, AttributeOrAttributeValueTransformer transform)	Apply the provided transformation on each Attribute and AttributeValue in this attribute tree, recursively.
MapAttributeValue	mapEntries(String path, AttributeOrAttributeValueTransformer transform)	Maps all the entries of this MapAttributeValue recursively.
MapAttributeValue	mapNonRecursive(AttributeOrAttributeValueTransformer transform)	Maps the entries of this Map without recursion into each entry.
protected static <T> T	nullOrOfType(Class<T> type, @Nullable Object object)
static MapAttributeValue	of(Iterable<Attribute> attributes)
static MapAttributeValue	of(Map<?,?> map)
static MapAttributeValue	of(Map<?,?> map, String nameFormat)	Create a MapAttributeValue object from a Map.
MapAttributeValue	removeAttributes(Set<String> exclusionNames)	Remove all top-level attributes whose names are in the given Set.
MapAttributeValue	removeNullAttributeValues()
MapAttributeValue	retainAttributes(Set<String> inclusionNames)	Retain all attributes whose names are in the given Set.
int	size()
Stream<Attribute>	stream()	Returns a stream of the Attributes in the container.
String	toString()
MapAttributeValue	with(Iterable<Attribute> attributes)	Add the given attributes if not present, or replace the attribute if it already exists.
MapAttributeValue	with(Attribute attribute)	Add the given attribute if not present, or replace the attribute if it already exists.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface se.curity.identityserver.sdk.attribute.AttributeContainer

contains, contains, getOptionalValue, getOptionalValue, removeAttribute, retainAttribute

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

MapAttributeValue

protected MapAttributeValue(Iterable<Attribute> attributes)

Method Details

nullOrOfType

@Nullable
protected static <T> T nullOrOfType(Class<T> type,
 @Nullable Object object)

map

protected static <T,
R> R map(@Nullable T value,
 Function<T,R> transform,
 Supplier<R> defaultValueSupplier)

map

@Nullable
protected static <T,
R> R map(@Nullable T value,
 NullableFunction<T,R> transform)

of

public static MapAttributeValue of(Iterable<Attribute> attributes)

of

public static MapAttributeValue of(Map<?,?> map,
 String nameFormat)

Create a MapAttributeValue object from a Map.

Parameters:

map - the attribute values to create an map of attribute values from

nameFormat - the format of the name

Returns:

the new MapAttributeValue object

Since:

2.1.0

See Also:

• AttributeValue

of

public static MapAttributeValue of(Map<?,?> map)

getValue

@Nonnull
public final @Nonnull Map<String,Object> getValue()

Specified by:

getValue in interface AttributeOrAttributeValue<AttributeValue>

Returns:

the value of this entity.

getValueWithMetadata

@Nonnull
public final @Nonnull Map<String,Object> getValueWithMetadata()

Specified by:

getValueWithMetadata in interface AttributeOrAttributeValue<AttributeValue>

Returns:

the value of this entity, including any metadata it might have.

getValueWithAuthorities

public final Map<String,Object> getValueWithAuthorities()

Returns a map-based representation of the attribute value allowing for multiple nested attributes with the same name and different authorities. The format is the following:

• Each attribute is represented by an entry with key: <attribute-full-name>@<attribute-authority>. If the attribute doesn't have an authority, then the key is just <attribute-full-name>
• There is an additional {code @authorities} key, whose value is a map. Each entry in that inner map corresponds to an attribute name, and its value is a list of all authorities for attributes with that name.

As an example, this is the JSON representation of the map produced by an instance containing two attribute named the-name and having authorities authority1 and authority2

  
  {
      "the-name@authority1": ...,
      "the-name@authority2": ...,
      "@authorities": {
          "the-name": ["authority1", "authority2"]
      }
  }
  
  

Specified by:

getValueWithAuthorities in interface AttributeValue

Returns:

a representation of the attribute value allowing for multiple nested attributes with the same name and different authorities.

getAttributesByName

public Map<String,Attribute> getAttributesByName()

Returns a Map where the keys are attribute names and the values are attributes. If there are multiple attributes with the same name, then only one of them is returned.

Returns:

a Map from attribute name to attribute.

size

public int size()

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface AttributeValue

Returns:

true if this AttributeValue is semantically empty, ie. has no value.

keys

public Set<String> keys()

append

public MapAttributeValue append(Attribute attribute)

Description copied from interface: AttributeContainer

Appends the given attribute to a copy of this, returning the result.

Specified by:

append in interface AttributeContainer<MapAttributeValue>

Parameters:

attribute - to append

Returns:

copy of this with the provided attribute appended to it

append

public MapAttributeValue append(Iterable<Attribute> attributes)

Description copied from interface: AttributeContainer

Appends the given attribute to a copy of this, returning the result.

Specified by:

append in interface AttributeContainer<MapAttributeValue>

Parameters:

attributes - to append

Returns:

copy of this with the provided attribute appended to it

with

public MapAttributeValue with(Attribute attribute)

Description copied from interface: AttributeContainer

Add the given attribute if not present, or replace the attribute if it already exists. Note that two attributes with the same name and different authorities are considered distinct.

Specified by:

with in interface AttributeContainer<MapAttributeValue>

Parameters:

attribute - attribute to add or to override

Returns:

a copy of this which contains the given Attribute

with

public MapAttributeValue with(Iterable<Attribute> attributes)

Description copied from interface: AttributeContainer

Add the given attributes if not present, or replace the attribute if it already exists. Note that two attributes with the same name and different authorities are considered distinct.

Specified by:

with in interface AttributeContainer<MapAttributeValue>

Parameters:

attributes - attribute to add or to override

Returns:

a copy of this which contains the given Attributes

get

@Nullable
public @Nullable Attribute get(String name)

Description copied from interface: AttributeContainer

Get the attribute with the given name if it exists, or null otherwise. If multiple attributes with the same name exist (e.g. with different authorities), then one of those attributes will be returned.

Specified by:

get in interface AttributeContainer<MapAttributeValue>

Parameters:

name - of attribute

Returns:

one of the attributes with the given name if any, or null otherwise.

getAll

public Collection<Attribute> getAll(String name)

Description copied from interface: AttributeContainer

Get a collection containing all attributes with the given name and distinct authorities.

Specified by:

getAll in interface AttributeContainer<MapAttributeValue>

Parameters:

name - of attribute

Returns:

an unmodifiable collection with all the contained attributes with the given name.

stream

public Stream<Attribute> stream()

Description copied from interface: AttributeContainer

Returns a stream of the Attributes in the container.

Specified by:

stream in interface AttributeContainer<MapAttributeValue>

Returns:

a Stream of the Attributes contained in the container.

iterator

@Nonnull
public @Nonnull Iterator<Attribute> iterator()

Specified by:

iterator in interface Iterable<Attribute>

mapNonRecursive

public MapAttributeValue mapNonRecursive(AttributeOrAttributeValueTransformer transform)

Maps the entries of this Map without recursion into each entry.

To use recursion, use the mapEntries(String, AttributeOrAttributeValueTransformer) method.

Parameters:

transform - transformation function

Returns:

the transformed Map

map

@Nullable
public @Nullable AttributeValue map(String path,
 AttributeOrAttributeValueTransformer transform)

Description copied from interface: AttributeOrAttributeValue

Apply the provided transformation on each Attribute and AttributeValue in this attribute tree, recursively.

Specified by:

map in interface AttributeOrAttributeValue<AttributeValue>

Specified by:

map in interface AttributeValue

Parameters:

path - of the current attribute or value being transformed.

transform - transformation function.

Returns:

the transformed attribute or value

mapEntries

public MapAttributeValue mapEntries(String path,
 AttributeOrAttributeValueTransformer transform)

Maps all the entries of this MapAttributeValue recursively.

This method is similar to the map(String, AttributeOrAttributeValueTransformer) method, but it may not be used to transform the Map itself, hence it always return a non-null MapAttributeValue.

Parameters:

path - of the root

transform - transformation function.

Returns:

the transformed Map

getMandatory

public <T extends Comparable<T>> T getMandatory(Class<T> type,
 String... pathParts)

Throws:

NoSuchElementException - if mandatory attributes are missing

get

@Nullable
public @Nullable Attribute get(String... pathParts)

removeNullAttributeValues

public MapAttributeValue removeNullAttributeValues()

Returns:

a copy of this containing no instances of NullAttributeValue.

removeAttributes

public MapAttributeValue removeAttributes(Set<String> exclusionNames)

Description copied from interface: AttributeContainer

Remove all top-level attributes whose names are in the given Set.

Specified by:

removeAttributes in interface AttributeContainer<MapAttributeValue>

Parameters:

exclusionNames - names of attributes to exclude.

Returns:

this Attributes without the excluded top-level attributes

retainAttributes

public MapAttributeValue retainAttributes(Set<String> inclusionNames)

Description copied from interface: AttributeContainer

Retain all attributes whose names are in the given Set. All attributes that are not named in the set are removed.

Specified by:

retainAttributes in interface AttributeContainer<MapAttributeValue>

Parameters:

inclusionNames - names of attributes to retain.

Returns:

this Attributes with only the included attributes

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

delete

public MapAttributeValue delete(String attributeKey)

toString

public String toString()

Overrides:

toString in class Object