org.apache.ambari.server.state.kerberos

Class KerberosKeytabDescriptor

java.lang.Object

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

org.apache.ambari.server.state.kerberos.KerberosKeytabDescriptor

public class KerberosKeytabDescriptor
extends AbstractKerberosDescriptor

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

A KerberosKeytabDescriptor has the following properties:

• file
• owner {name, access}
• group {name, access}
• configuration
• cachable

The following JSON Schema will yield a valid KerberosPrincipalDescriptor

   {
      "$schema": "http://json-schema.org/draft-04/schema#",
      "title": "KerberosKeytabDescriptor",
      "description": "Describes a Kerberos keytab file and associated details",
      "type": "object",
      "properties": {
        "file": {
          "description": "The absolute path for the keytab file",
          "type": "string"
        },
        "owner": {
          "description": "Details about the file's user ownership",
          "type": "object",
          "properties": {
            "name": {
              "description": "The local username that should be set as the owner of this file",
              "type": "string"
            },
            "access": {
              "description": "The relevant access permissions that should be set for the owner of
                              this file. Expected values are 'rw', 'r', ''"
              "type": "string"
            }
          }
        }
        "group": {
          "description": "Details about the file's group ownership",
          "type": "object",
          "properties": {
            "name": {
              "description": "The local group name that should be set as the group owner of this file",
              "type": "string"
            },
            "access": {
              "description": "The relevant access permissions that should be set for the group
                              owner of this file. Expected values are 'rw', 'r', ''"
              "type": "string"
            }
          }
        }
        "configuration": {
          "description": "The configuration type and property name indicating the property to be
                          updated with the generated absolute path to the keytab file
                          - format: config-type/property.name",
          "type": "string"
        }
        "cachable" : {
          "description": "Indicates whether the generated keytab is allowed to be cached by the
                          Ambari server (true) or not (false)",
          "type": "boolean"
        }
      }
   }
 

In this implementation, AbstractKerberosDescriptor.name will hold the KerberosKeytabDescriptor#file 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
KerberosKeytabDescriptor(Map<?,?> data) Creates a new KerberosKeytabDescriptor See KerberosKeytabDescriptor for the JSON Schema that may be used to generate this map.
KerberosKeytabDescriptor(String file, String ownerName, String ownerAccess, String groupName, String groupAccess, String configuration, boolean cachable) Creates a new KerberosKeytabDescriptor

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 keytab's file path
String	getFile() Gets the path to the keytab file The value may include variable placeholders to be replaced as needed ${variable} placeholders are replaced on the server - see VariableReplacementHelper.replaceVariables(String, Map)
String	getGroupAccess() Gets the access permissions that should be set on the keytab file related to the file's group
String	getGroupName() Gets the local group name to set as the group owner of the keytab file
String	getOwnerAccess() Gets the access permissions that should be set on the keytab file related to the file's owner
String	getOwnerName() Gets the local username to set as the owner of the keytab file
int	hashCode()
boolean	isCachable() Indicates whether the generated keytab is allowed to be cached by the Ambari server or not
void	setCachable(boolean cachable) Sets whether the generated keytab is allowed to be cached by the Ambari server or not
void	setConfiguration(String configuration) Sets the configuration type and property name indicating the property to be updated with the keytab's file path
void	setFile(String file) Sets the path to the keytab file
void	setGroupAccess(String access) Sets the access permissions that should be set on the keytab file related to the file's group
void	setGroupName(String name) Sets the local group name to set as the group owner of the keytab file
void	setOwnerAccess(String access) Sets the access permissions that should be set on the keytab file related to the file's owner
void	setOwnerName(String name) Sets the local username to set as the owner of the keytab file
Map<String,Object>	toMap() Creates a Map of values that can be used to create a copy of this KerberosKeytabDescriptor or generate the JSON structure described in KerberosKeytabDescriptor
void	update(KerberosKeytabDescriptor updates) Updates this KerberosKeytabDescriptor with data from another KerberosKeytabDescriptor 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

KerberosKeytabDescriptor

public KerberosKeytabDescriptor(String file,
                                String ownerName,
                                String ownerAccess,
                                String groupName,
                                String groupAccess,
                                String configuration,
                                boolean cachable)

Creates a new KerberosKeytabDescriptor

Parameters:

file - the path to the keytab file

ownerName - the local username of the file owner

ownerAccess - the file access privileges for the file owner ("r", "rw", "")

groupName - the local group name with privileges to access the file

groupAccess - the file access privileges for the group ("r", "rw", "")

configuration - the configuration used to store the principal name

cachable - true if the keytab may be cached by Ambari; otherwise false

KerberosKeytabDescriptor

public KerberosKeytabDescriptor(Map<?,?> data)

Creates a new KerberosKeytabDescriptor

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

KerberosKeytabDescriptor

Method Detail

getFile

public String getFile()

Gets the path to the keytab file

The value may include variable placeholders to be replaced as needed

• ${variable} placeholders are replaced on the server - see VariableReplacementHelper.replaceVariables(String, Map)

Returns:

a String declaring the keytab file's absolute path

See Also:

VariableReplacementHelper.replaceVariables(String, Map)

setFile

public void setFile(String file)

Sets the path to the keytab file

Parameters:

file - a String declaring this keytab's file path

See Also:

getFile()

getOwnerName

public String getOwnerName()

Gets the local username to set as the owner of the keytab file

Returns:

a String declaring the name of the user to own the keytab file

setOwnerName

public void setOwnerName(String name)

Sets the local username to set as the owner of the keytab file

Parameters:

name - a String declaring the name of the user to own the keytab file

getOwnerAccess

public String getOwnerAccess()

Gets the access permissions that should be set on the keytab file related to the file's owner

Returns:

a String declaring the access permissions that should be set on the keytab file related to the file's owner

See Also:

ownerAccess

setOwnerAccess

public void setOwnerAccess(String access)

Sets the access permissions that should be set on the keytab file related to the file's owner

Parameters:

access - a String declaring the access permissions that should be set on the keytab file related to the file's owner

See Also:

ownerAccess

getGroupName

public String getGroupName()

Gets the local group name to set as the group owner of the keytab file

Returns:

a String declaring the name of the group to own the keytab file

setGroupName

public void setGroupName(String name)

Sets the local group name to set as the group owner of the keytab file

Parameters:

name - a String declaring the name of the group to own the keytab file

getGroupAccess

public String getGroupAccess()

Gets the access permissions that should be set on the keytab file related to the file's group

Returns:

a String declaring the access permissions that should be set on the keytab file related to the file's group

See Also:

groupAccess

setGroupAccess

public void setGroupAccess(String access)

Sets the access permissions that should be set on the keytab file related to the file's group

Parameters:

access - a String declaring the access permissions that should be set on the keytab file related to the file's group

See Also:

groupAccess

getConfiguration

public String getConfiguration()

Gets the configuration type and property name indicating the property to be updated with the keytab's file path

Returns:

a String declaring the configuration type and property name indicating the property to be updated with the keytab's file path #see #configuration

setConfiguration

public void setConfiguration(String configuration)

Sets the configuration type and property name indicating the property to be updated with the keytab's file path

Parameters:

configuration - a String declaring the configuration type and property name indicating the property to be updated with the keytab's file path

See Also:

configuration

isCachable

public boolean isCachable()

Indicates whether the generated keytab is allowed to be cached by the Ambari server or not

Returns:

true if allowed to be cached; false otherwise

setCachable

public void setCachable(boolean cachable)

Sets whether the generated keytab is allowed to be cached by the Ambari server or not

Parameters:

cachable - true if allowed to be cached; false otherwise

update

public void update(KerberosKeytabDescriptor updates)

Updates this KerberosKeytabDescriptor with data from another KerberosKeytabDescriptor

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

Parameters:

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

Overrides:

toMap in class AbstractKerberosDescriptor

Returns:

a Map of values for this KerberosKeytabDescriptor

See Also:

KerberosKeytabDescriptor

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractKerberosDescriptor

equals

public boolean equals(Object object)

Overrides:

equals in class AbstractKerberosDescriptor