org.apache.ambari.server.state.kerberos

Class KerberosIdentityDescriptor

java.lang.Object

org.apache.ambari.server.state.kerberos.AbstractKerberosDescriptor

org.apache.ambari.server.state.kerberos.KerberosIdentityDescriptor

public class KerberosIdentityDescriptor
extends AbstractKerberosDescriptor

KerberosIdentityDescriptor is an implementation of an AbstractKerberosDescriptor that encapsulates data related to a Kerberos identity - including its principal and keytab file details.

A KerberosIdentityDescriptor has the following properties:

• name
• principal
• keytab

The following (pseudo) JSON Schema will yield a valid KerberosIdentityDescriptor

   {
      "$schema": "http://json-schema.org/draft-04/schema#",
      "title": "KerberosIdentityDescriptor",
      "description": "Describes a Kerberos identity",
      "type": "object",
      "properties": {
        "name": {
          "description": "An identifying name for this identity. The name may reference another
                          KerberosIdentityDescriptor by declaring the path to it",
          "type": "string"
        },
        "principal": {
          "description": "Details about this identity's principal",
          "type": "KerberosPrincipalDescriptor",
        }
        "keytab": {
          "description": "Details about this identity's keytab",
          "type": "KerberosKeytabDescriptor",
          }
        }
      }
   }
 

In this implementation, AbstractKerberosDescriptor.name will hold the KerberosIdentityDescriptor#name value

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.ambari.server.state.kerberos.AbstractKerberosDescriptor

AbstractKerberosDescriptor.Type

Constructor Summary

Constructors

Constructor and Description
KerberosIdentityDescriptor(Map<?,?> data) Creates a new KerberosIdentityDescriptor See KerberosIdentityDescriptor for the JSON Schema that may be used to generate this map.
KerberosIdentityDescriptor(String name, String reference, KerberosPrincipalDescriptor principal, KerberosKeytabDescriptor keytab, Predicate when) Creates a new KerberosIdentityDescriptor

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object object)
List<KerberosIdentityDescriptor>	findReferences() Find all of the KerberosIdentityDescriptors that reference this KerberosIdentityDescriptor
KerberosKeytabDescriptor	getKeytabDescriptor() Gets the KerberosKeytabDescriptor related to this KerberosIdentityDescriptor
String	getPath() Calculate the path to this identity descriptor for logging purposes.
KerberosPrincipalDescriptor	getPrincipalDescriptor() Gets the KerberosPrincipalDescriptor related to this KerberosIdentityDescriptor
String	getReference() Gets the path to the referenced Kerberos identity definition
String	getReferenceAbsolutePath() Gets the absolute path to the referenced Kerberos identity definition
com.google.common.base.Optional<String>	getReferencedServiceName() A name that refers to a service has a format like /[/[/]]
Predicate	getWhen() Gets the expression (or Predicate) to use to determine when to include this Kerberos identity while processing Kerberos identities.
int	hashCode()
boolean	isReference() Determines whether this KerberosIdentityDescriptor indicates it is a refrence to some other KerberosIdentityDescriptor.
boolean	isShared(KerberosIdentityDescriptor that)
void	setKeytabDescriptor(KerberosKeytabDescriptor keytab) Sets the KerberosKeytabDescriptor related to this KerberosIdentityDescriptor
void	setPrincipalDescriptor(KerberosPrincipalDescriptor principal) Sets the KerberosPrincipalDescriptor related to this KerberosIdentityDescriptor
void	setReference(String reference) Sets the path to the referenced Kerberos identity definition
void	setWhen(Predicate when) Sets the expression (or Predicate) to use to determine when to include this Kerberos identity while processing Kerberos identities.
boolean	shouldInclude(Map<String,Object> context) Processes the expression indicating when this KerberosIdentityDescriptor is to be included in the set of Kerberos identities to process.
Map<String,Object>	toMap() Creates a Map of values that can be used to create a copy of this KerberosIdentityDescriptor or generate the JSON structure described in KerberosIdentityDescriptor
void	update(KerberosIdentityDescriptor updates) Updates this KerberosIdentityDescriptor with data from another KerberosIdentityDescriptor Properties will be updated if the relevant updated values are not null.

Methods inherited from class org.apache.ambari.server.state.kerberos.AbstractKerberosDescriptor

getBooleanValue, getBooleanValue, getDescriptor, getName, getParent, getRoot, getStringValue, getValue, isContainer, nullToEmpty, nullToEmpty, nullToEmpty, setName, setParent

Methods inherited from class java.lang.Object

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

Constructor Detail

KerberosIdentityDescriptor

public KerberosIdentityDescriptor(String name,
                                  String reference,
                                  KerberosPrincipalDescriptor principal,
                                  KerberosKeytabDescriptor keytab,
                                  Predicate when)

Creates a new KerberosIdentityDescriptor

Parameters:

name - the name of this identity descriptor

reference - an optional path to a referenced KerberosIdentityDescriptor

principal - a KerberosPrincipalDescriptor

keytab - a KerberosKeytabDescriptor

when - a predicate

KerberosIdentityDescriptor

public KerberosIdentityDescriptor(Map<?,?> data)

Creates a new KerberosIdentityDescriptor

See KerberosIdentityDescriptor for the JSON Schema that may be used to generate this map.

Parameters:

data - a Map of values use to populate the data for the new instance

See Also:

KerberosIdentityDescriptor

Method Detail

getReference

public String getReference()

Gets the path to the referenced Kerberos identity definition

Returns:

the path to the referenced Kerberos identity definition or null if not set

getReferenceAbsolutePath

public String getReferenceAbsolutePath()

Gets the absolute path to the referenced Kerberos identity definition

Returns:

the path to the referenced Kerberos identity definition or null if not set

setReference

public void setReference(String reference)

Sets the path to the referenced Kerberos identity definition

Parameters:

reference - the path to the referenced Kerberos identity definition or null to indicate no reference

getPrincipalDescriptor

public KerberosPrincipalDescriptor getPrincipalDescriptor()

Gets the KerberosPrincipalDescriptor related to this KerberosIdentityDescriptor

Returns:

the KerberosPrincipalDescriptor related to this KerberosIdentityDescriptor

setPrincipalDescriptor

public void setPrincipalDescriptor(KerberosPrincipalDescriptor principal)

Sets the KerberosPrincipalDescriptor related to this KerberosIdentityDescriptor

Parameters:

principal - the KerberosPrincipalDescriptor related to this KerberosIdentityDescriptor

getKeytabDescriptor

public KerberosKeytabDescriptor getKeytabDescriptor()

Gets the KerberosKeytabDescriptor related to this KerberosIdentityDescriptor

Returns:

the KerberosKeytabDescriptor related to this KerberosIdentityDescriptor

setKeytabDescriptor

public void setKeytabDescriptor(KerberosKeytabDescriptor keytab)

Sets the KerberosKeytabDescriptor related to this KerberosIdentityDescriptor

Parameters:

keytab - the KerberosKeytabDescriptor related to this KerberosIdentityDescriptor

getWhen

public Predicate getWhen()

Gets the expression (or Predicate) to use to determine when to include this Kerberos identity while processing Kerberos identities.

null indicates there is nothing to evaluate and this Kerberos identity is to always be included when processing Kerberos identities.

Returns:

a predicate

setWhen

public void setWhen(Predicate when)

Sets the expression (or Predicate) to use to determine when to include this Kerberos identity while processing Kerberos identities.

null indicates there is nothing to evaluate and this Kerberos identity is to always be included when processing Kerberos identities.

Parameters:

when - a predicate

shouldInclude

public boolean shouldInclude(Map<String,Object> context)

Processes the expression indicating when this KerberosIdentityDescriptor is to be included in the set of Kerberos identities to process.

True will be returned if the expression is null or if it evaluates as such.

Parameters:

context - A Map of context values, including at least the list of services and available configurations

Returns:

true if this KerberosIdentityDescriptor is to be included when processing the Kerberos identities; otherwise false.

update

public void update(KerberosIdentityDescriptor updates)

Updates this KerberosIdentityDescriptor with data from another KerberosIdentityDescriptor

Properties will be updated if the relevant updated values are not null.

Parameters:

updates - the KerberosIdentityDescriptor containing the updated values

toMap

public Map<String,Object> toMap()

Creates a Map of values that can be used to create a copy of this KerberosIdentityDescriptor or generate the JSON structure described in KerberosIdentityDescriptor

Overrides:

toMap in class AbstractKerberosDescriptor

Returns:

a Map of values for this KerberosIdentityDescriptor

See Also:

KerberosIdentityDescriptor

getReferencedServiceName

public com.google.common.base.Optional<String> getReferencedServiceName()

A name that refers to a service has a format like /[/[/]]

Returns:

an optional referenced service name

isShared

public boolean isShared(KerberosIdentityDescriptor that)

Returns:

true if the given identity has the same principal or keytab as me

isReference

public boolean isReference()

Determines whether this KerberosIdentityDescriptor indicates it is a refrence to some other KerberosIdentityDescriptor.

A KerberosIdentityDescriptor is a reference if it's reference attibute is set or if (for backwards compatibility), its name indicates a path. For exmaple:

• SERVICE/COMPONENT/identitiy_name
• /identity_name
• ./identity_name

Returns:

true if this KerberosIdentityDescriptor indicates a reference; otherwise false

getPath

public String getPath()

Calculate the path to this identity descriptor for logging purposes. Examples: / /SERVICE /SERVICE/COMPONENT /SERVICE/COMPONENT/identity_name

This implementation calculates and caches the path if the path has not been previously set.

Overrides:

getPath in class AbstractKerberosDescriptor

Returns:

a path

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractKerberosDescriptor

equals

public boolean equals(Object object)

Overrides:

equals in class AbstractKerberosDescriptor

findReferences

public List<KerberosIdentityDescriptor> findReferences()

Find all of the KerberosIdentityDescriptors that reference this KerberosIdentityDescriptor

Returns:

a list of KerberosIdentityDescriptors