Package org.refcodes.rest
Interface HttpServerDescriptorFactory<DESC extends HttpServerDescriptor>
-
- Type Parameters:
DESC
- The type of the server discovery descriptor (the object describing your service and locating the service registry).
- All Known Subinterfaces:
HttpRegistry<DESC,B>
,HttpRegistryRestServer<DESC,B>
,HttpRegistrySidecar<DESC,B>
- All Known Implementing Classes:
AbstractHttpRegistryRestServerDecorator
,AbstractHttpRegistrySidecar
public interface HttpServerDescriptorFactory<DESC extends HttpServerDescriptor>
TheHttpServerDescriptorFactory
provides factory functionality for creatingHttpServerDescriptor
instances.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default DESC
toHttpServerDescriptor()
Prepares theHttpServerDescriptor
by creating it from this instance's state and the provided arguments.default DESC
toHttpServerDescriptor(java.lang.String aAlias, java.lang.String aInstanceId, org.refcodes.data.Scheme aScheme, int aPort)
Prepares theHttpServerDescriptor
by creating it from this instance's state and the provided arguments.DESC
toHttpServerDescriptor(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)
Prepares theHttpServerDescriptor
by creating it from this instance's state and the provided arguments.default DESC
toHttpServerDescriptor(java.lang.String aAlias, org.refcodes.data.Scheme aScheme, java.lang.String aHost, int aPort)
Prepares theHttpServerDescriptor
by creating it from this instance's state and the provided arguments.default DESC
toHttpServerDescriptor(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)
Prepares theHttpServerDescriptor
by creating it from this instance's state and the provided arguments.
-
-
-
Method Detail
-
toHttpServerDescriptor
default DESC toHttpServerDescriptor()
Prepares theHttpServerDescriptor
by creating it from this instance's state and the provided arguments. The provided arguments can modify the instance's state. TheHttpServerDescriptor
as finally used is returned. You may modify this context and use it after modification to initialize the according server viaHttpRegistry.initialize(HttpServerDescriptor, Url)
orHttpRegistry.initialize(HttpServerDescriptor, Url, TrustStoreDescriptor)
.- Returns:
- The
HttpServerDescriptor
as would be used when initializing the according server viaHttpRegistry.initialize()
-
toHttpServerDescriptor
default DESC toHttpServerDescriptor(java.lang.String aAlias, java.lang.String aInstanceId, org.refcodes.data.Scheme aScheme, int aPort)
Prepares theHttpServerDescriptor
by creating it from this instance's state and the provided arguments. The provided arguments can modify the instance's state. TheHttpServerDescriptor
as finally used is returned. You may modify this context and use it after modification to initialize the according server viaHttpRegistry.initialize(HttpServerDescriptor, Url)
orHttpRegistry.initialize(HttpServerDescriptor, Url, TrustStoreDescriptor)
.- 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).aPort
- The port of your service being registered.- Returns:
- The
HttpServerDescriptor
as would be used when initializing the according server viaHttpRegistry.initialize()
-
toHttpServerDescriptor
default DESC toHttpServerDescriptor(java.lang.String aAlias, org.refcodes.data.Scheme aScheme, java.lang.String aHost, int aPort)
Prepares theHttpServerDescriptor
by creating it from this instance's state and the provided arguments. The provided arguments can modify the instance's state. TheHttpServerDescriptor
as finally used is returned. You may modify this context and use it after modification to initialize the according server viaHttpRegistry.initialize(HttpServerDescriptor, Url)
orHttpRegistry.initialize(HttpServerDescriptor, Url, TrustStoreDescriptor)
.- 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.aPort
- The port of your service being registered. Make sure, you do not- Returns:
- The
HttpServerDescriptor
as would be used when initializing the according server viaHttpRegistry.initialize()
-
toHttpServerDescriptor
default DESC toHttpServerDescriptor(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)
Prepares theHttpServerDescriptor
by creating it from this instance's state and the provided arguments. The provided arguments can modify the instance's state. TheHttpServerDescriptor
as finally used is returned. You may modify this context and use it after modification to initialize the according server viaHttpRegistry.initialize(HttpServerDescriptor, Url)
orHttpRegistry.initialize(HttpServerDescriptor, Url, TrustStoreDescriptor)
.- 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. Make sure, you do notaPingPath
- The path to use as health-check end-point by this server.- Returns:
- The
HttpServerDescriptor
as would be used when initializing the according server viaHttpRegistry.initialize()
-
toHttpServerDescriptor
DESC toHttpServerDescriptor(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)
Prepares theHttpServerDescriptor
by creating it from this instance's state and the provided arguments. The provided arguments can modify the instance's state. TheHttpServerDescriptor
as finally used is returned. You may modify this context and use it after modification to initialize the according server viaHttpRegistry.initialize(HttpServerDescriptor, Url)
orHttpRegistry.initialize(HttpServerDescriptor, Url, TrustStoreDescriptor)
.- 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. Make sure, you do notaPingPath
- The path to use as health-check end-point by this server.- Returns:
- The
HttpServerDescriptor
as would be used when initializing the according server viaHttpRegistry.initialize()
-
-