Module org.elasticsearch.xcore

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

Class Authentication.RealmRef

java.lang.Object

org.elasticsearch.xpack.core.security.authc.Authentication.RealmRef

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

Enclosing class:

Authentication

public static class Authentication.RealmRef
extends Object
implements Writeable, ToXContentObject

Authentication.RealmRef expresses the grouping of realms, identified with RealmConfig.RealmIdentifiers, under RealmDomains. A domain groups different realms, such that any username, authenticated by different realms from the same domain, is to be associated to a single Profile.

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
RealmRef(String name, String type, String nodeName)
RealmRef(String name, String type, String nodeName, RealmDomain domain)
RealmRef(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
RealmDomain	getDomain()	Returns the domain assignment for the realm, if one assigned, or null otherwise, as per the RealmSettings#DOMAIN_TO_REALM_ASSOC_SETTING setting.
RealmConfig.RealmIdentifier	getIdentifier()	The RealmIdentifier is the fully qualified way to refer to a realm.
String	getName()
String	getNodeName()
String	getType()
int	hashCode()
static Authentication.RealmRef	newAnonymousRealmRef(String nodeName)
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

RealmRef

public RealmRef(String name,
 String type,
 String nodeName)

RealmRef

public RealmRef(String name,
 String type,
 String nodeName,
 @Nullable
 RealmDomain domain)

RealmRef

public RealmRef(StreamInput in)
         throws IOException

Throws:

IOException

Method Details

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

getNodeName

public String getNodeName()

getName

public String getName()

getType

public String getType()

getDomain

@Nullable
public RealmDomain getDomain()

Returns the domain assignment for the realm, if one assigned, or null otherwise, as per the RealmSettings#DOMAIN_TO_REALM_ASSOC_SETTING setting.

getIdentifier

public RealmConfig.RealmIdentifier getIdentifier()

The RealmIdentifier is the fully qualified way to refer to a realm.

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

newAnonymousRealmRef

public static Authentication.RealmRef newAnonymousRealmRef(String nodeName)