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.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.net.HostAccessor.HostProperty, org.refcodes.net.HostAccessor.HostBuilder<B>, org.refcodes.net.VirtualHostAccessor.VirtualHostProperty, org.refcodes.net.VirtualHostAccessor.VirtualHostBuilder<B>, org.refcodes.net.IpAddressAccessor.IpAddressProperty, org.refcodes.net.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>
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.org.refcodes.component.Configurable.ConfigureAutomaton<CTX>, org.refcodes.component.Configurable.ConfigureBuilder<CTX,B extends org.refcodes.component.Configurable.ConfigureBuilder<CTX,B>>
HttpServerDescriptorAccessor.HttpServerDescriptorBuilder<DESC extends HttpServerDescriptor,B extends HttpServerDescriptorAccessor.HttpServerDescriptorBuilder<DESC,B>>, HttpServerDescriptorAccessor.HttpServerDescriptorMutator<DESC extends HttpServerDescriptor>, HttpServerDescriptorAccessor.HttpServerDescriptorProperty<DESC extends HttpServerDescriptor>
PingPathAccessor.PingPathBuilder<B extends PingPathAccessor.PingPathBuilder<?>>, PingPathAccessor.PingPathMutator, PingPathAccessor.PingPathProperty
org.refcodes.net.HostAccessor.HostBuilder<B extends org.refcodes.net.HostAccessor.HostBuilder<?>>, org.refcodes.net.HostAccessor.HostMutator, org.refcodes.net.HostAccessor.HostProperty
org.refcodes.net.VirtualHostAccessor.VirtualHostBuilder<B extends org.refcodes.net.VirtualHostAccessor.VirtualHostBuilder<?>>, org.refcodes.net.VirtualHostAccessor.VirtualHostMutator, org.refcodes.net.VirtualHostAccessor.VirtualHostProperty
org.refcodes.net.IpAddressAccessor.IpAddressBuilder<B extends org.refcodes.net.IpAddressAccessor.IpAddressBuilder<B>>, org.refcodes.net.IpAddressAccessor.IpAddressMutator, org.refcodes.net.IpAddressAccessor.IpAddressProperty
org.refcodes.mixin.InstanceIdAccessor.InstanceIdBuilder<B extends org.refcodes.mixin.InstanceIdAccessor.InstanceIdBuilder<B>>, org.refcodes.mixin.InstanceIdAccessor.InstanceIdMutator, org.refcodes.mixin.InstanceIdAccessor.InstanceIdProperty
org.refcodes.mixin.AliasAccessor.AliasBuilder<B extends org.refcodes.mixin.AliasAccessor.AliasBuilder<B>>, org.refcodes.mixin.AliasAccessor.AliasMutator, org.refcodes.mixin.AliasAccessor.AliasProperty
org.refcodes.component.LifeCycleComponent.LifeCycleAutomaton, org.refcodes.component.LifeCycleComponent.UncheckedLifeCycleComponent
org.refcodes.component.Initializable.InitializeAutomaton, org.refcodes.component.Initializable.InitializeBuilder<B extends org.refcodes.component.Initializable.InitializeBuilder<B>>, org.refcodes.component.Initializable.UncheckedInitializable
org.refcodes.component.InitializedAccessor.InitializedMutator, org.refcodes.component.InitializedAccessor.InitializedProperty
org.refcodes.component.Startable.StartAutomaton, org.refcodes.component.Startable.StartBuilder<B extends org.refcodes.component.Startable.StartBuilder<B>>, org.refcodes.component.Startable.UncheckedStartable
org.refcodes.component.Pausable.PauseAutomaton, org.refcodes.component.Pausable.PauseBuilder<B extends org.refcodes.component.Pausable.PauseBuilder<B>>, org.refcodes.component.Pausable.UncheckedPausable
org.refcodes.component.Resumable.ResumeAutomaton, org.refcodes.component.Resumable.ResumeBuilder<B extends org.refcodes.component.Resumable.ResumeBuilder<B>>, org.refcodes.component.Resumable.UncheckedResumable
org.refcodes.component.RunningAccessor.RunningMutator, org.refcodes.component.RunningAccessor.RunningProperty
org.refcodes.component.Stoppable.StopAutomaton, org.refcodes.component.Stoppable.StopBuilder<B extends org.refcodes.component.Stoppable.StopBuilder<B>>, org.refcodes.component.Stoppable.UncheckedStoppable
org.refcodes.component.Destroyable.DestroyAutomaton
org.refcodes.component.LifeCycleStatusAccessor.LifeCycleStatusBuilder<B extends org.refcodes.component.LifeCycleStatusAccessor.LifeCycleStatusBuilder<B>>, org.refcodes.component.LifeCycleStatusAccessor.LifeCycleStatusMutator, org.refcodes.component.LifeCycleStatusAccessor.LifeCycleStatusProperty
HttpRegistryUrlAccessor.HttpRegistryUrlBuilder<B extends HttpRegistryUrlAccessor.HttpRegistryUrlBuilder<B>>, HttpRegistryUrlAccessor.HttpRegistryUrlMutator, HttpRegistryUrlAccessor.HttpRegistryUrlProperty
org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorBuilder<B extends org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorBuilder<B>>, org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorMutator, org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorProperty
Modifier and Type | Method and 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.net.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.net.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(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". |
default void |
initialize(String aAlias,
org.refcodes.data.Scheme aScheme,
String aHost,
int aPort,
org.refcodes.net.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.net.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,
int aPort,
org.refcodes.net.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.net.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 |
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.net.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) |
getHttpServerDescriptor
setHttpServerDescriptor
getPingPath
setPingPath
setVirtualHost
fromCidrNotation, setIpAddress
setInstanceId
isInitalizable
isPausable, isPaused
isStoppable, isStopped
isDestroyable, isDestroyed
getHttpRegistryUrl
setHttpRegistryUrl
getTrustStoreDescriptor
setTrustStoreDescriptor
toHttpServerDescriptor, toHttpServerDescriptor, toHttpServerDescriptor, toHttpServerDescriptor, toHttpServerDescriptor
default B withAlias(String aAlias)
withAlias
in interface org.refcodes.mixin.AliasAccessor.AliasBuilder<B extends HttpRegistry<DESC,B>>
default B withPingPath(String aPingPath)
withPingPath
in interface PingPathAccessor.PingPathBuilder<B extends HttpRegistry<DESC,B>>
aPingPath
- The ping path to be stored by the ping path
property.PingPathAccessor.PingPathBuilder
instance to continue
configuration.default B withHttpRegistryUrl(org.refcodes.net.Url aUrl)
withHttpRegistryUrl
in interface HttpRegistryUrlAccessor.HttpRegistryUrlBuilder<B extends HttpRegistry<DESC,B>>
aUrl
- The service registry registry URL to be stored by the
URL property.default B withHttpServerDescriptor(DESC aServerDescriptor)
HttpServerDescriptor
for the
HttpServerDescriptor
property.withHttpServerDescriptor
in interface HttpServerDescriptorAccessor.HttpServerDescriptorBuilder<DESC extends HttpServerDescriptor,B extends HttpRegistry<DESC,B>>
aServerDescriptor
- The HttpServerDescriptor
to be
stored by the HttpServerDescriptor
property.default B withHost(String aHost)
withHost
in interface org.refcodes.net.HostAccessor.HostBuilder<B extends HttpRegistry<DESC,B>>
default B withVirtualHost(String aVirtualHost)
withVirtualHost
in interface org.refcodes.net.VirtualHostAccessor.VirtualHostBuilder<B extends HttpRegistry<DESC,B>>
default B withIpAddress(int[] aIpAddress)
withIpAddress
in interface org.refcodes.net.IpAddressAccessor.IpAddressBuilder<B extends HttpRegistry<DESC,B>>
default B withCidrNotation(String aCidrNotation)
withCidrNotation
in interface org.refcodes.net.IpAddressAccessor.IpAddressBuilder<B extends HttpRegistry<DESC,B>>
default B withTrustStoreDescriptor(org.refcodes.security.TrustStoreDescriptor aStoreDescriptor)
withTrustStoreDescriptor
in interface org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorBuilder<B extends HttpRegistry<DESC,B>>
default B withInstanceId(String aInstanceId)
withInstanceId
in interface org.refcodes.mixin.InstanceIdAccessor.InstanceIdBuilder<B extends HttpRegistry<DESC,B>>
default void initialize() throws org.refcodes.component.InitializeException
HttpRegistry
by registering it at the service
registry with a status such as "starting" or "initializing" or
"not-ready-yet".
initialize
in interface org.refcodes.component.Initializable
org.refcodes.component.InitializeException
default void initialize(HttpRegistryContext<DESC> aRegistryContext) throws org.refcodes.component.InitializeException
HttpRegistry
by registering it at the service
registry with a status such as "starting" or "initializing" or
"not-ready-yet".
initialize
in interface org.refcodes.component.Configurable<HttpRegistryContext<DESC extends HttpServerDescriptor>>
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.org.refcodes.component.InitializeException
- thrown in case initializing a component
caused problems. Usually a method similar to "initialize()"
throws such an exception.default void initialize(DESC aServerDescriptor, org.refcodes.net.Url aRegistryUrl) throws org.refcodes.component.InitializeException
HttpRegistry
by registering it at the service
registry with a status such as "starting" or "initializing" or
"not-ready-yet".
aServerDescriptor
- The descriptor of the server to be registered.aRegistryUrl
- The URL of the service registry to be used.org.refcodes.component.InitializeException
- thrown in case initializing a component
caused problems. Usually a method similar to "initialize()"
throws such an exception.void initialize(DESC aServerDescriptor, org.refcodes.net.Url aRegistryUrl, org.refcodes.security.TrustStoreDescriptor aStoreDescriptor) throws org.refcodes.component.InitializeException
HttpRegistry
by registering it at the service
registry with a status such as "starting" or "initializing" or
"not-ready-yet".
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.org.refcodes.component.InitializeException
- thrown in case initializing a component
caused problems. Usually a method similar to "initialize()"
throws such an exception.default void initialize(String aAlias, String aInstanceId, org.refcodes.data.Scheme aScheme, int aPort, org.refcodes.net.Url aRegistryUrl) throws org.refcodes.component.InitializeException
HttpRegistry
by registering it at the service
registry with a status such as "starting" or "initializing" or
"not-ready-yet".
aAlias
- The name ("alias") which identifies the server in the
registry.aInstanceId
- The ID 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.org.refcodes.component.InitializeException
- thrown in case initializing a component
caused problems. Usually a method similar to "initialize()"
throws such an exception.default void initialize(String aAlias, org.refcodes.data.Scheme aScheme, String aHost, int aPort, org.refcodes.net.Url aRegistryUrl) throws org.refcodes.component.InitializeException
HttpRegistry
by registering it at the service
registry with a status such as "starting" or "initializing" or
"not-ready-yet".
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.org.refcodes.component.InitializeException
- thrown in case initializing a component
caused problems. Usually a method similar to "initialize()"
throws such an exception.default void initialize(String aAlias, org.refcodes.data.Scheme aScheme, String aHost, String aVirtualHost, int[] aIpAddress, int aPort, String aPingPath, org.refcodes.net.Url aRegistryUrl) throws org.refcodes.component.InitializeException
HttpRegistry
by registering it at the service
registry with a status such as "starting" or "initializing" or
"not-ready-yet".
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.org.refcodes.component.InitializeException
- thrown in case initializing a component
caused problems. Usually a method similar to "initialize()"
throws such an exception.default void initialize(String aAlias, String aInstanceId, org.refcodes.data.Scheme aScheme, String aHost, String aVirtualHost, int[] aIpAddress, int aPort, String aPingPath, org.refcodes.net.Url aRegistryUrl) throws org.refcodes.component.InitializeException
HttpRegistry
by registering it at the service
registry with a status such as "starting" or "initializing" or
"not-ready-yet".
aAlias
- The name ("alias") which identifies the server in the
registry.aInstanceId
- The ID 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.org.refcodes.component.InitializeException
- thrown in case initializing a component
caused problems. Usually a method similar to "initialize()"
throws such an exception.void start() throws org.refcodes.component.StartException
start
in interface org.refcodes.component.Startable
org.refcodes.component.StartException
void pause() throws org.refcodes.component.PauseException
pause
in interface org.refcodes.component.Pausable
org.refcodes.component.PauseException
void resume() throws org.refcodes.component.ResumeException
resume
in interface org.refcodes.component.Resumable
org.refcodes.component.ResumeException
void stop() throws org.refcodes.component.StopException
stop
in interface org.refcodes.component.Stoppable
org.refcodes.component.StopException
void destroy()
destroy
in interface org.refcodes.component.Destroyable
Copyright © 2018. All rights reserved.