Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.security.authz.permission

Class RemoteClusterPermissionGroup

java.lang.Object

org.elasticsearch.xpack.core.security.authz.permission.RemoteClusterPermissionGroup

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, ToXContentObject

public class RemoteClusterPermissionGroup
extends Object
implements NamedWriteable, ToXContentObject

Represents a group of permissions for a remote cluster. For example: { "privileges" : ["monitor_enrich"], "clusters" : ["*"] }

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

Modifier and Type	Field	Description
static final String	NAME

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
RemoteClusterPermissionGroup(String[] clusterPrivileges, String[] remoteClusterAliases)
RemoteClusterPermissionGroup(Map<String,List<String>> remoteClusterGroup)
RemoteClusterPermissionGroup(StreamInput in)

Method Summary

Modifier and Type	Method	Description
String[]	clusterPrivileges()
boolean	equals(Object o)
String	getWriteableName()
int	hashCode()
boolean	hasPrivileges(String remoteClusterAlias)
String[]	remoteClusterAliases()
Map<String,List<String>>	toMap()	Converts the group to a map representation.
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

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

RemoteClusterPermissionGroup

public RemoteClusterPermissionGroup(StreamInput in)
                             throws IOException

Throws:

IOException

RemoteClusterPermissionGroup

public RemoteClusterPermissionGroup(Map<String,List<String>> remoteClusterGroup)

RemoteClusterPermissionGroup

public RemoteClusterPermissionGroup(String[] clusterPrivileges,
 String[] remoteClusterAliases)

Parameters:

clusterPrivileges - The list of cluster privileges that are allowed for the remote cluster. must not be null or empty.

remoteClusterAliases - The list of remote clusters that the privileges apply to. must not be null or empty.

Method Details

hasPrivileges

public boolean hasPrivileges(String remoteClusterAlias)

Parameters:

remoteClusterAlias - The remote cluster alias to check to see if has privileges defined in this group.

Returns:

true if the remote cluster alias has privileges defined in this group, false otherwise.

clusterPrivileges

public String[] clusterPrivileges()

Returns:

A copy of the cluster privileges.

remoteClusterAliases

public String[] remoteClusterAliases()

Returns:

A copy of the cluster aliases.

toMap

public Map<String,List<String>> toMap()

Converts the group to a map representation.

Returns:

A map representation of the group.

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

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

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface NamedWriteable