org.apache.ambari.server.serveraction.kerberos

Class AbstractPrepareKerberosServerAction

java.lang.Object

org.apache.ambari.server.serveraction.AbstractServerAction

org.apache.ambari.server.serveraction.kerberos.KerberosServerAction

org.apache.ambari.server.serveraction.kerberos.AbstractPrepareKerberosServerAction

All Implemented Interfaces:

ServerAction

Direct Known Subclasses:

PrepareDisableKerberosServerAction, PrepareKerberosIdentitiesServerAction

public abstract class AbstractPrepareKerberosServerAction
extends KerberosServerAction

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.ambari.server.serveraction.kerberos.KerberosServerAction

KerberosServerAction.KerberosCommandParameters, KerberosServerAction.OperationType

Field Summary

Fields inherited from class org.apache.ambari.server.serveraction.kerberos.KerberosServerAction

AUTHENTICATED_USER_NAME, DATA_DIRECTORY, DATA_DIRECTORY_PREFIX, DEFAULT_REALM, HOST_FILTER, IDENTITY_FILTER, INCLUDE_AMBARI_IDENTITY, KDC_TYPE, KEYTAB_CONTENT_BASE64, OPERATION_TYPE, PRECONFIGURE_SERVICES, SERVICE_COMPONENT_FILTER, UPDATE_CONFIGURATION_NOTE, UPDATE_CONFIGURATION_POLICY

Fields inherited from class org.apache.ambari.server.serveraction.AbstractServerAction

actionLog, gson

Fields inherited from interface org.apache.ambari.server.serveraction.ServerAction

ACTION_NAME, ACTION_USER_NAME, DEFAULT_LONG_RUNNING_TASK_TIMEOUT_SECONDS, WRAPPED_CLASS_NAME

Constructor Summary

Constructors

Constructor and Description
AbstractPrepareKerberosServerAction()

Method Summary

Modifier and Type	Method and Description
protected KerberosHelper	getKerberosHelper()
protected void	processConfigurationChanges(String dataDirectory, Map<String,Map<String,String>> kerberosConfigurations, Map<String,Set<String>> propertiesToBeRemoved, KerberosDescriptor kerberosDescriptor, UpdateConfigurationPolicy updateConfigurationPolicy) Processes configuration changes to determine if any work needs to be done.
protected CommandReport	processIdentity(ResolvedKerberosPrincipal resolvedPrincipal, KerberosOperationHandler operationHandler, Map<String,String> kerberosConfiguration, boolean includedInFilter, Map<String,Object> requestSharedDataContext) Processes an identity as necessary.
void	processServiceComponentHosts(Cluster cluster, KerberosDescriptor kerberosDescriptor, List<ServiceComponentHost> schToProcess, Collection<String> identityFilter, String dataDirectory, Map<String,Map<String,String>> currentConfigurations, Map<String,Map<String,String>> kerberosConfigurations, boolean includeAmbariIdentity, Map<String,Set<String>> propertiesToBeIgnored)
protected void	processServiceComponents(Cluster cluster, KerberosDescriptor kerberosDescriptor, List<Component> schToProcess, Collection<String> identityFilter, String dataDirectory, Map<String,Map<String,String>> currentConfigurations, Map<String,Map<String,String>> kerberosConfigurations, boolean includeAmbariIdentity, Map<String,Set<String>> propertiesToBeIgnored)

Methods inherited from class org.apache.ambari.server.serveraction.kerberos.KerberosServerAction

ambariServerHostID, deleteDataDirectory, getCluster, getClusterName, getClusters, getCommandParameterValue, getCommandPreconfigureType, getConfigurationProperties, getDataDirectoryPath, getDataDirectoryPath, getDefaultRealm, getHostFilter, getIdentityFilter, getKDCType, getOperationType, getPrincipalKeyNumberMap, getPrincipalPasswordMap, getServiceComponentFilter, getUpdateConfigurationPolicy, hasHostFilters, processIdentities, pruneServiceFilter, setPrincipalPasswordMap

Methods inherited from class org.apache.ambari.server.serveraction.AbstractServerAction

auditLog, createCommandReport, createCompletedCommandReport, getCommandParameters, getCommandParameterValue, getExecutionCommand, getHostRoleCommand, setExecutionCommand, setHostRoleCommand

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.ambari.server.serveraction.ServerAction

execute

Constructor Detail

AbstractPrepareKerberosServerAction

public AbstractPrepareKerberosServerAction()

Method Detail

processIdentity

protected CommandReport processIdentity(ResolvedKerberosPrincipal resolvedPrincipal,
                                        KerberosOperationHandler operationHandler,
                                        Map<String,String> kerberosConfiguration,
                                        boolean includedInFilter,
                                        Map<String,Object> requestSharedDataContext)
                                 throws org.apache.ambari.server.AmbariException

Description copied from class: KerberosServerAction

Processes an identity as necessary.

This method is called from KerberosServerAction.processIdentities(Map) for each principal found by specified filter. After processing, it is expected that the return value is null on success and a CommandReport (indicating the error) on failure.

Specified by:

processIdentity in class KerberosServerAction

Parameters:

resolvedPrincipal - a ResolvedKerberosPrincipal object to process

operationHandler - a KerberosOperationHandler used to perform Kerberos-related tasks for specific Kerberos implementations (MIT, Active Directory, etc...)

kerberosConfiguration - a Map of configuration properties from kerberos-env

includedInFilter - a Boolean value indicating whather the principal is included in the current filter or not

requestSharedDataContext - a Map to be used a shared data among all ServerActions related to a given request @return a CommandReport, indicating an error condition; or null, indicating a success condition

Throws:

org.apache.ambari.server.AmbariException - if an error occurs while processing the identity record

getKerberosHelper

protected KerberosHelper getKerberosHelper()

processServiceComponentHosts

public void processServiceComponentHosts(Cluster cluster,
                                         KerberosDescriptor kerberosDescriptor,
                                         List<ServiceComponentHost> schToProcess,
                                         Collection<String> identityFilter,
                                         String dataDirectory,
                                         Map<String,Map<String,String>> currentConfigurations,
                                         Map<String,Map<String,String>> kerberosConfigurations,
                                         boolean includeAmbariIdentity,
                                         Map<String,Set<String>> propertiesToBeIgnored)
                                  throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

processServiceComponents

protected void processServiceComponents(Cluster cluster,
                                        KerberosDescriptor kerberosDescriptor,
                                        List<Component> schToProcess,
                                        Collection<String> identityFilter,
                                        String dataDirectory,
                                        Map<String,Map<String,String>> currentConfigurations,
                                        Map<String,Map<String,String>> kerberosConfigurations,
                                        boolean includeAmbariIdentity,
                                        Map<String,Set<String>> propertiesToBeIgnored)
                                 throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

processConfigurationChanges

protected void processConfigurationChanges(String dataDirectory,
                                           Map<String,Map<String,String>> kerberosConfigurations,
                                           Map<String,Set<String>> propertiesToBeRemoved,
                                           KerberosDescriptor kerberosDescriptor,
                                           UpdateConfigurationPolicy updateConfigurationPolicy)
                                    throws org.apache.ambari.server.AmbariException

Processes configuration changes to determine if any work needs to be done.

If work is to be done, a data file containing the details is created so it they changes may be processed in the appropriate stage.

Parameters:

dataDirectory - the directory in which to write the configuration changes data file

kerberosConfigurations - the Kerberos-specific configuration map

propertiesToBeRemoved - a map of properties to be removed from the current configuration, grouped by configuration type.

kerberosDescriptor - the Kerberos descriptor

updateConfigurationPolicy - the policy used to determine which configurations to update

Throws:

org.apache.ambari.server.AmbariException