org.apache.ambari.server.state

Interface Service

All Known Implementing Classes:

ServiceImpl

public interface Service

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Service.Type

Method Summary

Modifier and Type	Method and Description
void	addServiceComponent(ServiceComponent component)
ServiceComponent	addServiceComponent(String serviceComponentName)
void	addServiceComponents(Map<String,ServiceComponent> components)
boolean	canBeRemoved() Find out whether the service and its components are in a state that it can be removed from a cluster
ServiceResponse	convertToResponse()
void	debugDump(StringBuilder sb)
void	delete(DeleteHostComponentStatusMetaData deleteMetaData)
void	deleteAllComponents(DeleteHostComponentStatusMetaData deleteMetaData)
void	deleteServiceComponent(String componentName, DeleteHostComponentStatusMetaData deleteMetaData)
Cluster	getCluster()
long	getClusterId()
RepositoryVersionEntity	getDesiredRepositoryVersion()
StackId	getDesiredStackId()
State	getDesiredState()
String	getDisplayName()
MaintenanceState	getMaintenanceState()
String	getName()
RepositoryVersionState	getRepositoryState() Gets the repository for the desired version of this service by consulting the repository states of all known components.
ServiceComponent	getServiceComponent(String componentName)
Map<String,ServiceComponent>	getServiceComponents()
Set<String>	getServiceHosts()
boolean	isClientOnlyService()
boolean	isCredentialStoreEnabled() Get a true or false value specifying whether credential store use is enabled for this service.
boolean	isCredentialStoreRequired() Get a true or false value specifying whether credential store is required by this service.
boolean	isCredentialStoreSupported() Get a true or false value specifying whether credential store is supported by this service.
boolean	isKerberosEnabled() Tests to see if Kerberos is enabled for this service using the Kerberos enabled test metadata and the existing cluster configurations.
boolean	isKerberosEnabled(Map<String,Map<String,String>> configurations) Tests to see if Kerberos is enabled for this service using the Kerberos enabled test metadata and the supplied configurations map.
void	setCredentialStoreEnabled(boolean credentialStoreEnabled) Set a true or false value specifying whether this service is to be enabled for credential store use.
void	setDesiredRepositoryVersion(RepositoryVersionEntity desiredRepositoryVersion)
void	setDesiredState(State state)
void	setMaintenanceState(MaintenanceState state) Sets the maintenance state for the service
void	updateServiceInfo() Refresh Service info due to current stack

Method Detail

getName

String getName()

getDisplayName

String getDisplayName()

getClusterId

long getClusterId()

getCluster

Cluster getCluster()

getServiceComponent

ServiceComponent getServiceComponent(String componentName)
                              throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

getServiceComponents

Map<String,ServiceComponent> getServiceComponents()

getServiceHosts

Set<String> getServiceHosts()

addServiceComponents

void addServiceComponents(Map<String,ServiceComponent> components)
                   throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

addServiceComponent

void addServiceComponent(ServiceComponent component)
                  throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

getDesiredState

State getDesiredState()

setDesiredState

void setDesiredState(State state)

getDesiredStackId

StackId getDesiredStackId()

convertToResponse

ServiceResponse convertToResponse()

debugDump

void debugDump(StringBuilder sb)

addServiceComponent

ServiceComponent addServiceComponent(String serviceComponentName)
                              throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

canBeRemoved

boolean canBeRemoved()

Find out whether the service and its components are in a state that it can be removed from a cluster

Returns:

deleteAllComponents

void deleteAllComponents(DeleteHostComponentStatusMetaData deleteMetaData)

deleteServiceComponent

void deleteServiceComponent(String componentName,
                            DeleteHostComponentStatusMetaData deleteMetaData)
                     throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

isClientOnlyService

boolean isClientOnlyService()

delete

void delete(DeleteHostComponentStatusMetaData deleteMetaData)

setMaintenanceState

void setMaintenanceState(MaintenanceState state)

Sets the maintenance state for the service

Parameters:

state - the state

getMaintenanceState

MaintenanceState getMaintenanceState()

Returns:

the maintenance state

isKerberosEnabled

boolean isKerberosEnabled()

Tests to see if Kerberos is enabled for this service using the Kerberos enabled test metadata and the existing cluster configurations.

Returns:

true. if it is determined that Kerberos is enabled for this service; false, otherwise

See Also:

isKerberosEnabled(Map)

isKerberosEnabled

boolean isKerberosEnabled(Map<String,Map<String,String>> configurations)

Tests to see if Kerberos is enabled for this service using the Kerberos enabled test metadata and the supplied configurations map.

Parameters:

configurations - a map of configurations to use for the test

Returns:

true. if it is determined that Kerberos is enabled for this service; false, otherwise

See Also:

isKerberosEnabled()

updateServiceInfo

void updateServiceInfo()
                throws org.apache.ambari.server.AmbariException

Refresh Service info due to current stack

Throws:

org.apache.ambari.server.AmbariException

isCredentialStoreSupported

boolean isCredentialStoreSupported()

Get a true or false value specifying whether credential store is supported by this service.

Returns:

true or false

isCredentialStoreRequired

boolean isCredentialStoreRequired()

Get a true or false value specifying whether credential store is required by this service.

Returns:

true or false

isCredentialStoreEnabled

boolean isCredentialStoreEnabled()

Get a true or false value specifying whether credential store use is enabled for this service.

Returns:

true or false

setCredentialStoreEnabled

void setCredentialStoreEnabled(boolean credentialStoreEnabled)

Set a true or false value specifying whether this service is to be enabled for credential store use.

Parameters:

credentialStoreEnabled - - true or false

getDesiredRepositoryVersion

RepositoryVersionEntity getDesiredRepositoryVersion()

Returns:

setDesiredRepositoryVersion

void setDesiredRepositoryVersion(RepositoryVersionEntity desiredRepositoryVersion)

Parameters:

desiredRepositoryVersion -

getRepositoryState

RepositoryVersionState getRepositoryState()

Gets the repository for the desired version of this service by consulting the repository states of all known components.