Package org.refcodes.rest
Interface HttpRegistryRestServer<DESC extends HttpServerDescriptor,B extends HttpRegistryRestServer<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<DESC>
,org.refcodes.mixin.AliasAccessor.AliasMutator
,org.refcodes.mixin.AliasAccessor.AliasProperty
,org.refcodes.net.BaseLocatorAccessor
,org.refcodes.net.BaseLocatorAccessor.BaseLocatorBuilder<DESC>
,org.refcodes.net.BaseLocatorAccessor.BaseLocatorMutator
,org.refcodes.net.BaseLocatorAccessor.BaseLocatorProperty
,org.refcodes.net.BasicAuthObservable<DESC>
,org.refcodes.component.Closable
,org.refcodes.component.Closable.CloseBuilder<DESC>
,org.refcodes.component.Configurable<DESC>
,org.refcodes.component.ConnectionComponent<DESC>
,org.refcodes.component.ConnectionComponent.ConnectionComponentBuilder<DESC,B>
,org.refcodes.component.ConnectionOpenable<DESC>
,org.refcodes.component.ConnectionOpenable.ConnectionOpenBuilder<DESC,B>
,org.refcodes.component.ConnectionStatusAccessor
,org.refcodes.component.Destroyable
,org.refcodes.component.Destroyable.DestroyAutomaton
,org.refcodes.net.HostAccessor
,org.refcodes.net.HostAccessor.HostBuilder<DESC>
,org.refcodes.net.HostAccessor.HostMutator
,org.refcodes.net.HostAccessor.HostProperty
,HttpExceptionHandlerAccessor
,HttpExceptionHandlerAccessor.HttpExceptionHandlerBuilder<DESC>
,HttpExceptionHandlerAccessor.HttpExceptionHandlerMutator
,HttpExceptionHandlerAccessor.HttpExceptionHandlerProperty
,HttpExceptionHandlingAccessor
,HttpExceptionHandlingAccessor.HttpExceptionHandlingBuilder<DESC>
,HttpExceptionHandlingAccessor.HttpExceptionHandlingMutator
,HttpExceptionHandlingAccessor.HttpExceptionHandlingProperty
,HttpRegistry<DESC,B>
,HttpRegistryUrlAccessor
,HttpRegistryUrlAccessor.HttpRegistryUrlBuilder<DESC>
,HttpRegistryUrlAccessor.HttpRegistryUrlMutator
,HttpRegistryUrlAccessor.HttpRegistryUrlProperty
,HttpRestServer
,org.refcodes.net.HttpsConnectionRequestObservable<DESC>
,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<DESC>
,org.refcodes.mixin.InstanceIdAccessor.InstanceIdMutator
,org.refcodes.mixin.InstanceIdAccessor.InstanceIdProperty
,org.refcodes.net.IpAddressAccessor
,org.refcodes.net.IpAddressAccessor.IpAddressBuilder<DESC>
,org.refcodes.net.IpAddressAccessor.IpAddressMutator
,org.refcodes.net.IpAddressAccessor.IpAddressProperty
,org.refcodes.security.KeyStoreDescriptorAccessor
,org.refcodes.security.KeyStoreDescriptorAccessor.KeyStoreDescriptorBuilder<DESC>
,org.refcodes.security.KeyStoreDescriptorAccessor.KeyStoreDescriptorMutator
,org.refcodes.security.KeyStoreDescriptorAccessor.KeyStoreDescriptorProperty
,org.refcodes.component.LifeCycleComponent
,org.refcodes.component.LifeCycleComponent.LifeCycleAutomaton
,org.refcodes.component.LifeCycleStatusAccessor
,org.refcodes.component.LinkComponent
,org.refcodes.io.MaxConnectionsAccessor
,org.refcodes.io.MaxConnectionsAccessor.MaxConnectionsBuilder<DESC>
,org.refcodes.io.MaxConnectionsAccessor.MaxConnectionsMutator
,org.refcodes.io.MaxConnectionsAccessor.MaxConnectionsProperty
,org.refcodes.net.MediaTypeFactoryLookup
,org.refcodes.net.MediaTypeFactoryLookup.MutableMediaTypeFactoryLookup
,org.refcodes.observer.Observable<DESC>
,org.refcodes.observer.Observers<DESC,B>
,org.refcodes.component.Openable
,org.refcodes.component.Pausable
,org.refcodes.component.Pausable.PauseAutomaton
,PingPathAccessor
,PingPathAccessor.PingPathBuilder<DESC>
,PingPathAccessor.PingPathMutator
,PingPathAccessor.PingPathProperty
,PingRequestObserver
,PingRequestObserverAccessor
,PingRequestObserverAccessor.PingRequestObserverBuilder<B>
,org.refcodes.mixin.PortAccessor
,org.refcodes.mixin.PortAccessor.PortBuilder<DESC>
,org.refcodes.mixin.PortAccessor.PortMutator
,org.refcodes.mixin.PortAccessor.PortProperty
,org.refcodes.net.RealmAccessor
,org.refcodes.net.RealmAccessor.RealmBuilder<DESC>
,org.refcodes.net.RealmAccessor.RealmMutator
,org.refcodes.net.RealmAccessor.RealmProperty
,org.refcodes.runtime.RequestCorrelation<DESC>
,RestServer
,org.refcodes.component.Resumable
,org.refcodes.component.Resumable.ResumeAutomaton
,org.refcodes.component.RunningAccessor
,org.refcodes.net.SchemeAccessor
,org.refcodes.net.SchemeAccessor.SchemeBuilder<DESC>
,org.refcodes.net.SchemeAccessor.SchemeMutator
,org.refcodes.net.SchemeAccessor.SchemeProperty
,org.refcodes.runtime.SessionCorrelation<DESC>
,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<DESC>
,org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorMutator
,org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorProperty
,org.refcodes.net.VirtualHostAccessor
,org.refcodes.net.VirtualHostAccessor.VirtualHostBuilder<DESC>
,org.refcodes.net.VirtualHostAccessor.VirtualHostMutator
,org.refcodes.net.VirtualHostAccessor.VirtualHostProperty
- All Known Implementing Classes:
AbstractHttpRegistryRestServerDecorator
public interface HttpRegistryRestServer<DESC extends HttpServerDescriptor,B extends HttpRegistryRestServer<DESC,B>> extends HttpRegistry<DESC,B>, HttpRestServer, PingRequestObserver, PingRequestObserverAccessor, PingRequestObserverAccessor.PingRequestObserverBuilder<B>
TheHttpRegistryRestServer
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 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.net.BaseLocatorAccessor
org.refcodes.net.BaseLocatorAccessor.BaseLocatorBuilder<B extends org.refcodes.net.BaseLocatorAccessor.BaseLocatorBuilder<B>>, org.refcodes.net.BaseLocatorAccessor.BaseLocatorMutator, org.refcodes.net.BaseLocatorAccessor.BaseLocatorProperty
-
Nested classes/interfaces inherited from interface org.refcodes.component.Closable
org.refcodes.component.Closable.CloseAutomaton, org.refcodes.component.Closable.CloseBuilder<B extends org.refcodes.component.Closable.CloseBuilder<B>>
-
Nested classes/interfaces inherited from interface org.refcodes.component.Configurable
org.refcodes.component.Configurable.ConfigureAutomaton<CTX extends java.lang.Object>, org.refcodes.component.Configurable.ConfigureBuilder<CTX extends java.lang.Object,B extends org.refcodes.component.Configurable.ConfigureBuilder<CTX,B>>
-
Nested classes/interfaces inherited from interface org.refcodes.component.ConnectionComponent
org.refcodes.component.ConnectionComponent.ConnectionAutomaton<CON extends java.lang.Object>, org.refcodes.component.ConnectionComponent.ConnectionComponentBuilder<CON extends java.lang.Object,B extends org.refcodes.component.ConnectionComponent.ConnectionComponentBuilder<CON,B>>
-
Nested classes/interfaces inherited from interface org.refcodes.component.ConnectionOpenable
org.refcodes.component.ConnectionOpenable.ConnectionOpenAutomaton<CON extends java.lang.Object>, org.refcodes.component.ConnectionOpenable.ConnectionOpenBuilder<CON extends java.lang.Object,B extends org.refcodes.component.ConnectionOpenable.ConnectionOpenBuilder<CON,B>>
-
Nested classes/interfaces inherited from interface org.refcodes.component.ConnectionStatusAccessor
org.refcodes.component.ConnectionStatusAccessor.ConnectionStatusMutator, org.refcodes.component.ConnectionStatusAccessor.ConnectionStatusProperty
-
Nested classes/interfaces inherited from interface org.refcodes.component.Destroyable
org.refcodes.component.Destroyable.DestroyAutomaton
-
Nested classes/interfaces inherited from interface org.refcodes.net.HostAccessor
org.refcodes.net.HostAccessor.HostBuilder<B extends org.refcodes.net.HostAccessor.HostBuilder<?>>, org.refcodes.net.HostAccessor.HostMutator, org.refcodes.net.HostAccessor.HostProperty
-
Nested classes/interfaces inherited from interface org.refcodes.rest.HttpExceptionHandlerAccessor
HttpExceptionHandlerAccessor.HttpExceptionHandlerBuilder<B extends HttpExceptionHandlerAccessor.HttpExceptionHandlerBuilder<B>>, HttpExceptionHandlerAccessor.HttpExceptionHandlerMutator, HttpExceptionHandlerAccessor.HttpExceptionHandlerProperty
-
Nested classes/interfaces inherited from interface org.refcodes.rest.HttpExceptionHandlingAccessor
HttpExceptionHandlingAccessor.HttpExceptionHandlingBuilder<B extends HttpExceptionHandlingAccessor.HttpExceptionHandlingBuilder<B>>, HttpExceptionHandlingAccessor.HttpExceptionHandlingMutator, HttpExceptionHandlingAccessor.HttpExceptionHandlingProperty
-
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.net.IpAddressAccessor
org.refcodes.net.IpAddressAccessor.IpAddressBuilder<B extends org.refcodes.net.IpAddressAccessor.IpAddressBuilder<B>>, org.refcodes.net.IpAddressAccessor.IpAddressMutator, org.refcodes.net.IpAddressAccessor.IpAddressProperty
-
Nested classes/interfaces inherited from interface org.refcodes.security.KeyStoreDescriptorAccessor
org.refcodes.security.KeyStoreDescriptorAccessor.KeyStoreDescriptorBuilder<B extends org.refcodes.security.KeyStoreDescriptorAccessor.KeyStoreDescriptorBuilder<B>>, org.refcodes.security.KeyStoreDescriptorAccessor.KeyStoreDescriptorMutator, org.refcodes.security.KeyStoreDescriptorAccessor.KeyStoreDescriptorProperty
-
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.LinkComponent
org.refcodes.component.LinkComponent.LinkAutomaton, org.refcodes.component.LinkComponent.LinkComponentBuilder<B extends org.refcodes.component.LinkComponent.LinkComponentBuilder<B>>
-
Nested classes/interfaces inherited from interface org.refcodes.io.MaxConnectionsAccessor
org.refcodes.io.MaxConnectionsAccessor.MaxConnectionsBuilder<B extends org.refcodes.io.MaxConnectionsAccessor.MaxConnectionsBuilder<B>>, org.refcodes.io.MaxConnectionsAccessor.MaxConnectionsMutator, org.refcodes.io.MaxConnectionsAccessor.MaxConnectionsProperty
-
Nested classes/interfaces inherited from interface org.refcodes.net.MediaTypeFactoryLookup
org.refcodes.net.MediaTypeFactoryLookup.MutableMediaTypeFactoryLookup
-
Nested classes/interfaces inherited from interface org.refcodes.component.Openable
org.refcodes.component.Openable.OpenAutomaton, org.refcodes.component.Openable.OpenBuilder<B extends org.refcodes.component.Openable.OpenBuilder<B>>
-
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.rest.PingRequestObserverAccessor
PingRequestObserverAccessor.PingRequestObserverBuilder<B extends PingRequestObserverAccessor.PingRequestObserverBuilder<B>>, PingRequestObserverAccessor.PingRequestObserverMutator, PingRequestObserverAccessor.PingRequestObserverProperty
-
Nested classes/interfaces inherited from interface org.refcodes.mixin.PortAccessor
org.refcodes.mixin.PortAccessor.PortBuilder<B extends org.refcodes.mixin.PortAccessor.PortBuilder<B>>, org.refcodes.mixin.PortAccessor.PortMutator, org.refcodes.mixin.PortAccessor.PortProperty
-
Nested classes/interfaces inherited from interface org.refcodes.net.RealmAccessor
org.refcodes.net.RealmAccessor.RealmBuilder<B extends org.refcodes.net.RealmAccessor.RealmBuilder<B>>, org.refcodes.net.RealmAccessor.RealmMutator, org.refcodes.net.RealmAccessor.RealmProperty
-
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.net.SchemeAccessor
org.refcodes.net.SchemeAccessor.SchemeBuilder<B extends org.refcodes.net.SchemeAccessor.SchemeBuilder<B>>, org.refcodes.net.SchemeAccessor.SchemeMutator, org.refcodes.net.SchemeAccessor.SchemeProperty
-
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.net.VirtualHostAccessor
org.refcodes.net.VirtualHostAccessor.VirtualHostBuilder<B extends org.refcodes.net.VirtualHostAccessor.VirtualHostBuilder<?>>, org.refcodes.net.VirtualHostAccessor.VirtualHostMutator, org.refcodes.net.VirtualHostAccessor.VirtualHostProperty
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description void
destroy()
This server is taken (removed) from the registry server.void
initialize(java.lang.String aAlias, java.lang.String aInstanceId, org.refcodes.data.Scheme aScheme, java.lang.String aHost, java.lang.String aVirtualHost, int[] aIpAddress, int aPort, java.lang.String aPingPath, RestRequestObserver aPingRequestObserver, org.refcodes.net.Url aRegistryUrl)
Initializes theHttpRegistryRestServer
by registering it at the service registry with a status such as "starting" or "initializing" or "not-ready-yet".default void
initialize(java.lang.String aAlias, org.refcodes.data.Scheme aScheme, java.lang.String aHost, java.lang.String aVirtualHost, int[] aIpAddress, int aPort, java.lang.String aPingPath, RestRequestObserver aPingRequestObserver, org.refcodes.net.Url aRegistryUrl)
Initializes theHttpRegistryRestServer
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(RestRequestObserver aRequestObserver)
Sets the pingRestRequestObserver
for the pingRestRequestObserver
property.default B
withPort(int aPort)
default B
withProtocol(java.lang.String aProtocol)
default B
withScheme(org.refcodes.data.Scheme aScheme)
-
Methods inherited from interface org.refcodes.net.BaseLocatorAccessor.BaseLocatorMutator
setBaseLocator
-
Methods inherited from interface org.refcodes.component.Closable
close, closeIn, closeQuietly, closeUnchecked
-
Methods inherited from interface org.refcodes.component.ConnectionOpenable.ConnectionOpenBuilder
withOpenUnchecked
-
Methods inherited from interface org.refcodes.component.ConnectionStatusAccessor
getConnectionStatus, isConnectionOpened
-
Methods inherited from interface org.refcodes.component.Destroyable.DestroyAutomaton
isDestroyable, isDestroyed
-
Methods inherited from interface org.refcodes.rest.HttpExceptionHandlerAccessor
getHttpExceptionHandler
-
Methods inherited from interface org.refcodes.rest.HttpExceptionHandlerAccessor.HttpExceptionHandlerBuilder
withOnHttpException
-
Methods inherited from interface org.refcodes.rest.HttpExceptionHandlerAccessor.HttpExceptionHandlerMutator
onHttpException, setHttpExceptionHandler
-
Methods inherited from interface org.refcodes.rest.HttpExceptionHandlingAccessor
getHttpExceptionHandling
-
Methods inherited from interface org.refcodes.rest.HttpExceptionHandlingAccessor.HttpExceptionHandlingMutator
setHttpExceptionHandling
-
Methods inherited from interface org.refcodes.rest.HttpRegistry
initialize, initialize, initialize, initialize, initialize, initialize, initialize, initialize, withAlias, withCidrNotation, withHost, withHttpRegistryUrl, withHttpServerDescriptor, withInstanceId, withIpAddress, withPingPath, withTrustStoreDescriptor, withVirtualHost
-
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.HttpRestServer
open, open, open, open, open, open, open, open, open, open, open, open, open, withBaseLocator, withClose, withCloseIn, withCloseQuietly, withDisableRequestCorrelation, withDisableSessionCorrelation, withEnableRequestCorrelation, withEnableSessionCorrelation, withHttpExceptionHandler, withHttpExceptionHandling, withKeyStoreDescriptor, withMaxConnections, withOpen, withOpen, withRealm, withRequestCorrelation, withSessionCorrelation
-
Methods inherited from interface org.refcodes.net.HttpsConnectionRequestObservable
onConnectionRequest
-
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.HttpServerDescriptorFactory
toHttpServerDescriptor, toHttpServerDescriptor, toHttpServerDescriptor, toHttpServerDescriptor, toHttpServerDescriptor
-
Methods inherited from interface org.refcodes.component.Initializable.InitializeAutomaton
isInitalizable
-
Methods inherited from interface org.refcodes.mixin.InstanceIdAccessor.InstanceIdMutator
setInstanceId
-
Methods inherited from interface org.refcodes.net.IpAddressAccessor.IpAddressMutator
fromCidrNotation, setIpAddress
-
Methods inherited from interface org.refcodes.security.KeyStoreDescriptorAccessor
getKeyStoreDescriptor
-
Methods inherited from interface org.refcodes.security.KeyStoreDescriptorAccessor.KeyStoreDescriptorMutator
setKeyStoreDescriptor
-
Methods inherited from interface org.refcodes.io.MaxConnectionsAccessor.MaxConnectionsMutator
setMaxConnections
-
Methods inherited from interface org.refcodes.net.MediaTypeFactoryLookup
getFactoryMediaTypes, hasMediaTypeFactory, toMediaTypeFactory
-
Methods inherited from interface org.refcodes.net.MediaTypeFactoryLookup.MutableMediaTypeFactoryLookup
addMediaTypeFactory
-
Methods inherited from interface org.refcodes.observer.Observable
hasObserverSubscription, subscribeObserver, unsubscribeObserver
-
Methods inherited from interface org.refcodes.observer.Observers
disableObservers, enableObservers, isObserversActive, observers, setObserversActive
-
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.PingRequestObserver
onPingRequest
-
Methods inherited from interface org.refcodes.rest.PingRequestObserverAccessor
getPingRequestObserver
-
Methods inherited from interface org.refcodes.runtime.RequestCorrelation
disableRequestCorrelation, enableRequestCorrelation, hasRequestCorrelation, setRequestCorrelation
-
Methods inherited from interface org.refcodes.rest.RestServer
onDelete, onGet, onPost, onPut, onRequest, onRequest, onRequest, withDisableObservers, withEnableObservers, withObserversActive
-
Methods inherited from interface org.refcodes.net.SchemeAccessor.SchemeMutator
setProtocol, setScheme
-
Methods inherited from interface org.refcodes.runtime.SessionCorrelation
disableSessionCorrelation, enableSessionCorrelation, hasSessionCorrelation, setSessionCorrelation
-
Methods inherited from interface org.refcodes.component.Stoppable.StopAutomaton
isStoppable, isStopped
-
Methods inherited from interface org.refcodes.security.TrustStoreDescriptorAccessor
getTrustStoreDescriptor
-
-
-
-
Method Detail
-
withPort
default B withPort(int aPort)
- Specified by:
withPort
in interfaceHttpRestServer
- Specified by:
withPort
in interfaceorg.refcodes.mixin.PortAccessor.PortBuilder<DESC extends HttpServerDescriptor>
-
withScheme
default B withScheme(org.refcodes.data.Scheme aScheme)
- Specified by:
withScheme
in interfaceHttpRestServer
- Specified by:
withScheme
in interfaceorg.refcodes.net.SchemeAccessor.SchemeBuilder<DESC extends HttpServerDescriptor>
-
withProtocol
default B withProtocol(java.lang.String aProtocol)
- Specified by:
withProtocol
in interfaceHttpRestServer
- Specified by:
withProtocol
in interfaceorg.refcodes.net.SchemeAccessor.SchemeBuilder<DESC extends HttpServerDescriptor>
-
withPingRequestObserver
default B withPingRequestObserver(RestRequestObserver aRequestObserver)
Sets the pingRestRequestObserver
for the pingRestRequestObserver
property.- Specified by:
withPingRequestObserver
in interfacePingRequestObserverAccessor.PingRequestObserverBuilder<DESC extends HttpServerDescriptor>
- Parameters:
aRequestObserver
- The pingRestRequestObserver
to be stored by the pingRestRequestObserver
property.- Returns:
- The builder for applying multiple build operations.
-
initialize
default void initialize(java.lang.String aAlias, org.refcodes.data.Scheme aScheme, java.lang.String aHost, java.lang.String aVirtualHost, int[] aIpAddress, int aPort, java.lang.String aPingPath, RestRequestObserver aPingRequestObserver, org.refcodes.net.Url aRegistryUrl) throws org.refcodes.component.InitializeException
Initializes theHttpRegistryRestServer
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
- TheScheme
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
- TheRestRequestObserver
hooking into a ping request.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
void initialize(java.lang.String aAlias, java.lang.String aInstanceId, org.refcodes.data.Scheme aScheme, java.lang.String aHost, java.lang.String aVirtualHost, int[] aIpAddress, int aPort, java.lang.String aPingPath, RestRequestObserver aPingRequestObserver, org.refcodes.net.Url aRegistryUrl) throws org.refcodes.component.InitializeException
Initializes theHttpRegistryRestServer
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 ID for the instance when being registered at the service registry. If omitted, then the host name is used.aScheme
- TheScheme
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
- TheRestRequestObserver
hooking into a ping request.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. The registeredRestEndpoint
instances (observers) (e.g. viaRestServer.onRequest(org.refcodes.net.HttpMethod, String, RestRequestObserver)
,RestServer.onGet(String, RestRequestObserver)
RestServer.onPut(String, RestRequestObserver)
,RestServer.onPut(String, RestRequestObserver)
orRestServer.onDelete(String, RestRequestObserver)
) are enabled by callingObservers.enableObservers()
. If necessary, the connection is opened viaHttpRestServer.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 interfaceHttpRegistry<DESC extends HttpServerDescriptor,B extends HttpRegistryRestServer<DESC,B>>
- Specified by:
start
in interfaceorg.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. The registeredRestEndpoint
instances (observers) (e.g. viaRestEndpointBuilder
being registered e.g. viaRestServer.onRequest(org.refcodes.net.HttpMethod, String, RestRequestObserver)
,RestServer.onGet(String, RestRequestObserver)
RestServer.onPut(String, RestRequestObserver)
,RestServer.onPut(String, RestRequestObserver)
orRestServer.onDelete(String, RestRequestObserver)
is closed by calling itsClosable.close()
) are disabled by callingObservers.disableObservers()
. Some "deactivated" status is communicated to the registry server.- Specified by:
pause
in interfaceHttpRegistry<DESC extends HttpServerDescriptor,B extends HttpRegistryRestServer<DESC,B>>
- Specified by:
pause
in interfaceorg.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. The registeredRestEndpoint
instances (observers) (e.g. viaRestEndpointBuilder
being registered e.g. viaRestServer.onRequest(org.refcodes.net.HttpMethod, String, RestRequestObserver)
,RestServer.onGet(String, RestRequestObserver)
RestServer.onPut(String, RestRequestObserver)
,RestServer.onPut(String, RestRequestObserver)
orRestServer.onDelete(String, RestRequestObserver)
is closed by calling itsClosable.close()
) are enabled (again) by callingObservers.enableObservers()
. Some "up-and-running (again)" status is communicated to the registry server.- Specified by:
resume
in interfaceHttpRegistry<DESC extends HttpServerDescriptor,B extends HttpRegistryRestServer<DESC,B>>
- Specified by:
resume
in interfaceorg.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. The registeredRestEndpoint
instances (observers) (e.g. viaRestServer.onRequest(org.refcodes.net.HttpMethod, String, RestRequestObserver)
,RestServer.onGet(String, RestRequestObserver)
RestServer.onPut(String, RestRequestObserver)
,RestServer.onPut(String, RestRequestObserver)
orRestServer.onDelete(String, RestRequestObserver)
) are disabled by callingObservers.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 interfaceHttpRegistry<DESC extends HttpServerDescriptor,B extends HttpRegistryRestServer<DESC,B>>
- Specified by:
stop
in interfaceorg.refcodes.component.Stoppable
- Throws:
org.refcodes.component.StopException
-
destroy
void destroy()
This server is taken (removed) from the registry server. The registeredRestEndpoint
instances (observers) (e.g. viaRestServer.onRequest(org.refcodes.net.HttpMethod, String, RestRequestObserver)
,RestServer.onGet(String, RestRequestObserver)
RestServer.onPut(String, RestRequestObserver)
,RestServer.onPut(String, RestRequestObserver)
orRestServer.onDelete(String, RestRequestObserver)
) are disabled by callingObservers.disableObservers()
. Also stops a "ping" or "heartbeat" daemon. Finally the connection is closed viaClosable.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 interfaceorg.refcodes.component.Destroyable
- Specified by:
destroy
in interfaceHttpRegistry<DESC extends HttpServerDescriptor,B extends HttpRegistryRestServer<DESC,B>>
-
-