org.apache.ambari.server.state.kerberos

Class KerberosDescriptor

java.lang.Object

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

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

org.apache.ambari.server.state.kerberos.KerberosDescriptor

public class KerberosDescriptor
extends AbstractKerberosDescriptorContainer

KerberosDescriptor is an implementation of an AbstractKerberosDescriptorContainer that encapsulates an entire Kerberos descriptor hierarchy.

A KerberosDescriptor has the following properties:

• services
• properties
• identities (AbstractKerberosDescriptorContainer)
• configurations (AbstractKerberosDescriptorContainer)

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

   {
      "$schema": "http://json-schema.org/draft-04/schema#",
      "title": "KerberosDescriptor",
      "description": "Describes a Kerberos descriptor",
      "type": "object",
      "properties": {
        "services": {
          "description": "A list of service descriptors",
          "type": "array",
          "items": {
            "title": "KerberosServiceDescriptor"
            "type": "KerberosServiceDescriptor"
          }
        },
        "properties": {
          "description": "Global properties that can be used in variable replacements",
          "type": "object",
          "patternProperties": {
            "^[\w\.\_]?$": {}"
          }
        }
        "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"
          }
        }
      }
   }
 

In this implementation, AbstractKerberosDescriptor.name will be null

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 String	KEY_PROPERTIES
static String	KEY_SERVICES

Fields inherited from class org.apache.ambari.server.state.kerberos.AbstractKerberosDescriptorContainer

AUTH_TO_LOCAL_PROPERTY_SPECIFICATION_PATTERN

Constructor Summary

Constructors

Constructor and Description
KerberosDescriptor() Creates an empty KerberosDescriptor

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object object)
Set<String>	getAllAuthToLocalProperties() Recursively gets the entire set of auth_to_local property names contain within this KerberosDescriptor.
AbstractKerberosDescriptorContainer	getChildContainer(String name) Returns a specific named child container
Collection<? extends AbstractKerberosDescriptorContainer>	getChildContainers() Returns the child containers associated with this container.
protected AbstractKerberosDescriptor	getDescriptor(AbstractKerberosDescriptor.Type type, String name) Gets the requested AbstractKerberosDescriptor implementation using a type name and a relevant descriptor name.
Map<String,String>	getProperties() Gets the Map of properties for this KerberosDescriptor
String	getProperty(String name) Gets the value of the property with the specified name
KerberosServiceDescriptor	getService(String name) Gets the KerberosServiceDescriptor with the specified name
Map<String,KerberosServiceDescriptor>	getServices() Returns a Map of the KerberosServiceDescriptors in this KerberosDescriptor
int	hashCode()
Map<String,String>	principals() Get a map of principals, where the key is the principal path (SERVICE/COMPONENT/principal_name or SERVICE/principal_name) and the value is the principal.
void	putProperty(String name, String value) Adds or updates a property value If a property exists with the specified name, replaces its value; else adds a new entry.
void	putService(KerberosServiceDescriptor service) Adds, replaces, or updates a KerberosServiceDescriptor If a KerberosServiceDescriptor with the same name does not exist in the services Map, a new entry will be added; else if it one already exists and overwrite is true, it will be replaced; else the exsting entry will be updated.
void	setParent(AbstractKerberosDescriptor parent) Sets the parent (or container) of this descriptor This implementation prevents the parent from being externally set by always throwing an UnsupportedOperationException.
void	setProperties(Map<String,String> properties) Set the Map of properties for this KerberosDescriptor
void	setServices(Map<String,KerberosServiceDescriptor> services) Set the KerberosServiceDescriptors in this KerberosDescriptor
Map<String,Object>	toMap() Creates a Map of values that can be used to create a copy of this KerberosDescriptor or generate the JSON structure described in KerberosDescriptor
KerberosDescriptor	update(KerberosDescriptor updates) Updates this KerberosDescriptor with data from another KerberosDescriptor Properties will be updated if the relevant updated values are not null.

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

getAuthToLocalProperties, getConfiguration, getConfigurations, getConfigurations, getIdentities, getIdentities, getIdentitiesSkipReferences, getIdentity, getReferencedIdentityDescriptor, isContainer, putAuthToLocalProperty, putConfiguration, putIdentity, removeIdentity, setAuthToLocalProperties, setConfigurations, setIdentities, update

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

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

Methods inherited from class java.lang.Object

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

Field Detail

KEY_PROPERTIES

public static final String KEY_PROPERTIES

See Also:

Constant Field Values

KEY_SERVICES

public static final String KEY_SERVICES

Constructor Detail

KerberosDescriptor

public KerberosDescriptor()

Creates an empty KerberosDescriptor

Method Detail

getChildContainers

public Collection<? extends AbstractKerberosDescriptorContainer> getChildContainers()

Description copied from class: AbstractKerberosDescriptorContainer

Returns the child containers associated with this container.

Specified by:

getChildContainers in class AbstractKerberosDescriptorContainer

Returns:

an immutable collection of AbstractKerberosDescriptorContainers

getChildContainer

public AbstractKerberosDescriptorContainer getChildContainer(String name)

Description copied from class: AbstractKerberosDescriptorContainer

Returns a specific named child container

Specified by:

getChildContainer in class AbstractKerberosDescriptorContainer

Parameters:

name - the name of the child container to retrieve

Returns:

an AbstractKerberosDescriptorContainer

setServices

public void setServices(Map<String,KerberosServiceDescriptor> services)

Set the KerberosServiceDescriptors in this KerberosDescriptor

Parameters:

services - a Map of String to KerberosServiceDescriptor

getServices

public Map<String,KerberosServiceDescriptor> getServices()

Returns a Map of the KerberosServiceDescriptors in this KerberosDescriptor

Returns:

a Map of String to KerberosServiceDescriptor

getService

public KerberosServiceDescriptor getService(String name)

Gets the KerberosServiceDescriptor with the specified name

Parameters:

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

Returns:

the requested KerberosServiceDescriptor or null if not found

putService

public void putService(KerberosServiceDescriptor service)

Adds, replaces, or updates a KerberosServiceDescriptor

If a KerberosServiceDescriptor with the same name does not exist in the services Map, a new entry will be added; else if it one already exists and overwrite is true, it will be replaced; else the exsting entry will be updated.

Parameters:

service - the KerberosServiceDescriptor to put

setProperties

public void setProperties(Map<String,String> properties)

Set the Map of properties for this KerberosDescriptor

Parameters:

properties - a Map of String to String values

getProperties

public Map<String,String> getProperties()

Gets the Map of properties for this KerberosDescriptor

Returns:

a Map of String to String values

getProperty

public String getProperty(String name)

Gets the value of the property with the specified name

Parameters:

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

Returns:

a String or null if the property was not found

putProperty

public void putProperty(String name,
                        String value)

Adds or updates a property value

If a property exists with the specified name, replaces its value; else adds a new entry.

Parameters:

name - a String declaring the name of the property to put

value - a String containing the value of the property to put

update

public KerberosDescriptor update(KerberosDescriptor updates)

Updates this KerberosDescriptor with data from another KerberosDescriptor

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

Parameters:

updates - the KerberosDescriptor containing the updated values

Returns:

this KerberosDescriptor for convenience

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 service descriptors and delegates to the AbstractKerberosDescriptor implementation to handle component and identity types.

Overrides:

getDescriptor in class AbstractKerberosDescriptorContainer

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 KerberosDescriptor or generate the JSON structure described in KerberosDescriptor

Overrides:

toMap in class AbstractKerberosDescriptorContainer

Returns:

a Map of values for this KerberosDescriptor

See Also:

KerberosDescriptor

setParent

public void setParent(AbstractKerberosDescriptor parent)

Sets the parent (or container) of this descriptor

This implementation prevents the parent from being externally set by always throwing an UnsupportedOperationException.

Overrides:

setParent in class AbstractKerberosDescriptor

Parameters:

parent - an AbstractKerberosDescriptor representing the parent (or container) of this

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractKerberosDescriptorContainer

equals

public boolean equals(Object object)

Overrides:

equals in class AbstractKerberosDescriptorContainer

getAllAuthToLocalProperties

public Set<String> getAllAuthToLocalProperties()

Recursively gets the entire set of auth_to_local property names contain within this KerberosDescriptor.

Returns:

a Set of String values where each value is in the form of config-type/property_name

principals

public Map<String,String> principals()
                              throws org.apache.ambari.server.AmbariException

Get a map of principals, where the key is the principal path (SERVICE/COMPONENT/principal_name or SERVICE/principal_name) and the value is the principal.

For example if the kerberos principal of the HISTORYSERVER is defined in the kerberos.json: "name": "history_server_jhs", "principal": { "value": "jhs/_HOST@${realm}", "type" : "service", }, Then "jhs/_HOST@EXAMPLE.COM" will be put into the map under the "MAPREDUCE2/HISTORYSERVER/history_server_jhs" key.

Throws:

org.apache.ambari.server.AmbariException