Package oracle.pgx.config

Class AuthorizationEntityConfig

java.lang.Object

oracle.pgx.config.AbstractConfig

oracle.pgx.config.AbstractAuthorizationEntityConfig

oracle.pgx.config.AuthorizationEntityConfig

@Generated("config_generator.py")
public class AuthorizationEntityConfig
extends AbstractAuthorizationEntityConfig

PGX Permission Item Config

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AuthorizationEntityConfig.Field	Fields of PGX Permission Item Config

Nested classes/interfaces inherited from class oracle.pgx.config.AbstractAuthorizationEntityConfig

AbstractAuthorizationEntityConfig.Permissions

Field Summary

Fields inherited from class oracle.pgx.config.AbstractConfig

ENV_SEPARATOR, ENV_VARIABLE_PREFIX, SYSTEM_PROPERTY_PREFIX

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
static AuthorizationEntityConfig.Field[]	getConfigFields()
java.util.Map<java.lang.String,java.lang.Object>	getLeftoverValues()	Gets the values that do not belong to any field.
java.lang.Double	getMaxDataMemoryRatio()	memory limit of the authorization entity's private data (includes non-published graphs and PGQL results) relative to the maximum PGX engine memory limit for any user
java.lang.String	getMaxDataMemorySize()	absolute memory limit of the authorization entity's private data (includes non-published graphs and PGQL results), default memory unit is byte, can use (k, m, g, t, p) as prefix for (kilobyte, megabyte, gigabyte, terabyte, petabyte) units
java.util.List<AuthorizationEntityPermissionConfig>	getPgxPermissions()	mapping from resource id to list of permissions
java.lang.String	getPgxRole()	the id of the role
java.lang.String	getPgxUser()	the id of the user
java.util.Map<AuthorizationEntityConfig.Field,java.lang.Object>	getValues()	Gets the parsed values.
java.util.Map<AuthorizationEntityConfig.Field,java.lang.Object>	getValuesWithoutDefaults()	Gets the values without defaults.
boolean	hasDefaultValue(AuthorizationEntityConfig.Field field)	Checks for default value.
boolean	isEmpty()	Checks if it's empty.
static AuthorizationEntityConfig	parse(java.io.InputStream is, boolean strict, java.lang.String parentPath)	Parses an input stream.
static AuthorizationEntityConfig	parse(java.util.Map<java.lang.String,java.lang.Object> raw, boolean strict, java.lang.String parentPath)	Parses a raw key/value mapping.
static AuthorizationEntityConfig	parse(java.util.Properties props, boolean strict)	Parses a properties file.
java.lang.String	toString()
java.lang.String	toString(boolean hideSensitiveData)

Methods inherited from class oracle.pgx.config.AbstractAuthorizationEntityConfig

getAllPermissions, getGeneralPermissions, getMaxMemoryLimit, isRole, isUser

Methods inherited from class oracle.pgx.config.AbstractConfig

getDefault, getValueFromEnvironment, getValueFromEnvironment, parseString, setSerializable

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

parse

public static AuthorizationEntityConfig parse(java.io.InputStream is,
                                              boolean strict,
                                              java.lang.String parentPath)
                                       throws java.io.IOException

Parses an input stream.

Parameters:

is - the input stream

strict - if true, parses in strict mode

parentPath - if not null, resolves relative paths against this parentPath

Returns:

the parsed graph config

Throws:

java.io.IOException - Signals that an I/O exception has occurred.

parse

public static AuthorizationEntityConfig parse(java.util.Map<java.lang.String,java.lang.Object> raw,
                                              boolean strict,
                                              java.lang.String parentPath)

Parses a raw key/value mapping.

Parameters:

raw - the raw key/value mapping to parse

strict - if true, parses in strict mode

parentPath - if not null, resolves relative paths against this parentPath

Returns:

the parsed graph config

parse

public static AuthorizationEntityConfig parse(java.util.Properties props,
                                              boolean strict)

Parses a properties file.

Parameters:

props - the properties to parse

strict - if true, parses in strict mode

Returns:

the parsed graph config

getConfigFields

public static AuthorizationEntityConfig.Field[] getConfigFields()

getValues

public java.util.Map<AuthorizationEntityConfig.Field,java.lang.Object> getValues()

Gets the parsed values.

Specified by:

getValues in class AbstractConfig

Returns:

the parsed values

isEmpty

public boolean isEmpty()

Checks if it's empty.

Returns:

true, if the Map 'values' is empty.

hasDefaultValue

public boolean hasDefaultValue(AuthorizationEntityConfig.Field field)

Checks for default value.

Specified by:

hasDefaultValue in class AbstractAuthorizationEntityConfig

Parameters:

field - the field

Returns:

true, if value for given field is the default value

getValuesWithoutDefaults

public java.util.Map<AuthorizationEntityConfig.Field,java.lang.Object> getValuesWithoutDefaults()

Gets the values without defaults.

Returns:

the values without defaults

getLeftoverValues

public java.util.Map<java.lang.String,java.lang.Object> getLeftoverValues()

Gets the values that do not belong to any field.

Returns:

the values that do not belong to any field

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toString

public java.lang.String toString(boolean hideSensitiveData)

getPgxUser

public java.lang.String getPgxUser()

the id of the user

Specified by:

getPgxUser in class AbstractAuthorizationEntityConfig

getPgxRole

public java.lang.String getPgxRole()

the id of the role

Specified by:

getPgxRole in class AbstractAuthorizationEntityConfig

getPgxPermissions

public java.util.List<AuthorizationEntityPermissionConfig> getPgxPermissions()

mapping from resource id to list of permissions

getMaxDataMemorySize

public java.lang.String getMaxDataMemorySize()

absolute memory limit of the authorization entity's private data (includes non-published graphs and PGQL results), default memory unit is byte, can use (k, m, g, t, p) as prefix for (kilobyte, megabyte, gigabyte, terabyte, petabyte) units

Specified by:

getMaxDataMemorySize in class AbstractAuthorizationEntityConfig

getMaxDataMemoryRatio

public java.lang.Double getMaxDataMemoryRatio()

memory limit of the authorization entity's private data (includes non-published graphs and PGQL results) relative to the maximum PGX engine memory limit for any user

Specified by:

getMaxDataMemoryRatio in class AbstractAuthorizationEntityConfig

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object