org.apache.ambari.server.state.kerberos

Class KerberosServiceDescriptor

java.lang.Object

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

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

org.apache.ambari.server.state.kerberos.KerberosServiceDescriptor

public class KerberosServiceDescriptor
extends AbstractKerberosDescriptorContainer

KerberosServiceDescriptor is an implementation of an AbstractKerberosDescriptorContainer that encapsulates an Ambari service and it components.

A KerberosServiceDescriptor has the following properties:

• name
• components
• identities (AbstractKerberosDescriptorContainer)
• configurations (AbstractKerberosDescriptorContainer)

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

   {
      "$schema": "http://json-schema.org/draft-04/schema#",
      "title": "KerberosServiceDescriptor",
      "description": "Describes an Ambari service",
      "type": "object",
      "preconfigure": "boolean",
      "properties": {
        "name": {
          "description": "An identifying name for this service descriptor.",
          "type": "string"
        },
        "components": {
          "description": "A list of Ambari component descriptors",
          "type": "array",
          "items": {
            "title": "KerberosComponentDescriptor"
            "type": "KerberosComponentDescriptor"
          }
        },
        "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 hold the KerberosServiceDescriptor#name value.

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_NAME

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

AUTH_TO_LOCAL_PROPERTY_SPECIFICATION_PATTERN

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object object)
AbstractKerberosDescriptorContainer	getChildContainer(String name) Returns a specific named child container
Collection<? extends AbstractKerberosDescriptorContainer>	getChildContainers() Returns the child containers associated with this container.
KerberosComponentDescriptor	getComponent(String name) Returns the KerberosComponentDescriptors with the specified name
List<KerberosIdentityDescriptor>	getComponentIdentities(String componentName)
Map<String,KerberosComponentDescriptor>	getComponents() Returns a Map of the KerberosComponentDescriptors related to this KerberosServiceDescriptor
protected AbstractKerberosDescriptor	getDescriptor(AbstractKerberosDescriptor.Type type, String name) Gets the requested AbstractKerberosDescriptor implementation using a type name and a relevant descriptor name.
int	hashCode()
void	putComponent(KerberosComponentDescriptor component) Adds or replaces a KerberosComponentDescriptor If a KerberosComponentDescriptor with the same name already exists in the components Map, it will be replaced; else a new entry will be made.
void	setPreconfigure(Boolean preconfigure) Sets whether this service should be preconfigured when determining configurations or not.
boolean	shouldPreconfigure() Indicate whether this service should be preconfigured when determining configurations.
Map<String,Object>	toMap() Creates a Map of values that can be used to create a copy of this KerberosServiceDescriptor or generate the JSON structure described in KerberosServiceDescriptor
void	update(KerberosServiceDescriptor updates) Updates this KerberosServiceDescriptor with data from another KerberosServiceDescriptor 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, setParent

Methods inherited from class java.lang.Object

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

Field Detail

KEY_NAME

public static final String KEY_NAME

See Also:

Constant Field Values

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

getComponents

public Map<String,KerberosComponentDescriptor> getComponents()

Returns a Map of the KerberosComponentDescriptors related to this KerberosServiceDescriptor

Returns:

a Map of String to KerberosComponentDescriptor

getComponent

public KerberosComponentDescriptor getComponent(String name)

Returns the KerberosComponentDescriptors with the specified name

Parameters:

name - the name of the component for which to retrieve a descriptor

Returns:

the KerberosComponentDescriptor for the requested component or null if not found

putComponent

public void putComponent(KerberosComponentDescriptor component)

Adds or replaces a KerberosComponentDescriptor

If a KerberosComponentDescriptor with the same name already exists in the components Map, it will be replaced; else a new entry will be made.

Parameters:

component - the KerberosComponentDescriptor to put

update

public void update(KerberosServiceDescriptor updates)

Updates this KerberosServiceDescriptor with data from another KerberosServiceDescriptor

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

Parameters:

updates - the KerberosServiceDescriptor containing the updated values

shouldPreconfigure

public boolean shouldPreconfigure()

Indicate whether this service should be preconfigured when determining configurations.

Returns:

true, to preconfigure; false, otherwise

setPreconfigure

public void setPreconfigure(Boolean preconfigure)

Sets whether this service should be preconfigured when determining configurations or not.

Parameters:

preconfigure - true, to preconfigure; false, otherwise

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 component descriptors and relies on the AbstractKerberosDescriptorContainer implementation to handle other 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 KerberosServiceDescriptor or generate the JSON structure described in KerberosServiceDescriptor

Overrides:

toMap in class AbstractKerberosDescriptorContainer

Returns:

a Map of values for this KerberosServiceDescriptor

See Also:

KerberosServiceDescriptor

getComponentIdentities

public List<KerberosIdentityDescriptor> getComponentIdentities(String componentName)

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractKerberosDescriptorContainer

equals

public boolean equals(Object object)

Overrides:

equals in class AbstractKerberosDescriptorContainer