Interface HttpRestRegistryServer<DESC extends HttpServerDescriptor, B extends HttpRestRegistryServer<DESC,B>>

Type Parameters:

DESC - The type of the server discovery descriptor (the object describing your service and locating the service registry).

B - In order to implement the builder pattern with a coherent type hierarchy.

All Superinterfaces:

AliasAccessor, AliasAccessor.AliasBuilder<B>, AliasAccessor.AliasMutator, AliasAccessor.AliasProperty, BaseLocatorAccessor, BaseLocatorAccessor.BaseLocatorBuilder<RestServer>, BaseLocatorAccessor.BaseLocatorMutator, BaseLocatorAccessor.BaseLocatorProperty, BasicAuthObservable<HttpRestServer>, Closable, Closable.CloseBuilder<ConnectionComponent.ConnectionComponentBuilder<HttpServerContext, HttpRestServer>>, Configurable<HttpRegistryContext<DESC>>, ConnectionComponent<HttpServerContext>, ConnectionComponent.ConnectionComponentBuilder<HttpServerContext, HttpRestServer>, ConnectionOpenable<HttpServerContext>, ConnectionOpenable.ConnectionOpenBuilder<HttpServerContext, ConnectionComponent.ConnectionComponentBuilder<HttpServerContext, HttpRestServer>>, ConnectionStatusAccessor, Destroyable, Destroyable.DestroyAutomaton, HostAccessor, HostAccessor.HostBuilder<B>, HostAccessor.HostMutator, HostAccessor.HostProperty, HttpExceptionHandlerAccessor, HttpExceptionHandlerAccessor.HttpExceptionHandlerBuilder<HttpRestServer>, HttpExceptionHandlerAccessor.HttpExceptionHandlerMutator, HttpExceptionHandlerAccessor.HttpExceptionHandlerProperty, HttpExceptionHandlingAccessor, HttpExceptionHandlingAccessor.HttpExceptionHandlingBuilder<HttpRestServer>, HttpExceptionHandlingAccessor.HttpExceptionHandlingMutator, HttpExceptionHandlingAccessor.HttpExceptionHandlingProperty, HttpRegistry<DESC,B>, HttpRegistryUrlAccessor, HttpRegistryUrlAccessor.HttpRegistryUrlBuilder<B>, HttpRegistryUrlAccessor.HttpRegistryUrlMutator, HttpRegistryUrlAccessor.HttpRegistryUrlProperty, HttpRestServer, HttpsConnectionRequestObservable<HttpRestServer>, HttpServerDescriptorAccessor<DESC>, HttpServerDescriptorAccessor.HttpServerDescriptorBuilder<DESC,B>, HttpServerDescriptorAccessor.HttpServerDescriptorMutator<DESC>, HttpServerDescriptorAccessor.HttpServerDescriptorProperty<DESC>, HttpServerDescriptorFactory<DESC>, HttpServerInterceptable, Initializable, Initializable.InitializeAutomaton, InitializedAccessor, InstanceIdAccessor, InstanceIdAccessor.InstanceIdBuilder<B>, InstanceIdAccessor.InstanceIdMutator, InstanceIdAccessor.InstanceIdProperty, IpAddressAccessor, IpAddressAccessor.IpAddressBuilder<B>, IpAddressAccessor.IpAddressMutator, IpAddressAccessor.IpAddressProperty, KeyStoreDescriptorAccessor, KeyStoreDescriptorAccessor.KeyStoreDescriptorBuilder<HttpRestServer>, KeyStoreDescriptorAccessor.KeyStoreDescriptorMutator, KeyStoreDescriptorAccessor.KeyStoreDescriptorProperty, LifecycleComponent, LifecycleComponent.LifecycleAutomaton, LifecycleStatusAccessor, LinkComponent, MaxConnectionsAccessor, MaxConnectionsAccessor.MaxConnectionsBuilder<HttpRestServer>, MaxConnectionsAccessor.MaxConnectionsMutator, MaxConnectionsAccessor.MaxConnectionsProperty, MediaTypeFactoryLookup, MediaTypeFactoryLookup.MutableMediaTypeFactoryLookup, Observable<RestEndpoint>, Observers<RestEndpoint, RestServer>, Openable, OpenedAccessor, Pausable, Pausable.PauseAutomaton, PingPathAccessor, PingPathAccessor.PingPathBuilder<B>, PingPathAccessor.PingPathMutator, PingPathAccessor.PingPathProperty, PingRequestObserver, PingRequestObserverAccessor, PingRequestObserverAccessor.PingRequestObserverBuilder<B>, PortAccessor, PortAccessor.PortBuilder<HttpRestServer>, PortAccessor.PortMutator, PortAccessor.PortProperty, PostHttpInterceptable<PostHttpServerInterceptor>, PostHttpServerInterceptable, PreHttpInterceptable<PreHttpServerInterceptor>, PreHttpServerInterceptable, RealmAccessor, RealmAccessor.RealmBuilder<RestServer>, RealmAccessor.RealmMutator, RealmAccessor.RealmProperty, RestServer, Resumable, Resumable.ResumeAutomaton, RunningAccessor, SchemeAccessor, SchemeAccessor.SchemeBuilder<HttpRestServer>, SchemeAccessor.SchemeMutator, SchemeAccessor.SchemeProperty, Startable, Startable.StartAutomaton, Stoppable, Stoppable.StopAutomaton, TrustStoreDescriptorAccessor, TrustStoreDescriptorAccessor.TrustStoreDescriptorBuilder<B>, TrustStoreDescriptorAccessor.TrustStoreDescriptorMutator, TrustStoreDescriptorAccessor.TrustStoreDescriptorProperty, VirtualHostAccessor, VirtualHostAccessor.VirtualHostBuilder<B>, VirtualHostAccessor.VirtualHostMutator, VirtualHostAccessor.VirtualHostProperty

All Known Implementing Classes:

AbstractHttpRestRegistryServerDecorator

public interface HttpRestRegistryServer<DESC extends HttpServerDescriptor, B extends HttpRestRegistryServer<DESC,B>>
extends HttpRegistry<DESC,B>, HttpRestServer, PingRequestObserver, PingRequestObserverAccessor, PingRequestObserverAccessor.PingRequestObserverBuilder<B>

The HttpRestRegistryServer provides additional functionality for registering at and signing off from a service discovery service in order to resolve URLs to or from other services. This type is intended to be used by different separate hierarchy branches by providing of the generic type <B>, ensuring a coherent type hierarchy for each branch.

Nested Class Summary

Nested classes/interfaces inherited from interface AliasAccessor

AliasAccessor.AliasBuilder<B>, AliasAccessor.AliasMutator, AliasAccessor.AliasProperty

Nested classes/interfaces inherited from interface BaseLocatorAccessor

BaseLocatorAccessor.BaseLocatorBuilder<B>, BaseLocatorAccessor.BaseLocatorMutator, BaseLocatorAccessor.BaseLocatorProperty

Nested classes/interfaces inherited from interface Closable

Closable.CloseAutomaton, Closable.CloseBuilder<B>

Nested classes/interfaces inherited from interface Configurable

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

Nested classes/interfaces inherited from interface ConnectionComponent

ConnectionComponent.ConnectionAutomaton<CON>, ConnectionComponent.ConnectionComponentBuilder<CON,B>

Nested classes/interfaces inherited from interface ConnectionOpenable

ConnectionOpenable.ConnectionOpenAutomaton<CON>, ConnectionOpenable.ConnectionOpenBuilder<CON,B>

Nested classes/interfaces inherited from interface ConnectionStatusAccessor

ConnectionStatusAccessor.ConnectionStatusMutator, ConnectionStatusAccessor.ConnectionStatusProperty

Nested classes/interfaces inherited from interface Destroyable

Destroyable.DestroyAutomaton

Nested classes/interfaces inherited from interface HostAccessor

HostAccessor.HostBuilder<B>, HostAccessor.HostMutator, HostAccessor.HostProperty

Nested classes/interfaces inherited from interface HttpExceptionHandlerAccessor

HttpExceptionHandlerAccessor.HttpExceptionHandlerBuilder<B>, HttpExceptionHandlerAccessor.HttpExceptionHandlerMutator, HttpExceptionHandlerAccessor.HttpExceptionHandlerProperty

Nested classes/interfaces inherited from interface HttpExceptionHandlingAccessor

HttpExceptionHandlingAccessor.HttpExceptionHandlingBuilder<B>, HttpExceptionHandlingAccessor.HttpExceptionHandlingMutator, HttpExceptionHandlingAccessor.HttpExceptionHandlingProperty

Nested classes/interfaces inherited from interface HttpRegistryUrlAccessor

HttpRegistryUrlAccessor.HttpRegistryUrlBuilder<B>, HttpRegistryUrlAccessor.HttpRegistryUrlMutator, HttpRegistryUrlAccessor.HttpRegistryUrlProperty

Nested classes/interfaces inherited from interface HttpServerDescriptorAccessor

HttpServerDescriptorAccessor.HttpServerDescriptorBuilder<DESC,B>, HttpServerDescriptorAccessor.HttpServerDescriptorMutator<DESC>, HttpServerDescriptorAccessor.HttpServerDescriptorProperty<DESC>

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 InstanceIdAccessor

InstanceIdAccessor.InstanceIdBuilder<B>, InstanceIdAccessor.InstanceIdMutator, InstanceIdAccessor.InstanceIdProperty

Nested classes/interfaces inherited from interface IpAddressAccessor

IpAddressAccessor.IpAddressBuilder<B>, IpAddressAccessor.IpAddressMutator, IpAddressAccessor.IpAddressProperty

Nested classes/interfaces inherited from interface KeyStoreDescriptorAccessor

KeyStoreDescriptorAccessor.KeyStoreDescriptorBuilder<B>, KeyStoreDescriptorAccessor.KeyStoreDescriptorMutator, KeyStoreDescriptorAccessor.KeyStoreDescriptorProperty

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 LinkComponent

LinkComponent.LinkAutomaton, LinkComponent.LinkComponentBuilder<B>

Nested classes/interfaces inherited from interface MaxConnectionsAccessor

MaxConnectionsAccessor.MaxConnectionsBuilder<B>, MaxConnectionsAccessor.MaxConnectionsMutator, MaxConnectionsAccessor.MaxConnectionsProperty

Nested classes/interfaces inherited from interface MediaTypeFactoryLookup

MediaTypeFactoryLookup.MutableMediaTypeFactoryLookup

Nested classes/interfaces inherited from interface Openable

Openable.OpenAutomaton, Openable.OpenBuilder<B>

Nested classes/interfaces inherited from interface OpenedAccessor

OpenedAccessor.OpenedMutator, OpenedAccessor.OpenedProperty

Nested classes/interfaces inherited from interface Pausable

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

Nested classes/interfaces inherited from interface PingPathAccessor

PingPathAccessor.PingPathBuilder<B>, PingPathAccessor.PingPathMutator, PingPathAccessor.PingPathProperty

Nested classes/interfaces inherited from interface PingRequestObserverAccessor

PingRequestObserverAccessor.PingRequestObserverBuilder<B>, PingRequestObserverAccessor.PingRequestObserverMutator, PingRequestObserverAccessor.PingRequestObserverProperty

Nested classes/interfaces inherited from interface PortAccessor

PortAccessor.PortBuilder<B>, PortAccessor.PortMutator, PortAccessor.PortProperty

Nested classes/interfaces inherited from interface RealmAccessor

RealmAccessor.RealmBuilder<B>, RealmAccessor.RealmMutator, RealmAccessor.RealmProperty

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 SchemeAccessor

SchemeAccessor.SchemeBuilder<B>, SchemeAccessor.SchemeMutator, SchemeAccessor.SchemeProperty

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

Nested classes/interfaces inherited from interface VirtualHostAccessor

VirtualHostAccessor.VirtualHostBuilder<B>, VirtualHostAccessor.VirtualHostMutator, VirtualHostAccessor.VirtualHostProperty

Method Summary

Modifier and Type	Method	Description
void	destroy()	This server is taken (removed) from the registry server.
void	initialize(String aAlias, String aInstanceId, Scheme aScheme, String aHost, String aVirtualHost, int[] aIpAddress, int aPort, String aPingPath, RestRequestConsumer aPingRequestObserver, Url aRegistryUrl)	Initializes the HttpRestRegistryServer by registering it at the service registry with a status such as "starting" or "initializing" or "not-ready-yet".
default void	initialize(String aAlias, Scheme aScheme, String aHost, String aVirtualHost, int[] aIpAddress, int aPort, String aPingPath, RestRequestConsumer aPingRequestObserver, Url aRegistryUrl)	Initializes the HttpRestRegistryServer by registering it at the service registry with a status such as "starting" or "initializing" or "not-ready-yet".
void	pause()	Some "deactivated" status is communicated to the registry server.
void	resume()	Some "up-and-running (again)" status is communicated to the registry server.
void	start()	Some "up-and-running" status is communicated to the registry server.
void	stop()	Some "out-of-order" status is communicated to the registry server.
default B	withPingRequestObserver(RestRequestConsumer aRequestConsumer)	Sets the ping RestRequestConsumer for the ping RestRequestConsumer property.
default B	withPort(int aPort)
default B	withProtocol(String aProtocol)
default B	withScheme(Scheme aScheme)

Methods inherited from interface AliasAccessor

getAlias

Methods inherited from interface AliasAccessor.AliasMutator

setAlias

Methods inherited from interface AliasAccessor.AliasProperty

letAlias

Methods inherited from interface BaseLocatorAccessor

getBaseLocator

Methods inherited from interface BaseLocatorAccessor.BaseLocatorMutator

setBaseLocator

Methods inherited from interface BaseLocatorAccessor.BaseLocatorProperty

letBaseLocator

Methods inherited from interface BasicAuthObservable

onBasicAuthRequest

Methods inherited from interface Closable

close, closeIn, closeQuietly, closeUnchecked

Methods inherited from interface Closable.CloseBuilder

withCloseUnchecked

Methods inherited from interface Configurable

initializeUnchecked

Methods inherited from interface ConnectionOpenable

openUnchecked

Methods inherited from interface ConnectionOpenable.ConnectionOpenBuilder

withOpenUnchecked

Methods inherited from interface ConnectionStatusAccessor

getConnectionStatus, isOpened

Methods inherited from interface Destroyable.DestroyAutomaton

isDestroyable, isDestroyed

Methods inherited from interface HostAccessor

getHost

Methods inherited from interface HostAccessor.HostMutator

setHost

Methods inherited from interface HostAccessor.HostProperty

letHost

Methods inherited from interface HttpExceptionHandlerAccessor

getHttpExceptionHandler

Methods inherited from interface HttpExceptionHandlerAccessor.HttpExceptionHandlerBuilder

withOnHttpException

Methods inherited from interface HttpExceptionHandlerAccessor.HttpExceptionHandlerMutator

onHttpException, setHttpExceptionHandler

Methods inherited from interface HttpExceptionHandlerAccessor.HttpExceptionHandlerProperty

letHttpExceptionHandler

Methods inherited from interface HttpExceptionHandlingAccessor

getHttpExceptionHandling

Methods inherited from interface HttpExceptionHandlingAccessor.HttpExceptionHandlingMutator

setHttpExceptionHandling

Methods inherited from interface HttpExceptionHandlingAccessor.HttpExceptionHandlingProperty

letHttpExceptionHandling

Methods inherited from interface HttpRegistry

initialize, initialize, initialize, initialize, initialize, initialize, initialize, initialize, withAlias, withCidrNotation, withHost, withHttpRegistryUrl, withHttpServerDescriptor, withInstanceId, withIpAddress, withPingPath, withTrustStoreDescriptor, withVirtualHost

Methods inherited from interface HttpRegistryUrlAccessor

getHttpRegistryUrl

Methods inherited from interface HttpRegistryUrlAccessor.HttpRegistryUrlMutator

setHttpRegistryUrl

Methods inherited from interface HttpRegistryUrlAccessor.HttpRegistryUrlProperty

letHttpRegistryUrl

Methods inherited from interface HttpRestServer

open, open, open, open, open, open, open, open, open, open, open, open, open, withBaseLocator, withClose, withCloseIn, withCloseQuietly, withHttpExceptionHandler, withHttpExceptionHandling, withKeyStoreDescriptor, withMaxConnections, withOpen, withOpen, withRealm

Methods inherited from interface HttpsConnectionRequestObservable

onConnectionRequest

Methods inherited from interface HttpServerDescriptorAccessor

getHttpServerDescriptor

Methods inherited from interface HttpServerDescriptorAccessor.HttpServerDescriptorMutator

setHttpServerDescriptor

Methods inherited from interface HttpServerDescriptorAccessor.HttpServerDescriptorProperty

letHttpServerDescriptor

Methods inherited from interface HttpServerDescriptorFactory

toHttpServerDescriptor, toHttpServerDescriptor, toHttpServerDescriptor, toHttpServerDescriptor, toHttpServerDescriptor

Methods inherited from interface HttpServerInterceptable

addHttpInterceptor, hasHttpInterceptor, removeHttpInterceptor

Methods inherited from interface Initializable

initializeUnchecked

Methods inherited from interface Initializable.InitializeAutomaton

isInitalizable

Methods inherited from interface InitializedAccessor

isInitialized

Methods inherited from interface InstanceIdAccessor

getInstanceId

Methods inherited from interface InstanceIdAccessor.InstanceIdMutator

setInstanceId

Methods inherited from interface InstanceIdAccessor.InstanceIdProperty

letInstanceId

Methods inherited from interface IpAddressAccessor

getIpAddress, toCidrNotation

Methods inherited from interface IpAddressAccessor.IpAddressMutator

fromCidrNotation, setIpAddress

Methods inherited from interface IpAddressAccessor.IpAddressProperty

letIpAddress

Methods inherited from interface KeyStoreDescriptorAccessor

getKeyStoreDescriptor

Methods inherited from interface KeyStoreDescriptorAccessor.KeyStoreDescriptorMutator

setKeyStoreDescriptor

Methods inherited from interface KeyStoreDescriptorAccessor.KeyStoreDescriptorProperty

letKeyStoreDescriptor

Methods inherited from interface LifecycleStatusAccessor

getLifecycleStatus

Methods inherited from interface MaxConnectionsAccessor

getMaxConnections

Methods inherited from interface MaxConnectionsAccessor.MaxConnectionsMutator

setMaxConnections

Methods inherited from interface MaxConnectionsAccessor.MaxConnectionsProperty

letMaxConnections

Methods inherited from interface MediaTypeFactoryLookup

getFactoryMediaTypes, hasMediaTypeFactory, toMediaTypeFactory

Methods inherited from interface MediaTypeFactoryLookup.MutableMediaTypeFactoryLookup

addMediaTypeFactory

Methods inherited from interface Observable

hasObserver, subscribeObserver, unsubscribeObserver

Methods inherited from interface Observers

disableObservers, enableObservers, isObserversActive, observers, setObserversActive

Methods inherited from interface Openable

openUnchecked

Methods inherited from interface Pausable

pauseUnchecked

Methods inherited from interface Pausable.PauseAutomaton

isPausable, isPaused

Methods inherited from interface PingPathAccessor

getPingPath

Methods inherited from interface PingPathAccessor.PingPathMutator

setPingPath

Methods inherited from interface PingPathAccessor.PingPathProperty

letPingPath

Methods inherited from interface PingRequestObserver

onPingRequest

Methods inherited from interface PingRequestObserverAccessor

getPingRequestObserver

Methods inherited from interface PortAccessor

getPort

Methods inherited from interface PortAccessor.PortMutator

setPort

Methods inherited from interface PortAccessor.PortProperty

letPort

Methods inherited from interface PostHttpInterceptable

addPostHttpInterceptor, hasPostHttpInterceptor, removePostHttpInterceptor

Methods inherited from interface PreHttpInterceptable

addPreHttpInterceptor, hasPreHttpInterceptor, removePreHttpInterceptor

Methods inherited from interface RealmAccessor

getRealm

Methods inherited from interface RealmAccessor.RealmMutator

setRealm

Methods inherited from interface RealmAccessor.RealmProperty

letRealm

Methods inherited from interface RestServer

onDelete, onDelete, onGet, onGet, onPost, onPost, onPut, onPut, onRequest, onRequest, onRequest, onRequest, onRequest, withDisableObservers, withEnableObservers, withObserversActive

Methods inherited from interface Resumable

resumeUnchecked

Methods inherited from interface Resumable.ResumeAutomaton

isResumable

Methods inherited from interface RunningAccessor

isRunning

Methods inherited from interface SchemeAccessor

getScheme, toProtocol

Methods inherited from interface SchemeAccessor.SchemeMutator

setProtocol, setScheme

Methods inherited from interface SchemeAccessor.SchemeProperty

letProtocol, letScheme

Methods inherited from interface Startable

startUnchecked

Methods inherited from interface Startable.StartAutomaton

isStartable

Methods inherited from interface Stoppable

stopUnchecked

Methods inherited from interface Stoppable.StopAutomaton

isStoppable, isStopped

Methods inherited from interface TrustStoreDescriptorAccessor

getTrustStoreDescriptor

Methods inherited from interface TrustStoreDescriptorAccessor.TrustStoreDescriptorMutator

setTrustStoreDescriptor

Methods inherited from interface TrustStoreDescriptorAccessor.TrustStoreDescriptorProperty

letTrustStoreDescriptor

Methods inherited from interface VirtualHostAccessor

getVirtualHost

Methods inherited from interface VirtualHostAccessor.VirtualHostMutator

setVirtualHost

Methods inherited from interface VirtualHostAccessor.VirtualHostProperty

letVirtualHost

Method Details

withPort

default B withPort(int aPort)

Specified by:

withPort in interface HttpRestServer

Specified by:

withPort in interface PortAccessor.PortBuilder<DESC extends HttpServerDescriptor>

withScheme

default B withScheme(Scheme aScheme)

Specified by:

withScheme in interface HttpRestServer

Specified by:

withScheme in interface SchemeAccessor.SchemeBuilder<DESC extends HttpServerDescriptor>

withProtocol

default B withProtocol(String aProtocol)

Specified by:

withProtocol in interface HttpRestServer

Specified by:

withProtocol in interface SchemeAccessor.SchemeBuilder<DESC extends HttpServerDescriptor>

withPingRequestObserver

default B withPingRequestObserver(RestRequestConsumer aRequestConsumer)

Sets the ping RestRequestConsumer for the ping RestRequestConsumer property.

Specified by:

withPingRequestObserver in interface PingRequestObserverAccessor.PingRequestObserverBuilder<DESC extends HttpServerDescriptor>

Parameters:

aRequestConsumer - The ping RestRequestConsumer to be stored by the ping RestRequestConsumer property.

Returns:

The builder for applying multiple build operations.

initialize

default void initialize(String aAlias,
 Scheme aScheme,
 String aHost,
 String aVirtualHost,
 int[] aIpAddress,
 int aPort,
 String aPingPath,
 RestRequestConsumer aPingRequestObserver,
 Url aRegistryUrl)
                 throws InitializeException

Initializes the HttpRestRegistryServer by registering it at the service registry with a status such as "starting" or "initializing" or "not-ready-yet".

Parameters:

aAlias - The name ("alias") which identifies the server in the registry.

aScheme - The Scheme to which this server is being attached (HTTP or HTTPS).

aHost - The host name to be used to address this server. If omitted, then the system's host name should be used.

aVirtualHost - The virtual host name to be used for resolving.

aIpAddress - The IP-Address identifying the host.

aPort - The port of your service being registered.

aPingPath - The path to use as health-check end-point by this server.

aPingRequestObserver - The RestRequestConsumer hooking into a ping request.

aRegistryUrl - The registry server where to register.

Throws:

InitializeException - thrown in case initializing a component caused problems. Usually a method similar to "initialize()" throws such an exception.

initialize

void initialize(String aAlias,
 String aInstanceId,
 Scheme aScheme,
 String aHost,
 String aVirtualHost,
 int[] aIpAddress,
 int aPort,
 String aPingPath,
 RestRequestConsumer aPingRequestObserver,
 Url aRegistryUrl)
         throws InitializeException

Initializes the HttpRestRegistryServer by registering it at the service registry with a status such as "starting" or "initializing" or "not-ready-yet".

Parameters:

aAlias - The name ("alias") which identifies the server in the registry.

aInstanceId - The TID for the instance when being registered at the service registry. If omitted, then the host name is used.

aScheme - The Scheme to which this server is being attached (HTTP or HTTPS).

aHost - The host name to be used to address this server. If omitted, then the system's host name should be used.

aVirtualHost - The virtual host name to be used for resolving.

aIpAddress - The IP-Address identifying the host.

aPort - The port of your service being registered.

aPingPath - The path to use as health-check end-point by this server.

aPingRequestObserver - The RestRequestConsumer hooking into a ping request.

aRegistryUrl - The registry server where to register.

Throws:

InitializeException - thrown in case initializing a component caused problems. Usually a method similar to "initialize()" throws such an exception.

start

void start()
    throws StartException

Some "up-and-running" status is communicated to the registry server. The registered RestEndpoint instances (observers) (e.g. via RestServer.onRequest(org.refcodes.web.HttpMethod, String, RestRequestConsumer), RestServer.onGet(String, RestRequestConsumer) RestServer.onPut(String, RestRequestConsumer), RestServer.onPut(String, RestRequestConsumer) or RestServer.onDelete(String, RestRequestConsumer)) are enabled by calling Observers.enableObservers(). If necessary, the connection is opened via HttpRestServer.open() or the like. May also start a "ping" or "heartbeat" daemon.

Some "up-and-running" status is communicated to the registry server. May also start a "ping" or "heartbeat" daemon.

Specified by:

start in interface HttpRegistry<DESC extends HttpServerDescriptor, B extends HttpRestRegistryServer<DESC,B>>

Specified by:

start in interface Startable

Throws:

StartException

pause

void pause()
    throws PauseException

Some "deactivated" status is communicated to the registry server. The registered RestEndpoint instances (observers) (e.g. via RestEndpointBuilder being registered e.g. via RestServer.onRequest(org.refcodes.web.HttpMethod, String, RestRequestConsumer), RestServer.onGet(String, RestRequestConsumer) RestServer.onPut(String, RestRequestConsumer), RestServer.onPut(String, RestRequestConsumer) or RestServer.onDelete(String, RestRequestConsumer) is closed by calling its RestEndpointBuilder.close()) are disabled by calling Observers.disableObservers().

Some "deactivated" status is communicated to the registry server.

Specified by:

pause in interface HttpRegistry<DESC extends HttpServerDescriptor, B extends HttpRestRegistryServer<DESC,B>>

Specified by:

pause in interface Pausable

Throws:

PauseException

resume

void resume()
     throws ResumeException

Some "up-and-running (again)" status is communicated to the registry server. The registered RestEndpoint instances (observers) (e.g. via RestEndpointBuilder being registered e.g. via RestServer.onRequest(org.refcodes.web.HttpMethod, String, RestRequestConsumer), RestServer.onGet(String, RestRequestConsumer) RestServer.onPut(String, RestRequestConsumer), RestServer.onPut(String, RestRequestConsumer) or RestServer.onDelete(String, RestRequestConsumer) is closed by calling its RestEndpointBuilder.close()) are enabled (again) by calling Observers.enableObservers().

Some "up-and-running (again)" status is communicated to the registry server.

Specified by:

resume in interface HttpRegistry<DESC extends HttpServerDescriptor, B extends HttpRestRegistryServer<DESC,B>>

Specified by:

resume in interface Resumable

Throws:

ResumeException

stop

void stop()
   throws StopException

Some "out-of-order" status is communicated to the registry server. The registered RestEndpoint instances (observers) (e.g. via RestServer.onRequest(org.refcodes.web.HttpMethod, String, RestRequestConsumer), RestServer.onGet(String, RestRequestConsumer) RestServer.onPut(String, RestRequestConsumer), RestServer.onPut(String, RestRequestConsumer) or RestServer.onDelete(String, RestRequestConsumer)) are disabled by calling Observers.disableObservers(). Also stops a "ping" or "heartbeat" daemon.

Some "out-of-order" status is communicated to the registry server. Also stops a "ping" or "heartbeat" daemon.

Specified by:

stop in interface HttpRegistry<DESC extends HttpServerDescriptor, B extends HttpRestRegistryServer<DESC,B>>

Specified by:

stop in interface Stoppable

Throws:

StopException

destroy

void destroy()

This server is taken (removed) from the registry server. The registered RestEndpoint instances (observers) (e.g. via RestServer.onRequest(org.refcodes.web.HttpMethod, String, RestRequestConsumer), RestServer.onGet(String, RestRequestConsumer) RestServer.onPut(String, RestRequestConsumer), RestServer.onPut(String, RestRequestConsumer) or RestServer.onDelete(String, RestRequestConsumer)) are disabled by calling Observers.disableObservers(). Also stops a "ping" or "heartbeat" daemon. Finally the connection is closed via Closable.close().

This server is taken (removed) from the registry server. Also stops a "ping" or "heartbeat" daemon. Finally the connection is closed.

Specified by:

destroy in interface Destroyable

Specified by:

destroy in interface HttpRegistry<DESC extends HttpServerDescriptor, B extends HttpRestRegistryServer<DESC,B>>