Package org.elasticsearch.client.security.support.expressiondsl.fields

Class FieldRoleMapperExpression

java.lang.Object

org.elasticsearch.client.security.support.expressiondsl.fields.FieldRoleMapperExpression

All Implemented Interfaces:

RoleMapperExpression, ToXContent, ToXContentObject

public class FieldRoleMapperExpression
extends Object
implements RoleMapperExpression

An expression that evaluates to true if a field (map element) matches the provided values. A field expression may have more than one provided value, in which case the expression is true if any of the values are matched.

Expression builder example:

 
 final RoleMapperExpression usernameExpression = FieldRoleMapperExpression.ofUsername("user1@example.org");
 
 

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
FieldRoleMapperExpression(String field, Object... values)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getField()
List<Object>	getValues()
int	hashCode()
static FieldRoleMapperExpression	ofDN(Object... values)
static FieldRoleMapperExpression	ofGroups(Object... values)
static FieldRoleMapperExpression	ofKeyValues(String key, Object... values)
static FieldRoleMapperExpression	ofMetadata(String key, Object... values)
static FieldRoleMapperExpression	ofUsername(Object... values)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

isFragment

Constructor Detail

FieldRoleMapperExpression

public FieldRoleMapperExpression(String field,
                                 Object... values)

Method Detail

getField

public String getField()

getValues

public List<Object> getValues()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

ofUsername

public static FieldRoleMapperExpression ofUsername(Object... values)

ofGroups

public static FieldRoleMapperExpression ofGroups(Object... values)

ofDN

public static FieldRoleMapperExpression ofDN(Object... values)

ofMetadata

public static FieldRoleMapperExpression ofMetadata(String key,
                                                   Object... values)

ofKeyValues

public static FieldRoleMapperExpression ofKeyValues(String key,
                                                    Object... values)