AbstractDiscoveryLifecycle (Spring Cloud Commons 1.0.4.RELEASE API)

java.lang.Object
- org.springframework.cloud.client.discovery.AbstractDiscoveryLifecycle

All Implemented Interfaces:

EventListener, org.springframework.beans.factory.Aware, DiscoveryLifecycle, org.springframework.context.ApplicationContextAware, org.springframework.context.ApplicationListener<org.springframework.boot.context.embedded.EmbeddedServletContainerInitializedEvent>, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle, org.springframework.core.Ordered
```
public abstract class AbstractDiscoveryLifecycle
extends Object
implements DiscoveryLifecycle, org.springframework.context.ApplicationContextAware, org.springframework.context.ApplicationListener<org.springframework.boot.context.embedded.EmbeddedServletContainerInitializedEvent>
```
Lifecycle methods that may be useful and common to various DiscoveryClient implementations.

Author:

Spencer Gibb

Field Summary
- Fields inherited from interface org.springframework.core.Ordered
  HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors
Constructor and Description

AbstractDiscoveryLifecycle()

Constructors
Constructor and Description
`AbstractDiscoveryLifecycle()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected abstract void`	`deregister()` De-register the local service with the DiscoveryClient
`protected void`	`deregisterManagement()` De-register the local management service with the DiscoveryClient
`void`	`destroy()`
`protected String`	`getAppName()`
`protected abstract Object`	`getConfiguration()`
`protected abstract int`	`getConfiguredPort()`
`protected org.springframework.context.ApplicationContext`	`getContext()`
`protected org.springframework.core.env.Environment`	`getEnvironment()`
`protected Integer`	`getManagementPort()`
`protected String`	`getManagementServiceId()`
`protected String`	`getManagementServiceName()`
`int`	`getOrder()`
`int`	`getPhase()`
`protected AtomicInteger`	`getPort()`
`boolean`	`isAutoStartup()`
`protected abstract boolean`	`isEnabled()`
`boolean`	`isRunning()`
`void`	`onApplicationEvent(org.springframework.boot.context.embedded.EmbeddedServletContainerInitializedEvent event)`
`protected abstract void`	`register()` Register the local service with the DiscoveryClient
`protected void`	`registerManagement()` Register the local management service with the DiscoveryClient
`void`	`setApplicationContext(org.springframework.context.ApplicationContext applicationContext)`
`protected abstract void`	`setConfiguredPort(int port)`
`protected boolean`	`shouldRegisterManagement()`
`void`	`start()`
`void`	`stop()`
`void`	`stop(Runnable callback)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AbstractDiscoveryLifecycle
```
public AbstractDiscoveryLifecycle()
```
- Method Detail
  - getContext
```
protected org.springframework.context.ApplicationContext getContext()
```
  - setApplicationContext
```
public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException
```
    Specified by:
    
    setApplicationContext in interface org.springframework.context.ApplicationContextAware
    
    Throws:
    
    org.springframework.beans.BeansException
  - getEnvironment
```
protected org.springframework.core.env.Environment getEnvironment()
```
  - getPort
```
protected AtomicInteger getPort()
```
  - isAutoStartup
```
public boolean isAutoStartup()
```
    Specified by:
    
    isAutoStartup in interface org.springframework.context.SmartLifecycle
  - stop
```
public void stop(Runnable callback)
```
    Specified by:
    
    stop in interface org.springframework.context.SmartLifecycle
  - start
```
public void start()
```
    Specified by:
    
    start in interface org.springframework.context.Lifecycle
  - getConfiguredPort
```
protected abstract int getConfiguredPort()
```
  - setConfiguredPort
```
protected abstract void setConfiguredPort(int port)
```
  - shouldRegisterManagement
```
protected boolean shouldRegisterManagement()
```
    Returns:
    
    if the management service should be registered with the DiscoveryService
  - getConfiguration
```
protected abstract Object getConfiguration()
```
    Returns:
    
    the object used to configure the DiscoveryClient
  - register
```
protected abstract void register()
```
    Register the local service with the DiscoveryClient
  - registerManagement
```
protected void registerManagement()
```
    Register the local management service with the DiscoveryClient
  - deregister
```
protected abstract void deregister()
```
    De-register the local service with the DiscoveryClient
  - deregisterManagement
```
protected void deregisterManagement()
```
    De-register the local management service with the DiscoveryClient
  - isEnabled
```
protected abstract boolean isEnabled()
```
    Returns:
    
    if the DiscoveryClient is enabled
  - getManagementServiceId
```
protected String getManagementServiceId()
```
    Returns:
    
    the serviceId of the Management Service
  - getManagementServiceName
```
protected String getManagementServiceName()
```
    Returns:
    
    the service name of the Management Service
  - getManagementPort
```
protected Integer getManagementPort()
```
    Returns:
    
    the management server port
  - getAppName
```
protected String getAppName()
```
    Returns:
    
    the app name, currently the spring.application.name property
  - stop
```
public void stop()
```
    Specified by:
    
    stop in interface org.springframework.context.Lifecycle
  - destroy
```
@PreDestroy
public void destroy()
```
  - isRunning
```
public boolean isRunning()
```
    Specified by:
    
    isRunning in interface org.springframework.context.Lifecycle
  - getOrder
```
public int getOrder()
```
    Specified by:
    
    getOrder in interface org.springframework.core.Ordered
  - getPhase
```
public int getPhase()
```
    Specified by:
    
    getPhase in interface org.springframework.context.Phased
  - onApplicationEvent
```
public void onApplicationEvent(org.springframework.boot.context.embedded.EmbeddedServletContainerInitializedEvent event)
```
    Specified by:
    
    onApplicationEvent in interface org.springframework.context.ApplicationListener<org.springframework.boot.context.embedded.EmbeddedServletContainerInitializedEvent>

Class AbstractDiscoveryLifecycle

Field Summary

Fields inherited from interface org.springframework.core.Ordered

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractDiscoveryLifecycle

Method Detail

getContext

setApplicationContext

getEnvironment

getPort

isAutoStartup

stop

start

getConfiguredPort

setConfiguredPort

shouldRegisterManagement

getConfiguration

register

registerManagement

deregister

deregisterManagement

isEnabled

getManagementServiceId

getManagementServiceName

getManagementPort

getAppName

stop

destroy

isRunning

getOrder

getPhase

onApplicationEvent