Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.security.authc

Class RealmConfig.RealmIdentifier

java.lang.Object

org.elasticsearch.xpack.core.security.authc.RealmConfig.RealmIdentifier

All Implemented Interfaces:

Comparable<RealmConfig.RealmIdentifier>, Writeable, ToXContent, ToXContentObject

Enclosing class:

RealmConfig

public static class RealmConfig.RealmIdentifier
extends Object
implements Writeable, ToXContentObject, Comparable<RealmConfig.RealmIdentifier>

A realm identifier consists of a realm's type and name. Because realms are configured using a key that contains both of these parts (e.g. xpack.security.authc.realms.native.native_realm.order), it is often necessary to be able to pass this pair of variables as a single type (e.g. in method parameters, or return values).

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
RealmIdentifier(String type, String name)
RealmIdentifier(StreamInput in)

Method Summary

Modifier and Type	Method	Description
int	compareTo(RealmConfig.RealmIdentifier other)
boolean	equals(Object o)
String	getName()
String	getType()
int	hashCode()
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Constructor Details

RealmIdentifier

public RealmIdentifier(String type,
 String name)

RealmIdentifier

public RealmIdentifier(StreamInput in)
                throws IOException

Throws:

IOException

Method Details

getType

public String getType()

getName

public String getName()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

compareTo

public int compareTo(RealmConfig.RealmIdentifier other)

Specified by:

compareTo in interface Comparable<RealmConfig.RealmIdentifier>