Module org.elasticsearch.xcore

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

Class ApplicationPrivilegeDescriptor

java.lang.Object

org.elasticsearch.xpack.core.security.authz.privilege.ApplicationPrivilegeDescriptor

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

public class ApplicationPrivilegeDescriptor
extends Object
implements ToXContentObject, Writeable

An ApplicationPrivilegeDescriptor is a representation of a stored ApplicationPrivilege. A user (via a role) can be granted an application privilege by name (e.g. ("myapp", "read"). In general, this privilege name will correspond to a pre-defined ApplicationPrivilegeDescriptor, which then is used to determine the set of actions granted by the privilege.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ApplicationPrivilegeDescriptor.Fields

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	DOC_TYPE_VALUE

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ApplicationPrivilegeDescriptor(String application, String name, Set<String> actions, Map<String,Object> metadata)
ApplicationPrivilegeDescriptor(StreamInput input)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Set<String>	getActions()
String	getApplication()
Map<String,Object>	getMetadata()
String	getName()
int	hashCode()
static ApplicationPrivilegeDescriptor	parse(XContentParser parser, String defaultApplication, String defaultName, boolean allowType)	Construct a new ApplicationPrivilegeDescriptor from XContent.
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, boolean includeTypeField)
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

DOC_TYPE_VALUE

public static final String DOC_TYPE_VALUE

See Also:

• Constant Field Values

Constructor Details

ApplicationPrivilegeDescriptor

public ApplicationPrivilegeDescriptor(String application,
 String name,
 Set<String> actions,
 Map<String,Object> metadata)

ApplicationPrivilegeDescriptor

public ApplicationPrivilegeDescriptor(StreamInput input)
                               throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

getApplication

public String getApplication()

getName

public String getName()

getActions

public Set<String> getActions()

getMetadata

public Map<String,Object> getMetadata()

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 boolean includeTypeField)
                           throws IOException

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object

parse

public static ApplicationPrivilegeDescriptor parse(XContentParser parser,
 String defaultApplication,
 String defaultName,
 boolean allowType)
                                            throws IOException

Construct a new ApplicationPrivilegeDescriptor from XContent.

Parameters:

defaultApplication - The application name to use if none is specified in the XContent body

defaultName - The privilege name to use if none is specified in the XContent body

allowType - If true, accept a "type" field (for which the value must match DOC_TYPE_VALUE);

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object