Module org.refcodes.rest

Package org.refcodes.rest

Interface HttpRegistry<DESC extends HttpServerDescriptor,B extends HttpRegistry<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:

org.refcodes.mixin.AliasAccessor, org.refcodes.mixin.AliasAccessor.AliasBuilder<B>, org.refcodes.mixin.AliasAccessor.AliasMutator, org.refcodes.mixin.AliasAccessor.AliasProperty, org.refcodes.component.Configurable<HttpRegistryContext<DESC>>, org.refcodes.component.Destroyable, org.refcodes.component.Destroyable.DestroyAutomaton, org.refcodes.web.HostAccessor, org.refcodes.web.HostAccessor.HostBuilder<B>, org.refcodes.web.HostAccessor.HostMutator, org.refcodes.web.HostAccessor.HostProperty, HttpRegistryUrlAccessor, HttpRegistryUrlAccessor.HttpRegistryUrlBuilder<B>, HttpRegistryUrlAccessor.HttpRegistryUrlMutator, HttpRegistryUrlAccessor.HttpRegistryUrlProperty, HttpServerDescriptorAccessor<DESC>, HttpServerDescriptorAccessor.HttpServerDescriptorBuilder<DESC,B>, HttpServerDescriptorAccessor.HttpServerDescriptorMutator<DESC>, HttpServerDescriptorAccessor.HttpServerDescriptorProperty<DESC>, HttpServerDescriptorFactory<DESC>, org.refcodes.component.Initializable, org.refcodes.component.Initializable.InitializeAutomaton, org.refcodes.component.InitializedAccessor, org.refcodes.mixin.InstanceIdAccessor, org.refcodes.mixin.InstanceIdAccessor.InstanceIdBuilder<B>, org.refcodes.mixin.InstanceIdAccessor.InstanceIdMutator, org.refcodes.mixin.InstanceIdAccessor.InstanceIdProperty, org.refcodes.web.IpAddressAccessor, org.refcodes.web.IpAddressAccessor.IpAddressBuilder<B>, org.refcodes.web.IpAddressAccessor.IpAddressMutator, org.refcodes.web.IpAddressAccessor.IpAddressProperty, org.refcodes.component.LifeCycleComponent, org.refcodes.component.LifeCycleComponent.LifeCycleAutomaton, org.refcodes.component.LifeCycleStatusAccessor, org.refcodes.component.Pausable, org.refcodes.component.Pausable.PauseAutomaton, PingPathAccessor, PingPathAccessor.PingPathBuilder<B>, PingPathAccessor.PingPathMutator, PingPathAccessor.PingPathProperty, org.refcodes.component.Resumable, org.refcodes.component.Resumable.ResumeAutomaton, org.refcodes.component.RunningAccessor, org.refcodes.component.Startable, org.refcodes.component.Startable.StartAutomaton, org.refcodes.component.Stoppable, org.refcodes.component.Stoppable.StopAutomaton, org.refcodes.security.TrustStoreDescriptorAccessor, org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorBuilder<B>, org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorMutator, org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorProperty, org.refcodes.web.VirtualHostAccessor, org.refcodes.web.VirtualHostAccessor.VirtualHostBuilder<B>, org.refcodes.web.VirtualHostAccessor.VirtualHostMutator, org.refcodes.web.VirtualHostAccessor.VirtualHostProperty

All Known Subinterfaces:

HttpRegistryRestServer<DESC,B>, HttpRegistrySidecar<DESC,B>

All Known Implementing Classes:

AbstractHttpRegistryRestServerDecorator, AbstractHttpRegistrySidecar

public interface HttpRegistry<DESC extends HttpServerDescriptor,B extends HttpRegistry<DESC,B>>
extends org.refcodes.component.Configurable<HttpRegistryContext<DESC>>, HttpServerDescriptorAccessor.HttpServerDescriptorProperty<DESC>, HttpServerDescriptorAccessor.HttpServerDescriptorBuilder<DESC,B>, PingPathAccessor.PingPathProperty, PingPathAccessor.PingPathBuilder<B>, org.refcodes.web.HostAccessor.HostProperty, org.refcodes.web.HostAccessor.HostBuilder<B>, org.refcodes.web.VirtualHostAccessor.VirtualHostProperty, org.refcodes.web.VirtualHostAccessor.VirtualHostBuilder<B>, org.refcodes.web.IpAddressAccessor.IpAddressProperty, org.refcodes.web.IpAddressAccessor.IpAddressBuilder<B>, org.refcodes.mixin.InstanceIdAccessor.InstanceIdProperty, org.refcodes.mixin.InstanceIdAccessor.InstanceIdBuilder<B>, org.refcodes.mixin.AliasAccessor.AliasProperty, org.refcodes.mixin.AliasAccessor.AliasBuilder<B>, org.refcodes.component.LifeCycleComponent.LifeCycleAutomaton, HttpRegistryUrlAccessor.HttpRegistryUrlProperty, HttpRegistryUrlAccessor.HttpRegistryUrlBuilder<B>, org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorProperty, org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorBuilder<B>, HttpServerDescriptorFactory<DESC>

The HttpRegistry describes the functionality required in order to register a service at a service registry and discovery service. This type is intended to be used by different separate hierarchy branches by providing the generic type <B>, ensuring a coherent type hierarchy for each branch.

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.mixin.AliasAccessor

org.refcodes.mixin.AliasAccessor.AliasBuilder<B extends org.refcodes.mixin.AliasAccessor.AliasBuilder<B>>, org.refcodes.mixin.AliasAccessor.AliasMutator, org.refcodes.mixin.AliasAccessor.AliasProperty

Nested classes/interfaces inherited from interface org.refcodes.component.Configurable

org.refcodes.component.Configurable.ConfigureAutomaton<CTX extends Object>, org.refcodes.component.Configurable.ConfigureBuilder<CTX extends Object,B extends org.refcodes.component.Configurable.ConfigureBuilder<CTX,B>>

Nested classes/interfaces inherited from interface org.refcodes.component.Destroyable

org.refcodes.component.Destroyable.DestroyAutomaton

Nested classes/interfaces inherited from interface org.refcodes.web.HostAccessor

org.refcodes.web.HostAccessor.HostBuilder<B extends org.refcodes.web.HostAccessor.HostBuilder<?>>, org.refcodes.web.HostAccessor.HostMutator, org.refcodes.web.HostAccessor.HostProperty

Nested classes/interfaces inherited from interface org.refcodes.rest.HttpRegistryUrlAccessor

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

Nested classes/interfaces inherited from interface org.refcodes.rest.HttpServerDescriptorAccessor

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

Nested classes/interfaces inherited from interface org.refcodes.component.Initializable

org.refcodes.component.Initializable.InitializeAutomaton, org.refcodes.component.Initializable.InitializeBuilder<B extends org.refcodes.component.Initializable.InitializeBuilder<B>>, org.refcodes.component.Initializable.UncheckedInitializable

Nested classes/interfaces inherited from interface org.refcodes.component.InitializedAccessor

org.refcodes.component.InitializedAccessor.InitializedMutator, org.refcodes.component.InitializedAccessor.InitializedProperty

Nested classes/interfaces inherited from interface org.refcodes.mixin.InstanceIdAccessor

org.refcodes.mixin.InstanceIdAccessor.InstanceIdBuilder<B extends org.refcodes.mixin.InstanceIdAccessor.InstanceIdBuilder<B>>, org.refcodes.mixin.InstanceIdAccessor.InstanceIdMutator, org.refcodes.mixin.InstanceIdAccessor.InstanceIdProperty

Nested classes/interfaces inherited from interface org.refcodes.web.IpAddressAccessor

org.refcodes.web.IpAddressAccessor.IpAddressBuilder<B extends org.refcodes.web.IpAddressAccessor.IpAddressBuilder<B>>, org.refcodes.web.IpAddressAccessor.IpAddressMutator, org.refcodes.web.IpAddressAccessor.IpAddressProperty

Nested classes/interfaces inherited from interface org.refcodes.component.LifeCycleComponent

org.refcodes.component.LifeCycleComponent.LifeCycleAutomaton, org.refcodes.component.LifeCycleComponent.UncheckedLifeCycleComponent

Nested classes/interfaces inherited from interface org.refcodes.component.LifeCycleStatusAccessor

org.refcodes.component.LifeCycleStatusAccessor.LifeCycleStatusBuilder<B extends org.refcodes.component.LifeCycleStatusAccessor.LifeCycleStatusBuilder<B>>, org.refcodes.component.LifeCycleStatusAccessor.LifeCycleStatusMutator, org.refcodes.component.LifeCycleStatusAccessor.LifeCycleStatusProperty

Nested classes/interfaces inherited from interface org.refcodes.component.Pausable

org.refcodes.component.Pausable.PauseAutomaton, org.refcodes.component.Pausable.PauseBuilder<B extends org.refcodes.component.Pausable.PauseBuilder<B>>, org.refcodes.component.Pausable.UncheckedPausable

Nested classes/interfaces inherited from interface org.refcodes.rest.PingPathAccessor

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

Nested classes/interfaces inherited from interface org.refcodes.component.Resumable

org.refcodes.component.Resumable.ResumeAutomaton, org.refcodes.component.Resumable.ResumeBuilder<B extends org.refcodes.component.Resumable.ResumeBuilder<B>>, org.refcodes.component.Resumable.UncheckedResumable

Nested classes/interfaces inherited from interface org.refcodes.component.RunningAccessor

org.refcodes.component.RunningAccessor.RunningMutator, org.refcodes.component.RunningAccessor.RunningProperty

Nested classes/interfaces inherited from interface org.refcodes.component.Startable

org.refcodes.component.Startable.StartAutomaton, org.refcodes.component.Startable.StartBuilder<B extends org.refcodes.component.Startable.StartBuilder<B>>, org.refcodes.component.Startable.UncheckedStartable

Nested classes/interfaces inherited from interface org.refcodes.component.Stoppable

org.refcodes.component.Stoppable.StopAutomaton, org.refcodes.component.Stoppable.StopBuilder<B extends org.refcodes.component.Stoppable.StopBuilder<B>>, org.refcodes.component.Stoppable.UncheckedStoppable

Nested classes/interfaces inherited from interface org.refcodes.security.TrustStoreDescriptorAccessor

org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorBuilder<B extends org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorBuilder<B>>, org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorMutator, org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorProperty

Nested classes/interfaces inherited from interface org.refcodes.web.VirtualHostAccessor

org.refcodes.web.VirtualHostAccessor.VirtualHostBuilder<B extends org.refcodes.web.VirtualHostAccessor.VirtualHostBuilder<?>>, org.refcodes.web.VirtualHostAccessor.VirtualHostMutator, org.refcodes.web.VirtualHostAccessor.VirtualHostProperty

Method Summary

Modifier and Type	Method	Description
void	destroy()	This server is taken (removed) from the registry server.
default void	initialize()	Initializes the HttpRegistry by registering it at the service registry with a status such as "starting" or "initializing" or "not-ready-yet".
default void	initialize(DESC aServerDescriptor, org.refcodes.web.Url aRegistryUrl)	Initializes the HttpRegistry by registering it at the service registry with a status such as "starting" or "initializing" or "not-ready-yet".
void	initialize(DESC aServerDescriptor, org.refcodes.web.Url aRegistryUrl, org.refcodes.security.TrustStoreDescriptor aStoreDescriptor)	Initializes the HttpRegistry by registering it at the service registry with a status such as "starting" or "initializing" or "not-ready-yet".
default void	initialize(String aAlias, String aInstanceId, org.refcodes.data.Scheme aScheme, int aPort, org.refcodes.web.Url aRegistryUrl)	Initializes the HttpRegistry by registering it at the service registry with a status such as "starting" or "initializing" or "not-ready-yet".
default void	initialize(String aAlias, String aInstanceId, org.refcodes.data.Scheme aScheme, String aHost, String aVirtualHost, int[] aIpAddress, int aPort, String aPingPath, org.refcodes.web.Url aRegistryUrl)	Initializes the HttpRegistry by registering it at the service registry with a status such as "starting" or "initializing" or "not-ready-yet".
default void	initialize(String aAlias, org.refcodes.data.Scheme aScheme, String aHost, int aPort, org.refcodes.web.Url aRegistryUrl)	Initializes the HttpRegistry by registering it at the service registry with a status such as "starting" or "initializing" or "not-ready-yet".
default void	initialize(String aAlias, org.refcodes.data.Scheme aScheme, String aHost, String aVirtualHost, int[] aIpAddress, int aPort, String aPingPath, org.refcodes.web.Url aRegistryUrl)	Initializes the HttpRegistry by registering it at the service registry with a status such as "starting" or "initializing" or "not-ready-yet".
default void	initialize(HttpRegistryContext<DESC> aRegistryContext)	Initializes the HttpRegistry 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	withAlias(String aAlias)
default B	withCidrNotation(String aCidrNotation)
default B	withHost(String aHost)
default B	withHttpRegistryUrl(org.refcodes.web.Url aUrl)	Sets the URL for the URL property locating the service registry registry.
default B	withHttpServerDescriptor(DESC aServerDescriptor)	Sets the HttpServerDescriptor for the HttpServerDescriptor property.
default B	withInstanceId(String aInstanceId)
default B	withIpAddress(int[] aIpAddress)
default B	withPingPath(String aPingPath)	Sets the ping path to use and returns this builder as of the builder pattern.
default B	withTrustStoreDescriptor(org.refcodes.security.TrustStoreDescriptor aStoreDescriptor)
default B	withVirtualHost(String aVirtualHost)

Methods inherited from interface org.refcodes.mixin.AliasAccessor

getAlias

Methods inherited from interface org.refcodes.mixin.AliasAccessor.AliasMutator

setAlias

Methods inherited from interface org.refcodes.mixin.AliasAccessor.AliasProperty

letAlias

Methods inherited from interface org.refcodes.component.Configurable

initializeUnchecked

Methods inherited from interface org.refcodes.component.Destroyable.DestroyAutomaton

isDestroyable, isDestroyed

Methods inherited from interface org.refcodes.web.HostAccessor

getHost

Methods inherited from interface org.refcodes.web.HostAccessor.HostMutator

setHost

Methods inherited from interface org.refcodes.web.HostAccessor.HostProperty

letHost

Methods inherited from interface org.refcodes.rest.HttpRegistryUrlAccessor

getHttpRegistryUrl

Methods inherited from interface org.refcodes.rest.HttpRegistryUrlAccessor.HttpRegistryUrlMutator

setHttpRegistryUrl

Methods inherited from interface org.refcodes.rest.HttpRegistryUrlAccessor.HttpRegistryUrlProperty

letHttpRegistryUrl

Methods inherited from interface org.refcodes.rest.HttpServerDescriptorAccessor

getHttpServerDescriptor

Methods inherited from interface org.refcodes.rest.HttpServerDescriptorAccessor.HttpServerDescriptorMutator

setHttpServerDescriptor

Methods inherited from interface org.refcodes.rest.HttpServerDescriptorAccessor.HttpServerDescriptorProperty

letHttpServerDescriptor

Methods inherited from interface org.refcodes.rest.HttpServerDescriptorFactory

toHttpServerDescriptor, toHttpServerDescriptor, toHttpServerDescriptor, toHttpServerDescriptor, toHttpServerDescriptor

Methods inherited from interface org.refcodes.component.Initializable

initializeUnchecked

Methods inherited from interface org.refcodes.component.Initializable.InitializeAutomaton

isInitalizable

Methods inherited from interface org.refcodes.component.InitializedAccessor

isInitialized

Methods inherited from interface org.refcodes.mixin.InstanceIdAccessor

getInstanceId

Methods inherited from interface org.refcodes.mixin.InstanceIdAccessor.InstanceIdMutator

setInstanceId

Methods inherited from interface org.refcodes.mixin.InstanceIdAccessor.InstanceIdProperty

letInstanceId

Methods inherited from interface org.refcodes.web.IpAddressAccessor

getIpAddress, toCidrNotation

Methods inherited from interface org.refcodes.web.IpAddressAccessor.IpAddressMutator

fromCidrNotation, setIpAddress

Methods inherited from interface org.refcodes.web.IpAddressAccessor.IpAddressProperty

letIpAddress

Methods inherited from interface org.refcodes.component.LifeCycleStatusAccessor

getLifeCycleStatus

Methods inherited from interface org.refcodes.component.Pausable

pauseUnchecked

Methods inherited from interface org.refcodes.component.Pausable.PauseAutomaton

isPausable, isPaused

Methods inherited from interface org.refcodes.rest.PingPathAccessor

getPingPath

Methods inherited from interface org.refcodes.rest.PingPathAccessor.PingPathMutator

setPingPath

Methods inherited from interface org.refcodes.rest.PingPathAccessor.PingPathProperty

letPingPath

Methods inherited from interface org.refcodes.component.Resumable

resumeUnchecked

Methods inherited from interface org.refcodes.component.Resumable.ResumeAutomaton

isResumable

Methods inherited from interface org.refcodes.component.RunningAccessor

isRunning

Methods inherited from interface org.refcodes.component.Startable

startUnchecked

Methods inherited from interface org.refcodes.component.Startable.StartAutomaton

isStartable

Methods inherited from interface org.refcodes.component.Stoppable

stopUnchecked

Methods inherited from interface org.refcodes.component.Stoppable.StopAutomaton

isStoppable, isStopped

Methods inherited from interface org.refcodes.security.TrustStoreDescriptorAccessor

getTrustStoreDescriptor

Methods inherited from interface org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorMutator

setTrustStoreDescriptor

Methods inherited from interface org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorProperty

letTrustStoreDescriptor

Methods inherited from interface org.refcodes.web.VirtualHostAccessor

getVirtualHost

Methods inherited from interface org.refcodes.web.VirtualHostAccessor.VirtualHostMutator

setVirtualHost

Methods inherited from interface org.refcodes.web.VirtualHostAccessor.VirtualHostProperty

letVirtualHost

Method Detail

withAlias

default B withAlias(String aAlias)

Specified by:

withAlias in interface org.refcodes.mixin.AliasAccessor.AliasBuilder<DESC extends HttpServerDescriptor>

withPingPath

default B withPingPath(String aPingPath)

Sets the ping path to use and returns this builder as of the builder pattern.

Specified by:

withPingPath in interface PingPathAccessor.PingPathBuilder<DESC extends HttpServerDescriptor>

Parameters:

aPingPath - The ping path to be stored by the ping path property.

Returns:

This PingPathAccessor.PingPathBuilder instance to continue configuration.

withHttpRegistryUrl

default B withHttpRegistryUrl(org.refcodes.web.Url aUrl)

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

Specified by:

withHttpRegistryUrl in interface HttpRegistryUrlAccessor.HttpRegistryUrlBuilder<DESC extends HttpServerDescriptor>

Parameters:

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

Returns:

The builder for applying multiple build operations.

withHttpServerDescriptor

default B withHttpServerDescriptor(DESC aServerDescriptor)

Sets the HttpServerDescriptor for the HttpServerDescriptor property.

Specified by:

withHttpServerDescriptor in interface HttpServerDescriptorAccessor.HttpServerDescriptorBuilder<DESC extends HttpServerDescriptor,B extends HttpRegistry<DESC,B>>

Parameters:

aServerDescriptor - The HttpServerDescriptor to be stored by the HttpServerDescriptor property.

Returns:

The builder for applying multiple build operations.

withHost

default B withHost(String aHost)

Specified by:

withHost in interface org.refcodes.web.HostAccessor.HostBuilder<DESC extends HttpServerDescriptor>

withVirtualHost

default B withVirtualHost(String aVirtualHost)

Specified by:

withVirtualHost in interface org.refcodes.web.VirtualHostAccessor.VirtualHostBuilder<DESC extends HttpServerDescriptor>

withIpAddress

default B withIpAddress(int[] aIpAddress)

Specified by:

withIpAddress in interface org.refcodes.web.IpAddressAccessor.IpAddressBuilder<DESC extends HttpServerDescriptor>

withCidrNotation

default B withCidrNotation(String aCidrNotation)

Specified by:

withCidrNotation in interface org.refcodes.web.IpAddressAccessor.IpAddressBuilder<DESC extends HttpServerDescriptor>

withTrustStoreDescriptor

default B withTrustStoreDescriptor(org.refcodes.security.TrustStoreDescriptor aStoreDescriptor)

Specified by:

withTrustStoreDescriptor in interface org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorBuilder<DESC extends HttpServerDescriptor>

withInstanceId

default B withInstanceId(String aInstanceId)

Specified by:

withInstanceId in interface org.refcodes.mixin.InstanceIdAccessor.InstanceIdBuilder<DESC extends HttpServerDescriptor>

initialize

default void initialize()
                 throws org.refcodes.component.InitializeException

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

Specified by:

initialize in interface org.refcodes.component.Initializable

Throws:

org.refcodes.component.InitializeException

initialize

default void initialize(HttpRegistryContext<DESC> aRegistryContext)
                 throws org.refcodes.component.InitializeException

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

Specified by:

initialize in interface org.refcodes.component.Configurable<DESC extends HttpServerDescriptor>

Parameters:

aRegistryContext - The context providing the descriptor of the server to be registered and the Url of the service registry to be used as well as the required truststore.

Throws:

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

initialize

default void initialize(DESC aServerDescriptor,
                        org.refcodes.web.Url aRegistryUrl)
                 throws org.refcodes.component.InitializeException

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

Parameters:

aServerDescriptor - The descriptor of the server to be registered.

aRegistryUrl - The URL of the service registry to be used.

Throws:

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

initialize

void initialize(DESC aServerDescriptor,
                org.refcodes.web.Url aRegistryUrl,
                org.refcodes.security.TrustStoreDescriptor aStoreDescriptor)
         throws org.refcodes.component.InitializeException

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

Parameters:

aServerDescriptor - The descriptor of the server to be registered.

aRegistryUrl - The URL of the service registry to be used.

aStoreDescriptor - The descriptor describing the truststore for (optionally) opening an HTTPS connection to the registry server.

Throws:

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

initialize

default void initialize(String aAlias,
                        String aInstanceId,
                        org.refcodes.data.Scheme aScheme,
                        int aPort,
                        org.refcodes.web.Url aRegistryUrl)
                 throws org.refcodes.component.InitializeException

Initializes the HttpRegistry 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).

aPort - The port of your service being registered.

aRegistryUrl - The registry server where to register.

Throws:

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

initialize

default void initialize(String aAlias,
                        org.refcodes.data.Scheme aScheme,
                        String aHost,
                        int aPort,
                        org.refcodes.web.Url aRegistryUrl)
                 throws org.refcodes.component.InitializeException

Initializes the HttpRegistry 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.

aPort - The port of your service being registered.

aRegistryUrl - The registry server where to register.

Throws:

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

initialize

default void initialize(String aAlias,
                        org.refcodes.data.Scheme aScheme,
                        String aHost,
                        String aVirtualHost,
                        int[] aIpAddress,
                        int aPort,
                        String aPingPath,
                        org.refcodes.web.Url aRegistryUrl)
                 throws org.refcodes.component.InitializeException

Initializes the HttpRegistry 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.

aRegistryUrl - The registry server where to register.

Throws:

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

initialize

default void initialize(String aAlias,
                        String aInstanceId,
                        org.refcodes.data.Scheme aScheme,
                        String aHost,
                        String aVirtualHost,
                        int[] aIpAddress,
                        int aPort,
                        String aPingPath,
                        org.refcodes.web.Url aRegistryUrl)
                 throws org.refcodes.component.InitializeException

Initializes the HttpRegistry 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.

aRegistryUrl - The registry server where to register.

Throws:

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

start

void start()
    throws org.refcodes.component.StartException

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

Specified by:

start in interface org.refcodes.component.Startable

Throws:

org.refcodes.component.StartException

pause

void pause()
    throws org.refcodes.component.PauseException

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

Specified by:

pause in interface org.refcodes.component.Pausable

Throws:

org.refcodes.component.PauseException

resume

void resume()
     throws org.refcodes.component.ResumeException

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

Specified by:

resume in interface org.refcodes.component.Resumable

Throws:

org.refcodes.component.ResumeException

stop

void stop()
   throws org.refcodes.component.StopException

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

Specified by:

stop in interface org.refcodes.component.Stoppable

Throws:

org.refcodes.component.StopException

destroy

void destroy()

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 org.refcodes.component.Destroyable