AbstractKerberosDescriptor (Ambari Server 3.0.0.0-SNAPSHOT API)

java.lang.Object
- org.apache.ambari.server.state.kerberos.AbstractKerberosDescriptor

Direct Known Subclasses:

AbstractKerberosDescriptorContainer, KerberosConfigurationDescriptor, KerberosIdentityDescriptor, KerberosKeytabDescriptor, KerberosPrincipalDescriptor
```
public abstract class AbstractKerberosDescriptor
extends Object
```
AbstractKerberosDescriptor is the base class for all Kerberos*Descriptor and associated classes.
It provides storage and management for the parent and name values on behalf of implementing classes. It also provides utility and helper methods.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class AbstractKerberosDescriptor.Type
An enumeration of the different Kerberos (sub)descriptors for internal use.

Nested Classes
Modifier and Type	Class and Description
`static class`	`AbstractKerberosDescriptor.Type` An enumeration of the different Kerberos (sub)descriptors for internal use.

Constructor Summary

Constructors
Constructor and Description

AbstractKerberosDescriptor()

Constructors
Constructor and Description
`AbstractKerberosDescriptor()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object object)`
`protected static Boolean`	`getBooleanValue(Map<?,?> map, String key)` Safely retrieves the requested value (converted to a Boolean) from the supplied Map The found value will be converted to a Boolean using `Boolean.valueOf(String)`.
`protected static Boolean`	`getBooleanValue(Map<?,?> map, String key, Boolean defaultValue)` Safely retrieves the requested value (converted to a Boolean) from the supplied Map The found value will be converted to a Boolean using `Boolean.valueOf(String)`.
`protected AbstractKerberosDescriptor`	`getDescriptor(AbstractKerberosDescriptor.Type type, String name)` Gets the requested AbstractKerberosDescriptor implementation using a type name and a relevant descriptor name.
`String`	`getName()` Returns the name of this descriptor
`AbstractKerberosDescriptor`	`getParent()` Returns the parent (or container) of this descriptor
`String`	`getPath()` Calculate the path to this identity descriptor for logging purposes.
`protected AbstractKerberosDescriptor`	`getRoot()` Traverses up the hierarchy to find the "root" or "parent" container.
`protected static String`	`getStringValue(Map<?,?> map, String key)` Safely retrieves the requested value (converted to a String) from the supplied Map The found value will be converted to a String using the `Object.toString()` method.
`protected static Object`	`getValue(Map<?,?> map, String key)` Safely retrieves the requested value from the supplied Map
`int`	`hashCode()`
`boolean`	`isContainer()` Test this AbstractKerberosDescriptor to see if it is a container.
`static <T> Collection<T>`	`nullToEmpty(Collection<T> collection)`
`static <T> List<T>`	`nullToEmpty(List<T> list)`
`static <K,V> Map<K,V>`	`nullToEmpty(Map<K,V> collection)`
`void`	`setName(String name)` Sets the name of this descriptor
`void`	`setParent(AbstractKerberosDescriptor parent)` Sets the parent (or container) of this descriptor
`Map<String,Object>`	`toMap()` Generates a Map of data that represents this AbstractKerberosDescriptor implementation.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AbstractKerberosDescriptor
```
public AbstractKerberosDescriptor()
```
- Method Detail
  - toMap
```
public Map<String,Object> toMap()
```
    Generates a Map of data that represents this AbstractKerberosDescriptor implementation.
    This method should be overwritten by AbstractKerberosDescriptor implementations to generate a Map of data specific to it.
    It is not necessary to call this method from the overriding method.
    The map of data generated should be setup so that it can be fed back into the implementation class to build a copy of it. For example:
```
  descriptor1 = AbstractKerberosDescriptorImpl(...)
  map = descriptor1.toMap()
  descriptor2 = AbstractKerberosDescriptor(map)
  descriptor1 should have the same data as descriptor2
 
```
    Returns:
    
    a Map of date representing this AbstractKerberosDescriptor implementation
  - getName
```
public String getName()
```
    Returns the name of this descriptor
    
    Returns:
    
    a String indicating the name of this descriptor
  - setName
```
public void setName(String name)
```
    Sets the name of this descriptor
    
    Parameters:
    
    name - a String indicating the name of this descriptor
  - getParent
```
public AbstractKerberosDescriptor getParent()
```
    Returns the parent (or container) of this descriptor
    
    Returns:
    
    an AbstractKerberosDescriptor representing the parent (or container) of this descriptor or null if no parent was set
  - setParent
```
public void setParent(AbstractKerberosDescriptor parent)
```
    Sets the parent (or container) of this descriptor
    
    Parameters:
    
    parent - an AbstractKerberosDescriptor representing the parent (or container) of this descriptor or null to clear the value
  - isContainer
```
public boolean isContainer()
```
    Test this AbstractKerberosDescriptor to see if it is a container.
    The default implementation always returns false. Implementing classes should override this method to return something different, like true.
    
    Returns:
    
    true if this AbstractKerberosDescriptor is a container, false otherwise
  - getValue
```
protected static Object getValue(Map<?,?> map,
                                 String key)
```
    Safely retrieves the requested value from the supplied Map
    
    Parameters:
    
    map - a Map containing the relevant data
    
    key - a String declaring the item to retrieve
    
    Returns:
    
    an Object representing the requested data; or null if not found
  - getStringValue
```
protected static String getStringValue(Map<?,?> map,
                                       String key)
```
    Safely retrieves the requested value (converted to a String) from the supplied Map
    The found value will be converted to a String using the Object.toString() method.
    
    Parameters:
    
    map - a Map containing the relevant data
    
    key - a String declaring the item to retrieve
    
    Returns:
    
    a String representing the requested data; or null if not found
  - getBooleanValue
```
protected static Boolean getBooleanValue(Map<?,?> map,
                                         String key)
```
    Safely retrieves the requested value (converted to a Boolean) from the supplied Map
    The found value will be converted to a Boolean using Boolean.valueOf(String). If not found, null will be returned
    
    Parameters:
    
    map - a Map containing the relevant data
    
    key - a String declaring the item to retrieve
    
    Returns:
    
    a Boolean representing the requested data; or null if not found
    
    See Also:
    
    Boolean.valueOf(String), getBooleanValue(Map, String, Boolean)
  - getBooleanValue
```
protected static Boolean getBooleanValue(Map<?,?> map,
                                         String key,
                                         Boolean defaultValue)
```
    Safely retrieves the requested value (converted to a Boolean) from the supplied Map
    The found value will be converted to a Boolean using Boolean.valueOf(String).
    
    Parameters:
    
    map - a Map containing the relevant data
    
    key - a String declaring the item to retrieve
    
    defaultValue - a Boolean value to return if the data is not found
    
    Returns:
    
    a Boolean representing the requested data; or the specified default value if not found
    
    See Also:
    
    Boolean.valueOf(String)
  - getDescriptor
```
protected AbstractKerberosDescriptor getDescriptor(AbstractKerberosDescriptor.Type type,
                                                   String name)
```
    Gets the requested AbstractKerberosDescriptor implementation using a type name and a relevant descriptor name.
    Implementation classes should override this method to handle relevant descriptor types.
    
    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
  - getRoot
```
protected AbstractKerberosDescriptor getRoot()
```
    Traverses up the hierarchy to find the "root" or "parent" container.
    The root AbstractKerberosDescriptor is the first descriptor in the hierarchy with a null parent.
    
    Returns:
    
    the AbstractKerberosDescriptor implementation that is found to be the root of the hierarchy.
  - nullToEmpty
```
public static <T> Collection<T> nullToEmpty(Collection<T> collection)
```
  - nullToEmpty
```
public static <T> List<T> nullToEmpty(List<T> list)
```
  - nullToEmpty
```
public static <K,V> Map<K,V> nullToEmpty(Map<K,V> collection)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object object)
```
    Overrides:
    
    equals in class Object
  - getPath
```
public String getPath()
```
    Calculate the path to this identity descriptor for logging purposes. Examples:
    - /
    - /SERVICE
    - /SERVICE/COMPONENT
    - /SERVICE/COMPONENT/identity_name
    Returns:
    
    a path

Class AbstractKerberosDescriptor

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractKerberosDescriptor

Method Detail

toMap

getName

setName

getParent

setParent

isContainer

getValue

getStringValue

getBooleanValue

getBooleanValue

getDescriptor

getRoot

nullToEmpty

nullToEmpty

nullToEmpty

hashCode

equals

getPath