Module org.refcodes.rest

Package org.refcodes.rest

Interface RestfulHttpRegistryServer<DESC extends HttpServerDescriptor,B extends RestfulHttpRegistryServer<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.web.BaseLocatorAccessor, org.refcodes.web.BaseLocatorAccessor.BaseLocatorBuilder<RestfulServer>, org.refcodes.web.BaseLocatorAccessor.BaseLocatorMutator, org.refcodes.web.BaseLocatorAccessor.BaseLocatorProperty, org.refcodes.web.BasicAuthObservable<RestfulHttpServer>, org.refcodes.component.Closable, org.refcodes.component.Closable.CloseBuilder<org.refcodes.component.ConnectionComponent.ConnectionComponentBuilder<org.refcodes.web.HttpServerContext,RestfulHttpServer>>, org.refcodes.component.Configurable<HttpRegistryContext<DESC>>, org.refcodes.component.ConnectionComponent<org.refcodes.web.HttpServerContext>, org.refcodes.component.ConnectionComponent.ConnectionComponentBuilder<org.refcodes.web.HttpServerContext,RestfulHttpServer>, org.refcodes.component.ConnectionOpenable<org.refcodes.web.HttpServerContext>, org.refcodes.component.ConnectionOpenable.ConnectionOpenBuilder<org.refcodes.web.HttpServerContext,org.refcodes.component.ConnectionComponent.ConnectionComponentBuilder<org.refcodes.web.HttpServerContext,RestfulHttpServer>>, org.refcodes.component.ConnectionStatusAccessor, 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, HttpExceptionHandlerAccessor, HttpExceptionHandlerAccessor.HttpExceptionHandlerBuilder<RestfulHttpServer>, HttpExceptionHandlerAccessor.HttpExceptionHandlerMutator, HttpExceptionHandlerAccessor.HttpExceptionHandlerProperty, HttpExceptionHandlingAccessor, HttpExceptionHandlingAccessor.HttpExceptionHandlingBuilder<RestfulHttpServer>, HttpExceptionHandlingAccessor.HttpExceptionHandlingMutator, HttpExceptionHandlingAccessor.HttpExceptionHandlingProperty, HttpRegistry<DESC,B>, HttpRegistryUrlAccessor, HttpRegistryUrlAccessor.HttpRegistryUrlBuilder<B>, HttpRegistryUrlAccessor.HttpRegistryUrlMutator, HttpRegistryUrlAccessor.HttpRegistryUrlProperty, org.refcodes.web.HttpsConnectionRequestObservable<RestfulHttpServer>, HttpServerDescriptorAccessor<DESC>, HttpServerDescriptorAccessor.HttpServerDescriptorBuilder<DESC,B>, HttpServerDescriptorAccessor.HttpServerDescriptorMutator<DESC>, HttpServerDescriptorAccessor.HttpServerDescriptorProperty<DESC>, HttpServerDescriptorFactory<DESC>, org.refcodes.web.HttpServerInterceptable, 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.net.IpAddressAccessor, org.refcodes.net.IpAddressAccessor.IpAddressBuilder<B>, org.refcodes.net.IpAddressAccessor.IpAddressMutator, org.refcodes.net.IpAddressAccessor.IpAddressProperty, org.refcodes.security.KeyStoreDescriptorAccessor, org.refcodes.security.KeyStoreDescriptorAccessor.KeyStoreDescriptorBuilder<RestfulHttpServer>, 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<RestfulHttpServer>, org.refcodes.io.MaxConnectionsAccessor.MaxConnectionsMutator, org.refcodes.io.MaxConnectionsAccessor.MaxConnectionsProperty, org.refcodes.web.MediaTypeFactoryLookup, org.refcodes.web.MediaTypeFactoryLookup.MutableMediaTypeFactoryLookup, org.refcodes.observer.Observable<RestEndpoint>, org.refcodes.observer.Observers<RestEndpoint,RestfulServer>, org.refcodes.component.Openable, org.refcodes.component.OpenedAccessor, org.refcodes.component.Pausable, org.refcodes.component.Pausable.PauseAutomaton, PingPathAccessor, PingPathAccessor.PingPathBuilder<B>, PingPathAccessor.PingPathMutator, PingPathAccessor.PingPathProperty, PingRequestObserver, PingRequestObserverAccessor, PingRequestObserverAccessor.PingRequestObserverBuilder<B>, org.refcodes.mixin.PortAccessor, org.refcodes.mixin.PortAccessor.PortBuilder<RestfulHttpServer>, org.refcodes.mixin.PortAccessor.PortMutator, org.refcodes.mixin.PortAccessor.PortProperty, org.refcodes.web.PostHttpInterceptable<org.refcodes.web.PostHttpServerInterceptor>, org.refcodes.web.PostHttpServerInterceptable, org.refcodes.web.PreHttpInterceptable<org.refcodes.web.PreHttpServerInterceptor>, org.refcodes.web.PreHttpServerInterceptable, org.refcodes.web.RealmAccessor, org.refcodes.web.RealmAccessor.RealmBuilder<RestfulServer>, org.refcodes.web.RealmAccessor.RealmMutator, org.refcodes.web.RealmAccessor.RealmProperty, RestfulHttpServer, RestfulServer, org.refcodes.component.Resumable, org.refcodes.component.Resumable.ResumeAutomaton, org.refcodes.component.RunningAccessor, org.refcodes.web.SchemeAccessor, org.refcodes.web.SchemeAccessor.SchemeBuilder<RestfulHttpServer>, org.refcodes.web.SchemeAccessor.SchemeMutator, org.refcodes.web.SchemeAccessor.SchemeProperty, 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 Implementing Classes:

AbstractRestfulHttpRegistryServerDecorator

public interface RestfulHttpRegistryServer<DESC extends HttpServerDescriptor,B extends RestfulHttpRegistryServer<DESC,B>>
extends HttpRegistry<DESC,B>, RestfulHttpServer, PingRequestObserver, PingRequestObserverAccessor, PingRequestObserverAccessor.PingRequestObserverBuilder<B>

The RestfulHttpRegistryServer 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.web.BaseLocatorAccessor

org.refcodes.web.BaseLocatorAccessor.BaseLocatorBuilder<B extends org.refcodes.web.BaseLocatorAccessor.BaseLocatorBuilder<B>>, org.refcodes.web.BaseLocatorAccessor.BaseLocatorMutator, org.refcodes.web.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 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.ConnectionComponent

org.refcodes.component.ConnectionComponent.ConnectionAutomaton<CON extends Object>, org.refcodes.component.ConnectionComponent.ConnectionComponentBuilder<CON extends 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 Object>, org.refcodes.component.ConnectionOpenable.ConnectionOpenBuilder<CON extends 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.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.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.web.MediaTypeFactoryLookup

org.refcodes.web.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.OpenedAccessor

org.refcodes.component.OpenedAccessor.OpenedMutator, org.refcodes.component.OpenedAccessor.OpenedProperty

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.web.RealmAccessor

org.refcodes.web.RealmAccessor.RealmBuilder<B extends org.refcodes.web.RealmAccessor.RealmBuilder<B>>, org.refcodes.web.RealmAccessor.RealmMutator, org.refcodes.web.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.web.SchemeAccessor

org.refcodes.web.SchemeAccessor.SchemeBuilder<B extends org.refcodes.web.SchemeAccessor.SchemeBuilder<B>>, org.refcodes.web.SchemeAccessor.SchemeMutator, org.refcodes.web.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.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.
void	initialize(String aAlias, String aInstanceId, org.refcodes.data.Scheme aScheme, String aHost, String aVirtualHost, int[] aIpAddress, int aPort, String aPingPath, RestRequestConsumer aPingRequestObserver, org.refcodes.web.Url aRegistryUrl)	Initializes the RestfulHttpRegistryServer 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, RestRequestConsumer aPingRequestObserver, org.refcodes.web.Url aRegistryUrl)	Initializes the RestfulHttpRegistryServer 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(org.refcodes.data.Scheme aScheme)

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.web.BaseLocatorAccessor

getBaseLocator

Methods inherited from interface org.refcodes.web.BaseLocatorAccessor.BaseLocatorMutator

setBaseLocator

Methods inherited from interface org.refcodes.web.BaseLocatorAccessor.BaseLocatorProperty

letBaseLocator

Methods inherited from interface org.refcodes.web.BasicAuthObservable

onBasicAuthRequest

Methods inherited from interface org.refcodes.component.Closable

close, closeIn, closeQuietly, closeUnchecked

Methods inherited from interface org.refcodes.component.Closable.CloseBuilder

withCloseUnchecked

Methods inherited from interface org.refcodes.component.Configurable

initializeUnchecked

Methods inherited from interface org.refcodes.component.ConnectionOpenable

openUnchecked

Methods inherited from interface org.refcodes.component.ConnectionOpenable.ConnectionOpenBuilder

withOpenUnchecked

Methods inherited from interface org.refcodes.component.ConnectionStatusAccessor

getConnectionStatus, isOpened

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.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.HttpExceptionHandlerAccessor.HttpExceptionHandlerProperty

letHttpExceptionHandler

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.HttpExceptionHandlingAccessor.HttpExceptionHandlingProperty

letHttpExceptionHandling

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.HttpRegistryUrlAccessor.HttpRegistryUrlProperty

letHttpRegistryUrl

Methods inherited from interface org.refcodes.web.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.HttpServerDescriptorAccessor.HttpServerDescriptorProperty

letHttpServerDescriptor

Methods inherited from interface org.refcodes.rest.HttpServerDescriptorFactory

toHttpServerDescriptor, toHttpServerDescriptor, toHttpServerDescriptor, toHttpServerDescriptor, toHttpServerDescriptor

Methods inherited from interface org.refcodes.web.HttpServerInterceptable

addHttpInterceptor, hasHttpInterceptor, removeHttpInterceptor

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.net.IpAddressAccessor

getIpAddress, toCidrNotation

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

fromCidrNotation, setIpAddress

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

letIpAddress

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.security.KeyStoreDescriptorAccessor.KeyStoreDescriptorProperty

letKeyStoreDescriptor

Methods inherited from interface org.refcodes.component.LifecycleStatusAccessor

getLifecycleStatus

Methods inherited from interface org.refcodes.io.MaxConnectionsAccessor

getMaxConnections

Methods inherited from interface org.refcodes.io.MaxConnectionsAccessor.MaxConnectionsMutator

setMaxConnections

Methods inherited from interface org.refcodes.io.MaxConnectionsAccessor.MaxConnectionsProperty

letMaxConnections

Methods inherited from interface org.refcodes.web.MediaTypeFactoryLookup

getFactoryMediaTypes, hasMediaTypeFactory, toMediaTypeFactory

Methods inherited from interface org.refcodes.web.MediaTypeFactoryLookup.MutableMediaTypeFactoryLookup

addMediaTypeFactory

Methods inherited from interface org.refcodes.observer.Observable

hasObserver, subscribeObserver, unsubscribeObserver

Methods inherited from interface org.refcodes.observer.Observers

disableObservers, enableObservers, isObserversActive, observers, setObserversActive

Methods inherited from interface org.refcodes.component.Openable

openUnchecked

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.rest.PingRequestObserver

onPingRequest

Methods inherited from interface org.refcodes.rest.PingRequestObserverAccessor

getPingRequestObserver

Methods inherited from interface org.refcodes.mixin.PortAccessor

getPort

Methods inherited from interface org.refcodes.mixin.PortAccessor.PortMutator

setPort

Methods inherited from interface org.refcodes.mixin.PortAccessor.PortProperty

letPort

Methods inherited from interface org.refcodes.web.PostHttpInterceptable

addPostHttpInterceptor, hasPostHttpInterceptor, removePostHttpInterceptor

Methods inherited from interface org.refcodes.web.PreHttpInterceptable

addPreHttpInterceptor, hasPreHttpInterceptor, removePreHttpInterceptor

Methods inherited from interface org.refcodes.web.RealmAccessor

getRealm

Methods inherited from interface org.refcodes.web.RealmAccessor.RealmMutator

setRealm

Methods inherited from interface org.refcodes.web.RealmAccessor.RealmProperty

letRealm

Methods inherited from interface org.refcodes.rest.RestfulHttpServer

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 org.refcodes.rest.RestfulServer

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

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.web.SchemeAccessor

getScheme, toProtocol

Methods inherited from interface org.refcodes.web.SchemeAccessor.SchemeMutator

setProtocol, setScheme

Methods inherited from interface org.refcodes.web.SchemeAccessor.SchemeProperty

letProtocol, letScheme

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 Details

withPort

default B withPort(int aPort)

Specified by:

withPort in interface org.refcodes.mixin.PortAccessor.PortBuilder<DESC extends HttpServerDescriptor>

Specified by:

withPort in interface RestfulHttpServer

withScheme

default B withScheme(org.refcodes.data.Scheme aScheme)

Specified by:

withScheme in interface RestfulHttpServer

Specified by:

withScheme in interface org.refcodes.web.SchemeAccessor.SchemeBuilder<DESC extends HttpServerDescriptor>

withProtocol

default B withProtocol(String aProtocol)

Specified by:

withProtocol in interface RestfulHttpServer

Specified by:

withProtocol in interface org.refcodes.web.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,
 org.refcodes.data.Scheme aScheme,
 String aHost,
 String aVirtualHost,
 int[] aIpAddress,
 int aPort,
 String aPingPath,
 RestRequestConsumer aPingRequestObserver,
 org.refcodes.web.Url aRegistryUrl)
                 throws org.refcodes.component.InitializeException

Initializes the RestfulHttpRegistryServer 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:

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(String aAlias,
 String aInstanceId,
 org.refcodes.data.Scheme aScheme,
 String aHost,
 String aVirtualHost,
 int[] aIpAddress,
 int aPort,
 String aPingPath,
 RestRequestConsumer aPingRequestObserver,
 org.refcodes.web.Url aRegistryUrl)
         throws org.refcodes.component.InitializeException

Initializes the RestfulHttpRegistryServer 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:

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 registered RestEndpoint instances (observers) (e.g. via RestfulServer.onRequest(org.refcodes.web.HttpMethod, String, RestRequestConsumer), RestfulServer.onGet(String, RestRequestConsumer) RestfulServer.onPut(String, RestRequestConsumer), RestfulServer.onPut(String, RestRequestConsumer) or RestfulServer.onDelete(String, RestRequestConsumer)) are enabled by calling Observers.enableObservers(). If necessary, the connection is opened via RestfulHttpServer.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 RestfulHttpRegistryServer<DESC,B>>

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. The registered RestEndpoint instances (observers) (e.g. via RestEndpointBuilder being registered e.g. via RestfulServer.onRequest(org.refcodes.web.HttpMethod, String, RestRequestConsumer), RestfulServer.onGet(String, RestRequestConsumer) RestfulServer.onPut(String, RestRequestConsumer), RestfulServer.onPut(String, RestRequestConsumer) or RestfulServer.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 RestfulHttpRegistryServer<DESC,B>>

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. The registered RestEndpoint instances (observers) (e.g. via RestEndpointBuilder being registered e.g. via RestfulServer.onRequest(org.refcodes.web.HttpMethod, String, RestRequestConsumer), RestfulServer.onGet(String, RestRequestConsumer) RestfulServer.onPut(String, RestRequestConsumer), RestfulServer.onPut(String, RestRequestConsumer) or RestfulServer.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 RestfulHttpRegistryServer<DESC,B>>

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. The registered RestEndpoint instances (observers) (e.g. via RestfulServer.onRequest(org.refcodes.web.HttpMethod, String, RestRequestConsumer), RestfulServer.onGet(String, RestRequestConsumer) RestfulServer.onPut(String, RestRequestConsumer), RestfulServer.onPut(String, RestRequestConsumer) or RestfulServer.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 RestfulHttpRegistryServer<DESC,B>>

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. The registered RestEndpoint instances (observers) (e.g. via RestfulServer.onRequest(org.refcodes.web.HttpMethod, String, RestRequestConsumer), RestfulServer.onGet(String, RestRequestConsumer) RestfulServer.onPut(String, RestRequestConsumer), RestfulServer.onPut(String, RestRequestConsumer) or RestfulServer.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 org.refcodes.component.Destroyable

Specified by:

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