org.apache.ambari.server.state.kerberos

Class AbstractKerberosDescriptorContainer

java.lang.Object

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

org.apache.ambari.server.state.kerberos.AbstractKerberosDescriptorContainer

Direct Known Subclasses:

KerberosComponentDescriptor, KerberosDescriptor, KerberosServiceDescriptor

public abstract class AbstractKerberosDescriptorContainer
extends AbstractKerberosDescriptor

AbstractKerberosDescriptorContainer is an abstract class implementing AbstractKerberosDescriptor and providing facility to handle common descriptor container functionality.

Each AbstractKerberosDescriptorContainer contains identities and configurations as well as a name and a parent (which is inherited from AbstractKerberosDescriptor).

An AbstractKerberosDescriptorContainer has the following properties:

• identities
• configurations

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

   {
      "$schema": "http://json-schema.org/draft-04/schema#",
      "title": "AbstractKerberosDescriptorContainer",
      "description": "Describes an AbstractKerberosDescriptorContainer",
      "type": "object",
      "properties": {
        "identities": {
          "description": "A list of Kerberos identity descriptors",
          "type": "array",
          "items": {
            "title": "KerberosIdentityDescriptor"
            "type": "KerberosIdentityDescriptor"
          }
        },
        "configurations": {
          "description": "A list of relevant configuration blocks",
          "type": "array",
          "items": {
            "title": "KerberosConfigurationDescriptor"
            "type": "KerberosConfigurationDescriptor"
          }
        },
        "auth_to_local": {
          "description": "A list of configuration properties declaring which properties are auth-to-local values
          "type": "array",
          "items": {
            "title": "String"
            "type": "String"
          }
        }
      }
   }
 

This implementation does not set the AbstractKerberosDescriptor.name value, it is left up to the implementing class to do so.

Nested Class Summary

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

AbstractKerberosDescriptor.Type

Field Summary

Fields

Modifier and Type	Field and Description
static Pattern	AUTH_TO_LOCAL_PROPERTY_SPECIFICATION_PATTERN Regular expression pattern used to parse auth_to_local property specifications into the following parts: configuration type (optional, if _global_) property name concatenation type (optional, if using the default behavior)

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractKerberosDescriptorContainer(Map<?,?> data) Constructs a new AbstractKerberosDescriptorContainer This constructor must be called from the constructor(s) of the implementing classes

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object object)
Set<String>	getAuthToLocalProperties() Gets the set of auth_to_local property names.
abstract AbstractKerberosDescriptorContainer	getChildContainer(String name) Returns a specific named child container
abstract Collection<? extends AbstractKerberosDescriptorContainer>	getChildContainers() Returns the child containers associated with this container.
KerberosConfigurationDescriptor	getConfiguration(String name) Returns the requested KerberosConfigurationDescriptor
Map<String,KerberosConfigurationDescriptor>	getConfigurations() Returns a Map of raw KerberosConfigurationDescriptors contained within this AbstractKerberosDescriptorContainer.
Map<String,KerberosConfigurationDescriptor>	getConfigurations(boolean includeInherited) Returns a Map of KerberosConfigurationDescriptors contained within this AbstractKerberosDescriptorContainer.
protected AbstractKerberosDescriptor	getDescriptor(AbstractKerberosDescriptor.Type type, String name) Gets the requested AbstractKerberosDescriptor implementation using a type name and a relevant descriptor name.
List<KerberosIdentityDescriptor>	getIdentities() Returns the raw List of KerberosIdentityDescriptors contained within this AbstractKerberosDescriptorContainer.
List<KerberosIdentityDescriptor>	getIdentities(boolean resolveReferences, Map<String,Object> contextForFilter) Returns a List of KerberosIdentityDescriptors contained within this AbstractKerberosDescriptorContainer.
List<KerberosIdentityDescriptor>	getIdentitiesSkipReferences()
KerberosIdentityDescriptor	getIdentity(String name) Return a KerberosIdentityDescriptor with the specified name.
KerberosIdentityDescriptor	getReferencedIdentityDescriptor(String path) Attempts to find the KerberosIdentityDescriptor at the specified path.
int	hashCode()
boolean	isContainer() Test this AbstractKerberosDescriptor to see if it is a container.
void	putAuthToLocalProperty(String authToLocalProperty) Adds the specified property name to the set of auth_to_local property names.
void	putConfiguration(KerberosConfigurationDescriptor configuration) Adds the specified KerberosConfigurationDescriptor to the list of KerberosConfigurationDescriptors.
void	putIdentity(KerberosIdentityDescriptor identity) Adds the specified KerberosIdentityDescriptor to the list of KerberosIdentityDescriptor.
void	removeIdentity(String name) Remove all KerberosIdentityDescriptors have have the specified name One or more KerberosIdentityDescriptors may be removed if multiple KerberosIdentityDescriptors have the same name.
void	setAuthToLocalProperties(Set<String> authToLocalProperties) Sets the set of auth_to_local property names.
void	setConfigurations(Map<String,KerberosConfigurationDescriptor> configurations) Sets the Map of KerberosConfigurationDescriptors for this AbstractKerberosDescriptorContainer.
void	setIdentities(List<KerberosIdentityDescriptor> identities) Set the KerberosIdentityDescriptor for this AbstractKerberosDescriptorContainer.
Map<String,Object>	toMap() Creates a Map of values that can be used to create a copy of this AbstractKerberosDescriptorContainer or generate the JSON structure described in AbstractKerberosDescriptorContainer
void	update(AbstractKerberosDescriptorContainer updates) Updates this AbstractKerberosDescriptorContainer using information from the supplied AbstractKerberosDescriptorContainer.

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

getBooleanValue, getBooleanValue, getName, getParent, getPath, getRoot, getStringValue, getValue, nullToEmpty, nullToEmpty, nullToEmpty, setName, setParent

Methods inherited from class java.lang.Object

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

Field Detail

AUTH_TO_LOCAL_PROPERTY_SPECIFICATION_PATTERN

public static final Pattern AUTH_TO_LOCAL_PROPERTY_SPECIFICATION_PATTERN

Regular expression pattern used to parse auth_to_local property specifications into the following parts:

• configuration type (optional, if _global_)
• property name
• concatenation type (optional, if using the default behavior)

Constructor Detail

AbstractKerberosDescriptorContainer

protected AbstractKerberosDescriptorContainer(Map<?,?> data)

Constructs a new AbstractKerberosDescriptorContainer

This constructor must be called from the constructor(s) of the implementing classes

Parameters:

data - a Map of data used for collecting groups of common descriptors

Method Detail

getChildContainers

public abstract Collection<? extends AbstractKerberosDescriptorContainer> getChildContainers()

Returns the child containers associated with this container.

Returns:

an immutable collection of AbstractKerberosDescriptorContainers

getChildContainer

public abstract AbstractKerberosDescriptorContainer getChildContainer(String name)

Returns a specific named child container

Parameters:

name - the name of the child container to retrieve

Returns:

an AbstractKerberosDescriptorContainer

getIdentities

public List<KerberosIdentityDescriptor> getIdentities()

Returns the raw List of KerberosIdentityDescriptors contained within this AbstractKerberosDescriptorContainer.

The returned KerberosIdentityDescriptors are not merged with data from referenced KerberosConfigurationDescriptors. This is the same calling getIdentities(boolean, Map) and setting the argument to 'false'

Returns:

the relevant List of KerberosIdentityDescriptors

setIdentities

public void setIdentities(List<KerberosIdentityDescriptor> identities)

Set the KerberosIdentityDescriptor for this AbstractKerberosDescriptorContainer.

Parameters:

identities - a List of KerberosIdentityDescriptors

getIdentities

public List<KerberosIdentityDescriptor> getIdentities(boolean resolveReferences,
                                                      Map<String,Object> contextForFilter)
                                               throws org.apache.ambari.server.AmbariException

Returns a List of KerberosIdentityDescriptors contained within this AbstractKerberosDescriptorContainer.

If resolveReferences is true, a "detached" set of KerberosIdentityDescriptors are returned. Any KerberosIdentityDescriptor that implies it references some other KerberosIdentityDescriptor in the hierarchy will be resolved. Meaning, if the name of the KerberosIdentityDescriptor indicates a path to some other KerberosIdentityDescriptor (i.e, /spnego, /HDFS/NAMENODE/nn, etc...) the referenced KerberosIdentityDescriptor is found, detached (or copied), and updated with the information from the initial KerberosIdentityDescriptor. Because of this, all of the KerberosIdentityDescriptors to be included are copied into the resulting list, and dissociating them with the rest of the hierarchy such that changes to them will not be reflected within the entire KerberosDescriptor tree.

If resolveReferences is false, the raw List of KerberosIdentityDescriptors are returned. This data is not manipulated by resolving references and therefore it may be missing data, however this List is of "attached" descriptors, so changes will be reflected within the KerberosDescriptor hierarchy.

Parameters:

resolveReferences - a Boolean value indicating whether to resolve references (true) or not (false)

Returns:

a List of the requested KerberosIdentityDescriptors

Throws:

org.apache.ambari.server.AmbariException

getIdentity

public KerberosIdentityDescriptor getIdentity(String name)

Return a KerberosIdentityDescriptor with the specified name.

Parameters:

name - a String declaring the name of the descriptor to retrieve

Returns:

the requested KerberosIdentityDescriptor

putIdentity

public void putIdentity(KerberosIdentityDescriptor identity)

Adds the specified KerberosIdentityDescriptor to the list of KerberosIdentityDescriptor.

This method attempts to ensure that the names or KerberosIdentityDescriptors are unique within the List.

Parameters:

identity - the KerberosIdentityDescriptor to add

removeIdentity

public void removeIdentity(String name)

Remove all KerberosIdentityDescriptors have have the specified name

One or more KerberosIdentityDescriptors may be removed if multiple KerberosIdentityDescriptors have the same name.

Parameters:

name - a String declaring the name of the descriptors to remove

setConfigurations

public void setConfigurations(Map<String,KerberosConfigurationDescriptor> configurations)

Sets the Map of KerberosConfigurationDescriptors for this AbstractKerberosDescriptorContainer.

Parameters:

configurations - a Map of KerberosConfigurationDescriptors

getConfigurations

public Map<String,KerberosConfigurationDescriptor> getConfigurations()

Returns a Map of raw KerberosConfigurationDescriptors contained within this AbstractKerberosDescriptorContainer.

The returned KerberosConfigurationDescriptors are not merged with data from KerberosDescriptor hierarchy. This is the same calling getConfigurations(boolean) and setting the argument to 'false'

Returns:

a List of KerberosConfigurationDescriptors

getConfigurations

public Map<String,KerberosConfigurationDescriptor> getConfigurations(boolean includeInherited)

Returns a Map of KerberosConfigurationDescriptors contained within this AbstractKerberosDescriptorContainer.

If includeInherited is true, the Map will contain "detached" KerberosConfigurationDescriptor instances, but the data will be merged with all relevant KerberosConfigurationDescriptors within the hierarchy. Data higher in the hierarchy (the service level is higher in the hierarchy than the component level) will be overwritten by data lower in the hierarchy.

If includeInherited is false, the Map will consist of attached (non-merged) KerberosConfigurationDescriptors. This data is not manipulated by merging with data within the KerberosDescriptor hierarchy and therefore it may be missing data, however this Map is of "attached" descriptors, so changes will be reflected within the KerberosDescriptor hierarchy.

Parameters:

includeInherited - a Boolean value indicating whether to include configuration within the KerberosDescriptor hierarchy (true) or not (false)

Returns:

a Map of Strings to KerberosConfigurationDescriptors, where the key is the type (core-site, etc...)

putConfiguration

public void putConfiguration(KerberosConfigurationDescriptor configuration)

Adds the specified KerberosConfigurationDescriptor to the list of KerberosConfigurationDescriptors.

If an entry exists of the same configuration type, it will be overwritten.

Parameters:

configuration - the KerberosConfigurationDescriptor to add

getConfiguration

public KerberosConfigurationDescriptor getConfiguration(String name)

Returns the requested KerberosConfigurationDescriptor

Parameters:

name - a String declaring the name of the descriptor to retrieve

Returns:

the requested KerberosConfigurationDescriptor or null if not found

putAuthToLocalProperty

public void putAuthToLocalProperty(String authToLocalProperty)

Adds the specified property name to the set of auth_to_local property names.

Each auth_to_local property name is expected to be in the following format: config-type/property_name`

Parameters:

authToLocalProperty - the auth_to_local property to add

setAuthToLocalProperties

public void setAuthToLocalProperties(Set<String> authToLocalProperties)

Sets the set of auth_to_local property names.

Parameters:

authToLocalProperties - a Set of String values; or null if not set

getAuthToLocalProperties

public Set<String> getAuthToLocalProperties()

Gets the set of auth_to_local property names.

Returns:

a Set of String values; or null if not set

isContainer

public boolean isContainer()

Test this AbstractKerberosDescriptor to see if it is a container.

This implementation always returns true since it implements a descriptor container.

Overrides:

isContainer in class AbstractKerberosDescriptor

Returns:

true if this AbstractKerberosDescriptor is a container, false otherwise

update

public void update(AbstractKerberosDescriptorContainer updates)

Updates this AbstractKerberosDescriptorContainer using information from the supplied AbstractKerberosDescriptorContainer.

Information from updates will overwrite information in this AbstractKerberosDescriptorContainer. More specifically, the name of this AbstractKerberosDescriptorContainer may be updated as well as each individual KerberosIdentityDescriptor and KerberosConfigurationDescriptor contained within it. Any new KerberosIdentityDescriptors and KerberosConfigurationDescriptors will be appended to there appropriate lists.

Parameters:

updates - an AbstractKerberosDescriptorContainer containing the updates to this AbstractKerberosDescriptorContainer

getReferencedIdentityDescriptor

public KerberosIdentityDescriptor getReferencedIdentityDescriptor(String path)
                                                           throws org.apache.ambari.server.AmbariException

Attempts to find the KerberosIdentityDescriptor at the specified path.

The path value is expected to be an "absolute" path through the Kerberos Descriptor hierarchy to some specific KerberosIdentityDescriptor. The path must be in one of the following forms:

• /identity
• /service/identity
• /service/component/identity

If the path starts with "../", the ".." will be translated to the path of the parent item. In the following example, ../service_identity will resolve to /SERVICE/service_identity:

 {
  "name": "SERVICE",
  "identities": [
    {
      "name": "service_identity",
      ...
    }
  ],
  "components" : [
    {
      "name": "COMPONENT",
      "identities": [
        {
          "name": "./service_identity",
          ...
        },
        ...
      ]
    }
  ]
 }
 

Parameters:

path - a String declaring the path to a KerberosIdentityDescriptor

Returns:

a KerberosIdentityDescriptor identified by the path or null if not found

Throws:

org.apache.ambari.server.AmbariException

getDescriptor

protected AbstractKerberosDescriptor getDescriptor(AbstractKerberosDescriptor.Type type,
                                                   String name)

Gets the requested AbstractKerberosDescriptor implementation using a type name and a relevant descriptor name.

This implementation handles identity and configuration descriptors within this AbstractKerberosDescriptorContainer.

Implementing classes should override this to handle other types, but call this method to ensure no data is missed.

Overrides:

getDescriptor in class AbstractKerberosDescriptor

Parameters:

type - a String indicating the type of the requested descriptor

name - a String indicating the name of the requested descriptor

Returns:

a AbstractKerberosDescriptor representing the requested descriptor or null if not found

toMap

public Map<String,Object> toMap()

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

Overrides:

toMap in class AbstractKerberosDescriptor

Returns:

a Map of values for this AbstractKerberosDescriptorContainer

See Also:

AbstractKerberosDescriptorContainer

getIdentitiesSkipReferences

public List<KerberosIdentityDescriptor> getIdentitiesSkipReferences()

Returns:

identities which are not references to other identities

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractKerberosDescriptor

equals

public boolean equals(Object object)

Overrides:

equals in class AbstractKerberosDescriptor