Service (Ambari Main 1.5.1-SNAPSHOT API)

All Known Implementing Classes:

ServiceImpl
```
public interface Service
```

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class Service.Type

Nested Classes
Modifier and Type	Interface and Description
`static class`	`Service.Type`

Method Summary

All Methods Instance Methods Abstract Methods
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()`
`void`	`deleteAllComponents()`
`void`	`deleteServiceComponent(String componentName)`
`Cluster`	`getCluster()`
`ReadWriteLock`	`getClusterGlobalLock()` Get lock to control access to cluster structure
`long`	`getClusterId()`
`StackId`	`getDesiredStackVersion()`
`State`	`getDesiredState()`
`MaintenanceState`	`getMaintenanceState()`
`String`	`getName()`
`ServiceComponent`	`getServiceComponent(String componentName)`
`Map<String,ServiceComponent>`	`getServiceComponents()`
`boolean`	`isClientOnlyService()`
`boolean`	`isPersisted()`
`void`	`persist()`
`void`	`refresh()`
`void`	`setDesiredStackVersion(StackId stackVersion)`
`void`	`setDesiredState(State state)`
`void`	`setMaintenanceState(MaintenanceState state)` Sets the maintenance state for the service

Method Detail

getName
```
String getName()
```

getClusterId
```
long getClusterId()
```

getCluster
```
Cluster getCluster()
```

getServiceComponent

ServiceComponent getServiceComponent(String componentName)
                              throws AmbariException

Throws:: AmbariException

getServiceComponents

Map<String,ServiceComponent> getServiceComponents()

addServiceComponents

void addServiceComponents(Map<String,ServiceComponent> components)
                   throws AmbariException

Throws:: AmbariException

addServiceComponent

void addServiceComponent(ServiceComponent component)
                  throws AmbariException

Throws:: AmbariException

getDesiredState
```
State getDesiredState()
```

setDesiredState
```
void setDesiredState(State state)
```

getDesiredStackVersion
```
StackId getDesiredStackVersion()
```

setDesiredStackVersion

void setDesiredStackVersion(StackId stackVersion)

convertToResponse
```
ServiceResponse convertToResponse()
```

debugDump
```
void debugDump(StringBuilder sb)
```

isPersisted
```
boolean isPersisted()
```

persist
```
void persist()
```

refresh
```
void refresh()
```

addServiceComponent

ServiceComponent addServiceComponent(String serviceComponentName)
                              throws AmbariException

Throws:: 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()
                  throws AmbariException

Throws:: AmbariException

deleteServiceComponent

void deleteServiceComponent(String componentName)
                     throws AmbariException

Throws:: AmbariException

isClientOnlyService
```
boolean isClientOnlyService()
```

delete

void delete()
     throws AmbariException

Throws:: AmbariException

getClusterGlobalLock
```
ReadWriteLock getClusterGlobalLock()
```
Get lock to control access to cluster structure

Returns:

cluster-global lock

setMaintenanceState
```
void setMaintenanceState(MaintenanceState state)
```
Sets the maintenance state for the service

Parameters:

state - the state

getMaintenanceState
```
MaintenanceState getMaintenanceState()
```
Returns:

the maintenance state

Interface Service

Nested Class Summary

Method Summary

Method Detail

getName

getClusterId

getCluster

getServiceComponent

getServiceComponents

addServiceComponents

addServiceComponent

getDesiredState

setDesiredState

getDesiredStackVersion

setDesiredStackVersion

convertToResponse

debugDump

isPersisted

persist

refresh

addServiceComponent

canBeRemoved

deleteAllComponents

deleteServiceComponent

isClientOnlyService

delete

getClusterGlobalLock

setMaintenanceState

getMaintenanceState