Package com.gpudb.protocol

Class HasRoleRequest

java.lang.Object

com.gpudb.protocol.HasRoleRequest

All Implemented Interfaces:

org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord

public class HasRoleRequest
extends Object
implements org.apache.avro.generic.IndexedRecord

A set of parameters for GPUdb.hasRole.

Checks if the specified user has the specified role.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HasRoleRequest.Options	A set of string constants for the HasRoleRequest parameter options.

Constructor Summary

Constructors

Constructor	Description
HasRoleRequest()	Constructs a HasRoleRequest object with default parameters.
HasRoleRequest(String principal, String role, Map<String,String> options)	Constructs a HasRoleRequest object with the specified parameters.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
Object	get(int index)	This method supports the Avro framework and is not intended to be called directly by the user.
static org.apache.avro.Schema	getClassSchema()	This method supports the Avro framework and is not intended to be called directly by the user.
Map<String,String>	getOptions()	Optional parameters.
String	getPrincipal()	Name of the user for which role membership is being checked.
String	getRole()	Name of role to check for membership.
org.apache.avro.Schema	getSchema()	This method supports the Avro framework and is not intended to be called directly by the user.
int	hashCode()
void	put(int index, Object value)	This method supports the Avro framework and is not intended to be called directly by the user.
HasRoleRequest	setOptions(Map<String,String> options)	Optional parameters.
HasRoleRequest	setPrincipal(String principal)	Name of the user for which role membership is being checked.
HasRoleRequest	setRole(String role)	Name of role to check for membership.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

HasRoleRequest

public HasRoleRequest()

Constructs a HasRoleRequest object with default parameters.

HasRoleRequest

public HasRoleRequest(String principal,
                      String role,
                      Map<String,String> options)

Constructs a HasRoleRequest object with the specified parameters.

Parameters:

principal - Name of the user for which role membership is being checked. Must be an existing user. If blank, will use the current user. The default value is ''.

role - Name of role to check for membership.

options - Optional parameters.

• NO_ERROR_IF_NOT_EXISTS: If FALSE will return an error if the provided role does not exist or is blank. If TRUE then it will return FALSE for hasRole. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• ONLY_DIRECT: If FALSE will search recursively if the principal is a member of role. If TRUE then principal must directly be a member of role. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.

The default value is an empty Map.

Method Detail

getClassSchema

public static org.apache.avro.Schema getClassSchema()

This method supports the Avro framework and is not intended to be called directly by the user.

Returns:

The schema for the class.

getPrincipal

public String getPrincipal()

Name of the user for which role membership is being checked. Must be an existing user. If blank, will use the current user. The default value is ''.

Returns:

The current value of principal.

setPrincipal

public HasRoleRequest setPrincipal(String principal)

Name of the user for which role membership is being checked. Must be an existing user. If blank, will use the current user. The default value is ''.

Parameters:

principal - The new value for principal.

Returns:

this to mimic the builder pattern.

getRole

public String getRole()

Name of role to check for membership.

Returns:

The current value of role.

setRole

public HasRoleRequest setRole(String role)

Name of role to check for membership.

Parameters:

role - The new value for role.

Returns:

this to mimic the builder pattern.

getOptions

public Map<String,String> getOptions()

Optional parameters.

• NO_ERROR_IF_NOT_EXISTS: If FALSE will return an error if the provided role does not exist or is blank. If TRUE then it will return FALSE for hasRole. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• ONLY_DIRECT: If FALSE will search recursively if the principal is a member of role. If TRUE then principal must directly be a member of role. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.

The default value is an empty Map.

Returns:

The current value of options.

setOptions

public HasRoleRequest setOptions(Map<String,String> options)

Optional parameters.

• NO_ERROR_IF_NOT_EXISTS: If FALSE will return an error if the provided role does not exist or is blank. If TRUE then it will return FALSE for hasRole. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• ONLY_DIRECT: If FALSE will search recursively if the principal is a member of role. If TRUE then principal must directly be a member of role. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.

The default value is an empty Map.

Parameters:

options - The new value for options.

Returns:

this to mimic the builder pattern.

getSchema

public org.apache.avro.Schema getSchema()

This method supports the Avro framework and is not intended to be called directly by the user.

Specified by:

getSchema in interface org.apache.avro.generic.GenericContainer

Returns:

The schema object describing this class.

get

public Object get(int index)

This method supports the Avro framework and is not intended to be called directly by the user.

Specified by:

get in interface org.apache.avro.generic.IndexedRecord

Parameters:

index - the position of the field to get

Returns:

value of the field with the given index.

Throws:

IndexOutOfBoundsException

put

public void put(int index,
                Object value)

This method supports the Avro framework and is not intended to be called directly by the user.

Specified by:

put in interface org.apache.avro.generic.IndexedRecord

Parameters:

index - the position of the field to set

value - the value to set

Throws:

IndexOutOfBoundsException

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object