org.apache.ambari.server.state.kerberos

Class KerberosConfigurationDescriptor

java.lang.Object

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

org.apache.ambari.server.state.kerberos.KerberosConfigurationDescriptor

public class KerberosConfigurationDescriptor
extends AbstractKerberosDescriptor

KerberosConfigurationDescriptor is an implementation of an AbstractKerberosDescriptor that encapsulates data related to an Ambari configuration block.

A KerberosConfigurationDescriptor has the following properties:

• type
• properties

The following is an example of a JSON structure that will yield a valid KerberosConfigurationDescriptor

   {
    "core-site": {
      "hadoop.security.authentication": "kerberos",
      "hadoop.rpc.protection": "authentication; integrity; privacy",
      "hadoop.security.authorization": "true"
    }
   }
 

In this implementation, AbstractKerberosDescriptor.name will hold the KerberosConfigurationDescriptor#type 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
KerberosConfigurationDescriptor(Map<?,?> data) Creates a new KerberosConfigurationDescriptor See KerberosConfigurationDescriptor for an example JSON structure that may be used to generate this map.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object object)
Map<String,String>	getProperties() Gets the properties of the configuration data represented by this KerberosConfigurationDescriptor
String	getProperty(String name) Gets the value of the configuration property with the specified name
String	getType() Returns the type of the configuration data represented by this KerberosConfigurationDescriptor
int	hashCode()
void	putProperty(String name, String value) Adds or updates the value of the configuration property with the specified name If the property exists, it will be overwritten; else a new entry will be created.
void	setProperties(Map<String,String> properties) Set the properties of the configuration data represented by this KerberosConfigurationDescriptor
void	setType(String type) Sets the type of the configuration data represented by this KerberosConfigurationDescriptor
Map<String,Object>	toMap() Creates a Map of values that can be used to create a copy of this KerberosConfigurationDescriptor or generate the JSON structure described in KerberosConfigurationDescriptor
void	update(KerberosConfigurationDescriptor updates) Updates this KerberosConfigurationDescriptor with data from another KerberosConfigurationDescriptor 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, getPath, 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

KerberosConfigurationDescriptor

public KerberosConfigurationDescriptor(Map<?,?> data)

Creates a new KerberosConfigurationDescriptor

See KerberosConfigurationDescriptor for an example JSON structure 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:

KerberosConfigurationDescriptor

Method Detail

getType

public String getType()

Returns the type of the configuration data represented by this KerberosConfigurationDescriptor

Returns:

a String declaring the configuration type, i.e., core-site

setType

public void setType(String type)

Sets the type of the configuration data represented by this KerberosConfigurationDescriptor

Parameters:

type - a String declaring the configuration group type, i.e., core-site

setProperties

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

Set the properties of the configuration data represented by this KerberosConfigurationDescriptor

Parameters:

properties - a Map of properties

getProperties

public Map<String,String> getProperties()

Gets the properties of the configuration data represented by this KerberosConfigurationDescriptor

Returns:

a Map of properties

getProperty

public String getProperty(String name)

Gets the value of the configuration 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 value is not found

putProperty

public void putProperty(String name,
                        String value)

Adds or updates the value of the configuration property with the specified name

If the property exists, it will be overwritten; else a new entry will be created.

Parameters:

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

value - a String containing the value of the property

update

public void update(KerberosConfigurationDescriptor updates)

Updates this KerberosConfigurationDescriptor with data from another KerberosConfigurationDescriptor

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

Parameters:

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

Overrides:

toMap in class AbstractKerberosDescriptor

Returns:

a Map of values for this KerberosConfigurationDescriptor

See Also:

KerberosConfigurationDescriptor

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractKerberosDescriptor

equals

public boolean equals(Object object)

Overrides:

equals in class AbstractKerberosDescriptor