Class AbstractHttpDiscoverySidecar<B extends HttpDiscoverySidecar<B>>

java.lang.Object

org.refcodes.rest.AbstractHttpDiscoverySidecar<B>

Type Parameters:

B - the generic type

All Implemented Interfaces:

Configurable<HttpDiscoveryContext>, Destroyable, Destroyable.DestroyAutomaton, Initializable, Initializable.InitializeAutomaton, InitializedAccessor, LifecycleComponent, LifecycleComponent.LifecycleAutomaton, LifecycleStatusAccessor, Pausable, Pausable.PauseAutomaton, Resumable, Resumable.ResumeAutomaton, RunningAccessor, Startable, Startable.StartAutomaton, Stoppable, Stoppable.StopAutomaton, HttpDiscovery<B>, HttpDiscoverySidecar<B>, HttpDiscoveryUrlAccessor, HttpDiscoveryUrlAccessor.HttpDiscoveryUrlBuilder<B>, HttpDiscoveryUrlAccessor.HttpDiscoveryUrlMutator, HttpDiscoveryUrlAccessor.HttpDiscoveryUrlProperty, TrustStoreDescriptorAccessor, TrustStoreDescriptorAccessor.TrustStoreDescriptorBuilder<B>, TrustStoreDescriptorAccessor.TrustStoreDescriptorMutator, TrustStoreDescriptorAccessor.TrustStoreDescriptorProperty, LoadBalancingStrategyAccessor, LoadBalancingStrategyAccessor.LoadBalancingStrategyBuilder<B>, LoadBalancingStrategyAccessor.LoadBalancingStrategyMutator, LoadBalancingStrategyAccessor.LoadBalancingStrategyProperty

public abstract class AbstractHttpDiscoverySidecar<B extends HttpDiscoverySidecar<B>>
extends Object
implements HttpDiscoverySidecar<B>

Abstract class for easily decorating a HttpRegistrySidecar.

Nested Class Summary

Nested classes/interfaces inherited from interface Configurable

Configurable.ConfigureAutomaton<CTX>, Configurable.ConfigureBuilder<CTX,B>

Nested classes/interfaces inherited from interface Destroyable

Destroyable.DestroyAutomaton

Nested classes/interfaces inherited from interface HttpDiscoveryUrlAccessor

HttpDiscoveryUrlAccessor.HttpDiscoveryUrlBuilder<B>, HttpDiscoveryUrlAccessor.HttpDiscoveryUrlMutator, HttpDiscoveryUrlAccessor.HttpDiscoveryUrlProperty

Nested classes/interfaces inherited from interface Initializable

Initializable.InitializeAutomaton, Initializable.InitializeBuilder<B>, Initializable.UncheckedInitializable

Nested classes/interfaces inherited from interface InitializedAccessor

InitializedAccessor.InitializedMutator, InitializedAccessor.InitializedProperty

Nested classes/interfaces inherited from interface LifecycleComponent

LifecycleComponent.LifecycleAutomaton, LifecycleComponent.UncheckedLifecycleComponent

Nested classes/interfaces inherited from interface LifecycleStatusAccessor

LifecycleStatusAccessor.LifecycleStatusBuilder<B>, LifecycleStatusAccessor.LifecycleStatusMutator, LifecycleStatusAccessor.LifecycleStatusProperty

Nested classes/interfaces inherited from interface LoadBalancingStrategyAccessor

LoadBalancingStrategyAccessor.LoadBalancingStrategyBuilder<B>, LoadBalancingStrategyAccessor.LoadBalancingStrategyMutator, LoadBalancingStrategyAccessor.LoadBalancingStrategyProperty

Nested classes/interfaces inherited from interface Pausable

Pausable.PauseAutomaton, Pausable.PauseBuilder<B>, Pausable.UncheckedPausable

Nested classes/interfaces inherited from interface Resumable

Resumable.ResumeAutomaton, Resumable.ResumeBuilder<B>, Resumable.UncheckedResumable

Nested classes/interfaces inherited from interface RunningAccessor

RunningAccessor.RunningMutator, RunningAccessor.RunningProperty

Nested classes/interfaces inherited from interface Startable

Startable.StartAutomaton, Startable.StartBuilder<B>, Startable.UncheckedStartable

Nested classes/interfaces inherited from interface Stoppable

Stoppable.StopAutomaton, Stoppable.StopBuilder<B>, Stoppable.UncheckedStoppable

Nested classes/interfaces inherited from interface TrustStoreDescriptorAccessor

TrustStoreDescriptorAccessor.TrustStoreDescriptorBuilder<B>, TrustStoreDescriptorAccessor.TrustStoreDescriptorMutator, TrustStoreDescriptorAccessor.TrustStoreDescriptorProperty

Field Summary

Fields

Modifier and Type	Field	Description
protected LifecycleMachine.ManualLifecycleMachine	_lifeCycleAutomaton

Constructor Summary

Constructors

Constructor	Description
AbstractHttpDiscoverySidecar()

Method Summary

Modifier and Type	Method	Description
void	destroy()	Stops resolving of the host part of an Url from the list of available services and their accordingly associated Url as of the discovery service.
Url	getHttpDiscoveryUrl()	Retrieves the URL from the URL property locating the service discovery discovery.
LifecycleStatus	getLifecycleStatus()
LoadBalancingStrategy	getLoadBalancingStrategy()
TrustStoreDescriptor	getTrustStoreDescriptor()
void	initialize()	Initially fetches the list of available services and their accordingly associated Url from the discovery service.
boolean	isDestroyable()
boolean	isDestroyed()
boolean	isInitalizable()
boolean	isInitialized()
boolean	isPausable()
boolean	isPaused()
boolean	isResumable()
boolean	isRunning()
boolean	isStartable()
boolean	isStoppable()
boolean	isStopped()
void	pause()	Pauses the resolving of the host part of an Url from the list of available services and their accordingly associated Url as of the discovery service.
void	resume()	Resumes the resolving of the host part of an Url from the list of available services and their accordingly associated Url as of the discovery service.
void	setHttpDiscoveryUrl(Url aUrl)	Sets the URL for the URL property locating the service discovery discovery.
void	setLoadBalancingStrategy(LoadBalancingStrategy aStrategy)
void	setTrustStoreDescriptor(TrustStoreDescriptor aTrustStoreDescriptor)
void	start()	Starts resolving of the host part of an Url from the list of available services and their accordingly associated Url as of the discovery service.
void	stop()	Stops resolving of the host part of an Url from the list of available services and their accordingly associated Url as of the discovery service.
protected static Url	toHttpDiscoveryUrl(Url aDiscoveryUrl, HttpDiscoveryUrlAccessor.HttpDiscoveryUrlProperty aProperty)	Resolves the property from the provided value and the provided property and the and sets the property in case the provided value is not null.
protected static LoadBalancingStrategy	toLoadBalancingStrategy(LoadBalancingStrategy aStrategy, LoadBalancingStrategyAccessor.LoadBalancingStrategyProperty aProperty)	Resolves the property from the provided value and the provided property and the and sets the property in case the provided value is not null.
protected static TrustStoreDescriptor	toTrustStoreDescriptor(TrustStoreDescriptor aStoreDescriptor, TrustStoreDescriptorAccessor.TrustStoreDescriptorProperty aProperty)	Resolves the property from the provided value and the provided property and the and sets the property in case the provided value is not null.

Methods inherited from class Object

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

Methods inherited from interface Configurable

initializeUnchecked

Methods inherited from interface HttpDiscovery

initialize, initialize, initialize, initialize, initialize, toUrl, toUrl, toUrl, toUrl, toUrl, toUrl, toUrl, toUrl, toUrl, toUrl, toUrl, toUrl, toUrl, toUrl, toUrl, toUrl, toUrl, toUrl, toUrl, toUrl, toUrl, toUrl, toUrl, withHttpDiscoveryUrl, withLoadBalancingStrategy

Methods inherited from interface HttpDiscoverySidecar

withTrustStoreDescriptor

Methods inherited from interface HttpDiscoveryUrlAccessor.HttpDiscoveryUrlProperty

letHttpDiscoveryUrl

Methods inherited from interface Initializable

initializeUnchecked

Methods inherited from interface LoadBalancingStrategyAccessor.LoadBalancingStrategyProperty

letLoadBalancingStrategy

Methods inherited from interface Pausable

pauseUnchecked

Methods inherited from interface Resumable

resumeUnchecked

Methods inherited from interface Startable

startUnchecked

Methods inherited from interface Stoppable

stopUnchecked

Methods inherited from interface TrustStoreDescriptorAccessor.TrustStoreDescriptorProperty

letTrustStoreDescriptor

Field Details

_lifeCycleAutomaton

protected LifecycleMachine.ManualLifecycleMachine _lifeCycleAutomaton

Constructor Details

AbstractHttpDiscoverySidecar

public AbstractHttpDiscoverySidecar()

Method Details

isRunning

public boolean isRunning()

Specified by:

isRunning in interface RunningAccessor

isInitialized

public boolean isInitialized()

Specified by:

isInitialized in interface InitializedAccessor

getLifecycleStatus

public LifecycleStatus getLifecycleStatus()

Specified by:

getLifecycleStatus in interface LifecycleStatusAccessor

pause

public void pause()
           throws PauseException

Pauses the resolving of the host part of an Url from the list of available services and their accordingly associated Url as of the discovery service.

Specified by:

pause in interface HttpDiscovery<B extends HttpDiscoverySidecar<B>>

Specified by:

pause in interface Pausable

Throws:

PauseException

stop

public void stop()
          throws StopException

Stops resolving of the host part of an Url from the list of available services and their accordingly associated Url as of the discovery service. Does not update the list of available services and their accordingly associated Url from the discovery service. This may be achieved by canceling a scheduler.

Specified by:

stop in interface HttpDiscovery<B extends HttpDiscoverySidecar<B>>

Specified by:

stop in interface Stoppable

Throws:

StopException

start

public void start()
           throws StartException

Starts resolving of the host part of an Url from the list of available services and their accordingly associated Url as of the discovery service. Takes care to update the list of available services and their accordingly associated Url from the discovery service. This may be achieved by starting a scheduler. If necessary, the connection is opened.

Specified by:

start in interface HttpDiscovery<B extends HttpDiscoverySidecar<B>>

Specified by:

start in interface Startable

Throws:

StartException

resume

public void resume()
            throws ResumeException

Resumes the resolving of the host part of an Url from the list of available services and their accordingly associated Url as of the discovery service.

Specified by:

resume in interface HttpDiscovery<B extends HttpDiscoverySidecar<B>>

Specified by:

resume in interface Resumable

Throws:

ResumeException

initialize

public void initialize()
                throws InitializeException

Initially fetches the list of available services and their accordingly associated Url from the discovery service. Sets up the client according to the current client's state when invoking HttpDiscovery.initialize(Url, LoadBalancingStrategy, TrustStoreDescriptor).

Specified by:

initialize in interface HttpDiscovery<B extends HttpDiscoverySidecar<B>>

Specified by:

initialize in interface Initializable

Throws:

InitializeException

isStoppable

public boolean isStoppable()

Specified by:

isStoppable in interface Stoppable.StopAutomaton

isPausable

public boolean isPausable()

Specified by:

isPausable in interface Pausable.PauseAutomaton

isStartable

public boolean isStartable()

Specified by:

isStartable in interface Startable.StartAutomaton

isResumable

public boolean isResumable()

Specified by:

isResumable in interface Resumable.ResumeAutomaton

isStopped

public boolean isStopped()

Specified by:

isStopped in interface Stoppable.StopAutomaton

isPaused

public boolean isPaused()

Specified by:

isPaused in interface Pausable.PauseAutomaton

isInitalizable

public boolean isInitalizable()

Specified by:

isInitalizable in interface Initializable.InitializeAutomaton

destroy

public void destroy()

Stops resolving of the host part of an Url from the list of available services and their accordingly associated Url as of the discovery service. Does not update the list of available services and their accordingly associated Url from the discovery service. This may be achieved by canceling a scheduler. Finally the connection is closed.

Specified by:

destroy in interface Destroyable

Specified by:

destroy in interface HttpDiscovery<B extends HttpDiscoverySidecar<B>>

isDestroyable

public boolean isDestroyable()

Specified by:

isDestroyable in interface Destroyable.DestroyAutomaton

isDestroyed

public boolean isDestroyed()

Specified by:

isDestroyed in interface Destroyable.DestroyAutomaton

getLoadBalancingStrategy

public LoadBalancingStrategy getLoadBalancingStrategy()

Specified by:

getLoadBalancingStrategy in interface LoadBalancingStrategyAccessor

setHttpDiscoveryUrl

public void setHttpDiscoveryUrl(Url aUrl)

Sets the URL for the URL property locating the service discovery discovery.

Specified by:

setHttpDiscoveryUrl in interface HttpDiscoveryUrlAccessor.HttpDiscoveryUrlMutator

Parameters:

aUrl - The service discovery discovery URL to be stored by the URL property.

setLoadBalancingStrategy

public void setLoadBalancingStrategy(LoadBalancingStrategy aStrategy)

Specified by:

setLoadBalancingStrategy in interface LoadBalancingStrategyAccessor.LoadBalancingStrategyMutator

getTrustStoreDescriptor

public TrustStoreDescriptor getTrustStoreDescriptor()

Specified by:

getTrustStoreDescriptor in interface TrustStoreDescriptorAccessor

setTrustStoreDescriptor

public void setTrustStoreDescriptor(TrustStoreDescriptor aTrustStoreDescriptor)

Specified by:

setTrustStoreDescriptor in interface TrustStoreDescriptorAccessor.TrustStoreDescriptorMutator

getHttpDiscoveryUrl

public Url getHttpDiscoveryUrl()

Retrieves the URL from the URL property locating the service discovery discovery.

Specified by:

getHttpDiscoveryUrl in interface HttpDiscoveryUrlAccessor

Returns:

The URL stored by the URL property.

toLoadBalancingStrategy

protected static LoadBalancingStrategy toLoadBalancingStrategy(LoadBalancingStrategy aStrategy,
 LoadBalancingStrategyAccessor.LoadBalancingStrategyProperty aProperty)

Resolves the property from the provided value and the provided property and the and sets the property in case the provided value is not null.

Parameters:

aStrategy - The value to be used when not null.

aProperty - The property to be used when the value is null and which is to be set when the value is not null.

Returns:

The value when not null, else the value of the provided property.

toTrustStoreDescriptor

protected static TrustStoreDescriptor toTrustStoreDescriptor(TrustStoreDescriptor aStoreDescriptor,
 TrustStoreDescriptorAccessor.TrustStoreDescriptorProperty aProperty)

Resolves the property from the provided value and the provided property and the and sets the property in case the provided value is not null.

Parameters:

aStoreDescriptor - The value to be used when not null.

aProperty - The property to be used when the value is null and which is to be set when the value is not null.

Returns:

The value when not null, else the value of the provided property.

toHttpDiscoveryUrl

protected static Url toHttpDiscoveryUrl(Url aDiscoveryUrl,
 HttpDiscoveryUrlAccessor.HttpDiscoveryUrlProperty aProperty)

Resolves the property from the provided value and the provided property and the and sets the property in case the provided value is not null.

Parameters:

aDiscoveryUrl - The value to be used when not null.

aProperty - The property to be used when the value is null and which is to be set when the value is not null.

Returns:

The value when not null, else the value of the provided property.