Index (auth-api 0.14.1-2 API)

A B C D E F G H I L O P R S T U V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

Actor - Class in com.datahub.authentication: Represents a unique DataHub actor (i.e.
Actor() - Constructor for class com.datahub.authentication.Actor
ActorType - Enum Class in com.datahub.authentication: A specific type of Actor on DataHub's platform.
ALLOW - Enum constant in enum class com.datahub.authorization.AuthorizationResult.Type: Allow the request - the requested actor is privileged.
authenticate(AuthenticationRequest) - Method in interface com.datahub.plugins.auth.authentication.Authenticator: Authenticates an inbound request given an instance of the AuthenticationRequest.
Authentication - Class in com.datahub.authentication: Class representing an authenticated actor accessing DataHub.
Authentication(Actor, String) - Constructor for class com.datahub.authentication.Authentication
Authentication(Actor, String, Map<String, Object>) - Constructor for class com.datahub.authentication.Authentication
AuthenticationContext - Class in com.datahub.authentication: A static wrapper around a ThreadLocal instance of Authentication containing information about the currently authenticated actor.
AuthenticationException - Exception in com.datahub.authentication: An Exception thrown when an Authenticator is unable to be resolved an instance of Authentication for the current request.
AuthenticationException(String) - Constructor for exception com.datahub.authentication.AuthenticationException
AuthenticationException(String, Throwable) - Constructor for exception com.datahub.authentication.AuthenticationException
AuthenticationExpiredException - Exception in com.datahub.authentication: An Exception thrown when an Authenticator is unable to be resolve an instance of Authentication for the current request.
AuthenticationExpiredException(String) - Constructor for exception com.datahub.authentication.AuthenticationExpiredException
AuthenticationExpiredException(String, Throwable) - Constructor for exception com.datahub.authentication.AuthenticationExpiredException
AuthenticationRequest - Class in com.datahub.authentication: Request context provided to each Authenticator to perform Authentication.
AuthenticationRequest(String, String, Map<String, String>) - Constructor for class com.datahub.authentication.AuthenticationRequest
AuthenticationRequest(Map<String, String>) - Constructor for class com.datahub.authentication.AuthenticationRequest
Authenticator - Interface in com.datahub.plugins.auth.authentication: An Authenticator's job is to authenticate an inbound request by resolving the provided AuthenticationRequest to an instance of Authentication, which includes an authenticated Actor within.
AuthenticatorContext - Class in com.datahub.authentication: Context class to provide Authenticator implementations with concrete objects necessary for their correct workings.
AuthenticatorContext(Map<String, Object>) - Constructor for class com.datahub.authentication.AuthenticatorContext
AuthorizationRequest - Class in com.datahub.authorization: A request to authorize a user for a specific privilege.
AuthorizationRequest() - Constructor for class com.datahub.authorization.AuthorizationRequest
AuthorizationResult - Class in com.datahub.authorization: A result returned after requesting authorization for a particular privilege.
AuthorizationResult() - Constructor for class com.datahub.authorization.AuthorizationResult
AuthorizationResult.Type - Enum Class in com.datahub.authorization: The result type.
AuthorizationSession - Interface in com.datahub.authorization: Combines a common interface for actor and authorizer which is cached per session
authorize(AuthorizationRequest) - Method in interface com.datahub.plugins.auth.authorization.Authorizer: Authorizes an action based on the actor, the resource, and required privileges.
authorize(String, EntitySpec) - Method in interface com.datahub.authorization.AuthorizationSession
authorizedActors(String, Optional<EntitySpec>) - Method in interface com.datahub.plugins.auth.authorization.Authorizer: Retrieves the current list of actors authorized to for a particular privilege against an optional resource
AuthorizedActors - Class in com.datahub.authorization
AuthorizedActors() - Constructor for class com.datahub.authorization.AuthorizedActors
Authorizer - Interface in com.datahub.plugins.auth.authorization: An Authorizer is responsible for determining whether an actor should be granted a specific privilege.
AuthorizerContext - Class in com.datahub.authorization: Context provided to an Authorizer on initialization.
AuthorizerContext() - Constructor for class com.datahub.authorization.AuthorizerContext
AuthUtil - Class in com.datahub.authorization: Notes: This class is an attempt to unify privilege checks across APIs.

B

buildDisjunctivePrivilegeGroup(ApiGroup, ApiOperation, String) - Static method in class com.datahub.authorization.AuthUtil

C

canViewEntity(AuthorizationSession, Urn) - Static method in class com.datahub.authorization.AuthUtil: GraphQL Methods
canViewEntity(AuthorizationSession, Collection<Urn>) - Static method in class com.datahub.authorization.AuthUtil
com.datahub.authentication - package com.datahub.authentication
com.datahub.authorization - package com.datahub.authorization
com.datahub.authorization.config - package com.datahub.authorization.config
com.datahub.plugins - package com.datahub.plugins
com.datahub.plugins.auth.authentication - package com.datahub.plugins.auth.authentication
com.datahub.plugins.auth.authorization - package com.datahub.plugins.auth.authorization
ConjunctivePrivilegeGroup - Class in com.datahub.authorization: Represents a group of privileges that must ALL be required to authorize a request.
ConjunctivePrivilegeGroup(Collection<String>) - Constructor for class com.datahub.authorization.ConjunctivePrivilegeGroup

D

data() - Method in class com.datahub.authentication.AuthenticatorContext
data() - Method in class com.datahub.authorization.AuthorizerContext
DATA_PLATFORM_INSTANCE - Enum constant in enum class com.datahub.authorization.EntityFieldType: Data platform instance of resource
DENY - Enum constant in enum class com.datahub.authorization.AuthorizationResult.Type: Deny the request - the requested actor is not privileged.
DisjunctivePrivilegeGroup - Class in com.datahub.authorization: Represents a group of privilege groups, any of which must be authorized to authorize a request.
DisjunctivePrivilegeGroup(Collection<ConjunctivePrivilegeGroup>) - Constructor for class com.datahub.authorization.DisjunctivePrivilegeGroup
DOMAIN - Enum constant in enum class com.datahub.authorization.EntityFieldType: Domains of the entity

E

EMPTY - Static variable in interface com.datahub.plugins.auth.authorization.Authorizer
emptyFieldValue() - Static method in class com.datahub.authorization.FieldResolver
EntityFieldType - Enum Class in com.datahub.authorization: List of entity field types to fetch for a given entity
EntitySpec - Class in com.datahub.authorization: Details about the entities involved in the authorization process.
EntitySpec() - Constructor for class com.datahub.authorization.EntitySpec
EntitySpecResolver - Interface in com.datahub.authorization: An Entity Spec Resolver is responsible for resolving a EntitySpec to a ResolvedEntitySpec.
equals(Object) - Method in class com.datahub.authentication.Actor
equals(Object) - Method in class com.datahub.authorization.ConjunctivePrivilegeGroup
equals(Object) - Method in class com.datahub.authorization.DisjunctivePrivilegeGroup

F

FieldResolver - Class in com.datahub.authorization: Helper class for lazy resolution of fields Input resolveField function that is given as input will only be called when getFieldValuesFuture is called
FieldResolver() - Constructor for class com.datahub.authorization.FieldResolver
FieldResolver.FieldValue - Class in com.datahub.authorization: Container for storing the field value, in case we need to extend this to have more types of field values
FieldValue() - Constructor for class com.datahub.authorization.FieldResolver.FieldValue

G

getActor() - Method in class com.datahub.authentication.Authentication
getActorGroups(Urn) - Method in interface com.datahub.plugins.auth.authorization.Authorizer: Given the actor's urn retrieve the actor's groups
getActorPeers(Urn) - Method in interface com.datahub.plugins.auth.authorization.Authorizer: Given an actor's urn retrieve the actor's peers
getActorPolicies(Urn) - Method in interface com.datahub.plugins.auth.authorization.Authorizer: Given the actor's urn retrieve the policies.
getAuthentication() - Static method in class com.datahub.authentication.AuthenticationContext
getAuthorizedPrivilegeGroups() - Method in class com.datahub.authorization.DisjunctivePrivilegeGroup
getClaims() - Method in class com.datahub.authentication.Authentication
getCredentials() - Method in class com.datahub.authentication.Authentication
getDataPlatformInstance() - Method in class com.datahub.authorization.ResolvedEntitySpec: Fetch the platform instance for a Resolved Resource Spec
getFieldValues(EntityFieldType) - Method in class com.datahub.authorization.ResolvedEntitySpec
getGroupMembership() - Method in class com.datahub.authorization.ResolvedEntitySpec: Fetch the group membership for an entity.
getOwners() - Method in class com.datahub.authorization.ResolvedEntitySpec: Fetch the owners for an entity.
getRequestHeaders() - Method in class com.datahub.authentication.AuthenticationRequest
getRequiredPrivileges() - Method in class com.datahub.authorization.ConjunctivePrivilegeGroup
getResolverFromFunction(EntitySpec, Function<EntitySpec, FieldResolver.FieldValue>) - Static method in class com.datahub.authorization.FieldResolver: Helper function that returns FieldResolver given a fetchFieldValue function
getResolverFromValues(Set<String>) - Static method in class com.datahub.authorization.FieldResolver: Helper function that returns FieldResolver for precomputed values
GROUP_MEMBERSHIP - Enum constant in enum class com.datahub.authorization.EntityFieldType: Groups of which the entity (only applies to corpUser) is a member

H

hashCode() - Method in class com.datahub.authentication.Actor
hashCode() - Method in class com.datahub.authorization.ConjunctivePrivilegeGroup
hashCode() - Method in class com.datahub.authorization.DisjunctivePrivilegeGroup

I

init(Map<String, Object>, AuthenticatorContext) - Method in interface com.datahub.plugins.auth.authentication.Authenticator: Initialize the Authenticator.
init(Map<String, Object>, AuthorizerContext) - Method in interface com.datahub.plugins.auth.authorization.Authorizer: Initialize the Authorizer.
isAPIAuthorized(AuthorizationSession, ApiGroup, ApiOperation) - Static method in class com.datahub.authorization.AuthUtil
isAPIAuthorized(AuthorizationSession, ApiGroup, EntityRegistry, Collection<MetadataChangeProposal>) - Static method in class com.datahub.authorization.AuthUtil: OpenAPI/Rest.li Methods
isAPIAuthorized(AuthorizationSession, PoliciesConfig.Privilege) - Static method in class com.datahub.authorization.AuthUtil
isAPIAuthorized(AuthorizationSession, PoliciesConfig.Privilege, EntitySpec) - Static method in class com.datahub.authorization.AuthUtil
isAPIAuthorizedEntityType(AuthorizationSession, ApiGroup, ApiOperation, String) - Static method in class com.datahub.authorization.AuthUtil
isAPIAuthorizedEntityType(AuthorizationSession, ApiGroup, ApiOperation, Collection<String>) - Static method in class com.datahub.authorization.AuthUtil
isAPIAuthorizedEntityType(AuthorizationSession, ApiOperation, String) - Static method in class com.datahub.authorization.AuthUtil
isAPIAuthorizedEntityType(AuthorizationSession, ApiOperation, Collection<String>) - Static method in class com.datahub.authorization.AuthUtil
isAPIAuthorizedEntityUrns(AuthorizationSession, ApiOperation, Collection<Urn>) - Static method in class com.datahub.authorization.AuthUtil
isAPIAuthorizedResult(AuthorizationSession, BrowseResult) - Static method in class com.datahub.authorization.AuthUtil
isAPIAuthorizedResult(AuthorizationSession, AutoCompleteResult) - Static method in class com.datahub.authorization.AuthUtil
isAPIAuthorizedResult(AuthorizationSession, ScrollResult) - Static method in class com.datahub.authorization.AuthUtil
isAPIAuthorizedResult(AuthorizationSession, SearchResult) - Static method in class com.datahub.authorization.AuthUtil
isAPIAuthorizedUrns(AuthorizationSession, ApiGroup, ApiOperation, Collection<Urn>) - Static method in class com.datahub.authorization.AuthUtil
isAPIAuthorizedUrns(AuthorizationSession, ApiGroup, Collection<Pair<ChangeType, Urn>>) - Static method in class com.datahub.authorization.AuthUtil
isAuthorized(AuthorizationSession, DisjunctivePrivilegeGroup, EntitySpec) - Static method in class com.datahub.authorization.AuthUtil
isAuthorized(AuthorizationSession, ApiGroup, ApiOperation) - Static method in class com.datahub.authorization.AuthUtil
isAuthorized(AuthorizationSession, PoliciesConfig.Privilege) - Static method in class com.datahub.authorization.AuthUtil
isAuthorized(AuthorizationSession, PoliciesConfig.Privilege, EntitySpec) - Static method in class com.datahub.authorization.AuthUtil
isAuthorizedEntityType(AuthorizationSession, ApiOperation, Collection<String>) - Static method in class com.datahub.authorization.AuthUtil
isAuthorizedEntityUrns(AuthorizationSession, ApiOperation, Collection<Urn>) - Static method in class com.datahub.authorization.AuthUtil
isAuthorizedUrns(AuthorizationSession, ApiGroup, ApiOperation, Collection<Urn>) - Static method in class com.datahub.authorization.AuthUtil

L

lookupAPIPrivilege(ApiGroup, ApiOperation, String) - Static method in class com.datahub.authorization.AuthUtil: Based on an API group and operation return privileges.

O

OWNER - Enum constant in enum class com.datahub.authorization.EntityFieldType: Owners of the entity

P

Plugin - Interface in com.datahub.plugins: A tag interface for plugin
PLUGIN_HOME - Static variable in class com.datahub.plugins.PluginConstant
PluginConstant - Class in com.datahub.plugins

R

remove() - Static method in class com.datahub.authentication.AuthenticationContext
resolve(EntitySpec) - Method in interface com.datahub.authorization.EntitySpecResolver: Resolve a EntitySpec to a resolved entity spec.
ResolvedEntitySpec - Class in com.datahub.authorization: Wrapper around authorization request with field resolvers for lazily fetching the field values for each field type
ResolvedEntitySpec() - Constructor for class com.datahub.authorization.ResolvedEntitySpec
RESOURCE_TYPE - Enum constant in enum class com.datahub.authorization.EntityFieldType: Deprecated.
RESOURCE_URN - Enum constant in enum class com.datahub.authorization.EntityFieldType: Deprecated.

S

setAuthentication(Authentication) - Static method in class com.datahub.authentication.AuthenticationContext

T

TAG - Enum constant in enum class com.datahub.authorization.EntityFieldType: Tags of the entity
toString() - Method in class com.datahub.authorization.ConjunctivePrivilegeGroup
toString() - Method in class com.datahub.authorization.DisjunctivePrivilegeGroup
toUrnStr() - Method in class com.datahub.authentication.Actor
type - Variable in class com.datahub.authorization.AuthorizationResult: The decision - whether to allow or deny the request.
TYPE - Enum constant in enum class com.datahub.authorization.EntityFieldType: Type of the entity (e.g.

U

URN - Enum constant in enum class com.datahub.authorization.EntityFieldType: Urn of the entity
USER - Enum constant in enum class com.datahub.authentication.ActorType: A user actor, e.g.

V

valueOf(String) - Static method in enum class com.datahub.authentication.ActorType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.datahub.authorization.AuthorizationResult.Type: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.datahub.authorization.EntityFieldType: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.datahub.authentication.ActorType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.datahub.authorization.AuthorizationResult.Type: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.datahub.authorization.EntityFieldType: Returns an array containing the constants of this enum class, in the order they are declared.
VIEW_RESTRICTED_ENTITY_TYPES - Static variable in class com.datahub.authorization.AuthUtil: This should generally follow the policy creation UI with a few exceptions for users, groups, containers, etc so that the platform still functions as expected.
ViewAuthorizationConfiguration - Class in com.datahub.authorization.config
ViewAuthorizationConfiguration() - Constructor for class com.datahub.authorization.config.ViewAuthorizationConfiguration
ViewAuthorizationConfiguration.ViewAuthorizationRecommendationsConfig - Class in com.datahub.authorization.config
ViewAuthorizationRecommendationsConfig() - Constructor for class com.datahub.authorization.config.ViewAuthorizationConfiguration.ViewAuthorizationRecommendationsConfig

A B C D E F G H I L O P R S T U V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form