org.apache.ambari.server.state.kerberos

Class KerberosPrincipalDescriptor

java.lang.Object

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

org.apache.ambari.server.state.kerberos.KerberosPrincipalDescriptor

public class KerberosPrincipalDescriptor
extends AbstractKerberosDescriptor

KerberosPrincipalDescriptor is an implementation of an AbstractKerberosDescriptor that encapsulates data related to a Kerberos principal. This class is typically associated with the KerberosKeytabDescriptor via a KerberosIdentityDescriptor.

A KerberosPrincipalDescriptor has the following properties:

• value
• type
• configuration
• local_username

The following JSON Schema will yield a valid KerberosPrincipalDescriptor

   {
      "$schema": "http://json-schema.org/draft-04/schema#",
      "title": "KerberosIdentityDescriptor",
      "description": "Describes a Kerberos principal and associated details",
      "type": "object",
      "properties": {
        "value": {
          "description": "The pattern to use to generate the principal",
          "type": "string"
        },
        "type": {
          "description": "The type of principal - either 'service' or 'user'",
          "type": "string"
        },
        "configuration": {
          "description": "The configuration type and property name indicating the property to be
                          updated with the generated principal - format: config-type/property.name",
          "type": "string"
        },
        "local_username": {
          "description": "The local username this principal maps to - optional if no mapping is needed",
          "type": "string"
        }
      }
   }
 

In this implementation, AbstractKerberosDescriptor.name will hold the KerberosPrincipalDescriptor#value 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
KerberosPrincipalDescriptor(Map<?,?> data) Creates a new KerberosPrincipalDescriptor See KerberosPrincipalDescriptor for the JSON Schema that may be used to generate this map.
KerberosPrincipalDescriptor(String principal, KerberosPrincipalType type, String configuration, String localUsername) Creates a new KerberosPrincipalDescriptor

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object object)
String	getConfiguration() Gets the configuration type and property name indicating the property to be updated with the generated principal
String	getLocalUsername() Gets the local username associated with this principal
KerberosPrincipalType	getType() Gets the type of this KerberosPrincipalDescriptor
String	getValue() Gets the value (or principal name pattern) for this KerberosPrincipalDescriptor The value may include variable placeholders to be replaced as needed ${variable} placeholders are replaced on the server - see VariableReplacementHelper.replaceVariables(String, Map) the _HOST placeholder is replaced on the hosts to dynamically populate the relevant hostname
int	hashCode()
void	setConfiguration(String configuration) Sets the configuration type and property name indicating the property to be updated with the generated principal
void	setLocalUsername(String localUsername) Sets the local username associated with this principal
void	setType(KerberosPrincipalType type) Sets the type of this KerberosPrincipalDescriptor The value should be either "service" or "user"
void	setValue(String value) Sets the value (or principal name pattern) for this KerberosPrincipalDescriptor
Map<String,Object>	toMap() Creates a Map of values that can be used to create a copy of this KerberosPrincipalDescriptor or generate the JSON structure described in KerberosPrincipalDescriptor
void	update(KerberosPrincipalDescriptor updates) Updates this KerberosPrincipalDescriptor with data from another KerberosPrincipalDescriptor 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

KerberosPrincipalDescriptor

public KerberosPrincipalDescriptor(String principal,
                                   KerberosPrincipalType type,
                                   String configuration,
                                   String localUsername)

Creates a new KerberosPrincipalDescriptor

Parameters:

principal - the principal name

type - the principal type (user, service, etc...)

configuration - the configuration used to store the principal name

localUsername - the local username to map to the principal

KerberosPrincipalDescriptor

public KerberosPrincipalDescriptor(Map<?,?> data)

Creates a new KerberosPrincipalDescriptor

See KerberosPrincipalDescriptor 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:

KerberosPrincipalDescriptor

Method Detail

getValue

public String getValue()

Gets the value (or principal name pattern) for this KerberosPrincipalDescriptor

The value may include variable placeholders to be replaced as needed

• ${variable} placeholders are replaced on the server - see VariableReplacementHelper.replaceVariables(String, Map)
• the _HOST placeholder is replaced on the hosts to dynamically populate the relevant hostname

Returns:

a String declaring this principal's value

See Also:

VariableReplacementHelper.replaceVariables(String, Map)

setValue

public void setValue(String value)

Sets the value (or principal name pattern) for this KerberosPrincipalDescriptor

Parameters:

value - a String declaring this principal's value

See Also:

getValue()

getType

public KerberosPrincipalType getType()

Gets the type of this KerberosPrincipalDescriptor

Returns:

a KerberosPrincipalType declaring the type of this KerberosPrincipalDescriptor

setType

public void setType(KerberosPrincipalType type)

Sets the type of this KerberosPrincipalDescriptor

The value should be either "service" or "user"

Parameters:

type - a KerberosPrincipalType declaring the type of this KerberosPrincipalDescriptor

getConfiguration

public String getConfiguration()

Gets the configuration type and property name indicating the property to be updated with the generated principal

Returns:

a String declaring the configuration type and property name indicating the property to be updated with the generated principal #see #configuration

setConfiguration

public void setConfiguration(String configuration)

Sets the configuration type and property name indicating the property to be updated with the generated principal

Parameters:

configuration - a String declaring the configuration type and property name indicating the property to be updated with the generated principal

See Also:

configuration

getLocalUsername

public String getLocalUsername()

Gets the local username associated with this principal

Returns:

a String indicating the local username related to this principal, or null of not local mapping is needed/available

setLocalUsername

public void setLocalUsername(String localUsername)

Sets the local username associated with this principal

Parameters:

localUsername - a String indicating the local username related to this principal, or null of no local mapping is needed/available

update

public void update(KerberosPrincipalDescriptor updates)

Updates this KerberosPrincipalDescriptor with data from another KerberosPrincipalDescriptor

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

Parameters:

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

Overrides:

toMap in class AbstractKerberosDescriptor

Returns:

a Map of values for this KerberosPrincipalDescriptor

See Also:

KerberosPrincipalDescriptor

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractKerberosDescriptor

equals

public boolean equals(Object object)

Overrides:

equals in class AbstractKerberosDescriptor