Package org.refcodes.rest

Class AbstractHttpRegistrySidecar<DESC extends HttpServerDescriptor,B extends HttpRegistrySidecar<DESC,B>>

  • All Implemented Interfaces:
    org.refcodes.component.Configurable<DESC>, org.refcodes.component.Destroyable, org.refcodes.component.Destroyable.DestroyAutomaton, org.refcodes.component.Initializable, org.refcodes.component.Initializable.InitializeAutomaton, org.refcodes.component.InitializedAccessor, org.refcodes.component.LifeCycleComponent, org.refcodes.component.LifeCycleComponent.LifeCycleAutomaton, org.refcodes.component.LifeCycleStatusAccessor, org.refcodes.component.Pausable, org.refcodes.component.Pausable.PauseAutomaton, org.refcodes.component.Resumable, org.refcodes.component.Resumable.ResumeAutomaton, org.refcodes.component.RunningAccessor, org.refcodes.component.Startable, org.refcodes.component.Startable.StartAutomaton, org.refcodes.component.Stoppable, org.refcodes.component.Stoppable.StopAutomaton, org.refcodes.mixin.AliasAccessor, org.refcodes.mixin.AliasAccessor.AliasBuilder<DESC>, org.refcodes.mixin.AliasAccessor.AliasMutator, org.refcodes.mixin.AliasAccessor.AliasProperty, org.refcodes.mixin.InstanceIdAccessor, org.refcodes.mixin.InstanceIdAccessor.InstanceIdBuilder<DESC>, org.refcodes.mixin.InstanceIdAccessor.InstanceIdMutator, org.refcodes.mixin.InstanceIdAccessor.InstanceIdProperty, org.refcodes.mixin.PortAccessor, org.refcodes.mixin.PortAccessor.PortBuilder<DESC>, org.refcodes.mixin.PortAccessor.PortMutator, org.refcodes.mixin.PortAccessor.PortProperty, org.refcodes.net.HostAccessor, org.refcodes.net.HostAccessor.HostBuilder<DESC>, org.refcodes.net.HostAccessor.HostMutator, org.refcodes.net.HostAccessor.HostProperty, org.refcodes.net.IpAddressAccessor, org.refcodes.net.IpAddressAccessor.IpAddressBuilder<DESC>, org.refcodes.net.IpAddressAccessor.IpAddressMutator, org.refcodes.net.IpAddressAccessor.IpAddressProperty, org.refcodes.net.SchemeAccessor, org.refcodes.net.SchemeAccessor.SchemeBuilder<DESC>, org.refcodes.net.SchemeAccessor.SchemeMutator, org.refcodes.net.SchemeAccessor.SchemeProperty, org.refcodes.net.VirtualHostAccessor, org.refcodes.net.VirtualHostAccessor.VirtualHostBuilder<DESC>, org.refcodes.net.VirtualHostAccessor.VirtualHostMutator, org.refcodes.net.VirtualHostAccessor.VirtualHostProperty, HttpRegistry<DESC,B>, HttpRegistrySidecar<DESC,B>, HttpRegistryUrlAccessor, HttpRegistryUrlAccessor.HttpRegistryUrlBuilder<DESC>, HttpRegistryUrlAccessor.HttpRegistryUrlMutator, HttpRegistryUrlAccessor.HttpRegistryUrlProperty, HttpServerDescriptorAccessor<DESC>, HttpServerDescriptorAccessor.HttpServerDescriptorBuilder<DESC,B>, HttpServerDescriptorAccessor.HttpServerDescriptorMutator<DESC>, HttpServerDescriptorAccessor.HttpServerDescriptorProperty<DESC>, HttpServerDescriptorFactory<DESC>, PingPathAccessor, PingPathAccessor.PingPathBuilder<DESC>, PingPathAccessor.PingPathMutator, PingPathAccessor.PingPathProperty, org.refcodes.security.TrustStoreDescriptorAccessor, org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorBuilder<DESC>, org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorMutator, org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorProperty

    public abstract class AbstractHttpRegistrySidecar<DESC extends HttpServerDescriptor,B extends HttpRegistrySidecar<DESC,B>>
extends java.lang.Object
implements HttpRegistrySidecar<DESC,B>
    Abstract class for easily decorating a HttpRegistrySidecar.

    • Nested Class Summary

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

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

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

        org.refcodes.component.Configurable.ConfigureAutomaton<CTX extends 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.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.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.component.LifeCycleComponent

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

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

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

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

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

      • Nested classes/interfaces inherited from interface org.refcodes.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.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 Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void destroy​()
      This server is taken (removed) from the registry server.
      java.lang.String getAlias​()
      java.lang.String getHost​()
      org.refcodes.net.Url getHttpRegistryUrl​()
      Retrieves the URL from the URL property locating the service registry registry.
      DESC getHttpServerDescriptor​()
      Retrieves the HttpServerDescriptor from the HttpServerDescriptor property.
      java.lang.String getInstanceId​()
      int[] getIpAddress​()
      org.refcodes.component.LifeCycleStatus getLifeCycleStatus​()
      java.lang.String getPingPath​()
      Retrieves the ping path from the ping path property.
      org.refcodes.security.TrustStoreDescriptor getTrustStoreDescriptor​()
      java.lang.String getVirtualHost​()
      void initialize​()
      Initializes the HttpRegistry by registering it at the service registry with a status such as "starting" or "initializing" or "not-ready-yet".
      boolean isDestroyable​()
      boolean isDestroyed​()
      boolean isInitalizable​()
      boolean isInitialized​()
      boolean isPausable​()
      boolean isPaused​()
      boolean isResumable​()
      boolean isRunning​()
      boolean isStartable​()
      boolean isStoppable​()
      boolean isStopped​()
      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 setAlias​(java.lang.String aAlias)
      void setHost​(java.lang.String aHost)
      void setHttpRegistryUrl​(org.refcodes.net.Url aRegistryUrl)
      Sets the URL for the URL property locating the service registry registry.
      void setHttpServerDescriptor​(DESC aServerDescriptor)
      Sets the HttpServerDescriptor for the HttpServerDescriptor property.
      void setInstanceId​(java.lang.String aInstanceId)
      void setIpAddress​(int[] aIpAddress)
      void setPingPath​(java.lang.String aPingPath)
      Sets the ping path for the ping path property.
      void setTrustStoreDescriptor​(org.refcodes.security.TrustStoreDescriptor aStoreDescriptor)
      void setVirtualHost​(java.lang.String aVirtualHost)
      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.
      protected static java.lang.String toAlias​(java.lang.String aAlias, org.refcodes.mixin.AliasAccessor.AliasProperty aProperty)
      Resolves the property from the provided value and the provided property and the and sets the property in case the provided value is not null.
      protected static java.lang.String toHost​(java.lang.String aHost, org.refcodes.net.HostAccessor.HostProperty aProperty)
      Resolves the property from the provided value and the provided property and the and sets the property in case the provided value is not null.
      protected static org.refcodes.net.Url toHttpRegistryUrl​(org.refcodes.net.Url aRegistryUrl, HttpRegistryUrlAccessor.HttpRegistryUrlProperty aProperty)
      Resolves the property from the provided value and the provided property and the and sets the property in case the provided value is not null.
      protected static <DESC extends HttpServerDescriptor>
      DESC      		 toHttpServerDescriptor​(DESC aServerDescriptor, HttpServerDescriptorAccessor.HttpServerDescriptorProperty<DESC> aProperty)
      Resolves the property from the provided value and the provided property and the and sets the property in case the provided value is not null.
      protected static java.lang.String toInstanceId​(java.lang.String aInstanceId, java.lang.String aHost, org.refcodes.mixin.InstanceIdAccessor.InstanceIdProperty aProperty)
      Resolves the property from the provided value and the provided property and the and sets the property in case the provided value is not null.
      protected static int[] toIpAddress​(int[] aIpAddress, org.refcodes.net.IpAddressAccessor.IpAddressProperty aProperty)
      Resolves the property from the provided value and the provided property and the and sets the property in case the provided value is not null.
      protected static java.lang.String toPingPath​(java.lang.String aPingPath, java.lang.String aDefaultPingPath, PingPathAccessor.PingPathProperty aProperty)
      Resolves the property from the provided value and the provided property and the and sets the property in case the provided value is not null.
      protected static int toPort​(int aPort, org.refcodes.mixin.PortAccessor.PortProperty aProperty)
      Resolves the property from the provided value and the provided property and the and sets the property in case the provided value is not null.
      protected static org.refcodes.data.Scheme toScheme​(org.refcodes.data.Scheme aScheme, org.refcodes.net.SchemeAccessor.SchemeProperty aProperty)
      Resolves the property from the provided value and the provided property and the and sets the property in case the provided value is not null.
      protected static org.refcodes.security.TrustStoreDescriptor toTrustStoreDescriptor​(org.refcodes.security.TrustStoreDescriptor aStoreDescriptor, org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorProperty aProperty)
      Resolves the property from the provided value and the provided property and the and sets the property in case the provided value is not null.
      protected static java.lang.String toVirtualHost​(java.lang.String aVirtualHost, org.refcodes.net.VirtualHostAccessor.VirtualHostProperty aProperty)
      Resolves the property from the provided value and the provided property and the and sets the property in case the provided value is not null.

      • Methods inherited from interface org.refcodes.component.Configurable

        initializeUnchecked

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

        initializeUnchecked

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

        toCidrNotation

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

        fromCidrNotation

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

        pauseUnchecked

      • 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.component.Resumable

        resumeUnchecked

      • Methods inherited from interface org.refcodes.net.SchemeAccessor

        getScheme, toProtocol

      • Methods inherited from interface org.refcodes.net.SchemeAccessor.SchemeMutator

        setProtocol, setScheme

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

        startUnchecked

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

        stopUnchecked

    • Field Detail

      • _lifeCycleAutomaton

        protected org.refcodes.component.LifeCycleAutomatonImpl.ManualLifeCycleAutomatonImpl _lifeCycleAutomaton

    • Constructor Detail

      • AbstractHttpRegistrySidecar

        public AbstractHttpRegistrySidecar​()

    • Method Detail

      • isRunning

        public boolean isRunning​()
        Specified by:
        isRunning in interface org.refcodes.component.RunningAccessor

      • isInitialized

        public boolean isInitialized​()
        Specified by:
        isInitialized in interface org.refcodes.component.InitializedAccessor

      • getLifeCycleStatus

        public org.refcodes.component.LifeCycleStatus getLifeCycleStatus​()
        Specified by:
        getLifeCycleStatus in interface org.refcodes.component.LifeCycleStatusAccessor

      • pause

        public void pause​()
           throws org.refcodes.component.PauseException
        Some "deactivated" status is communicated to the registry server.
        Specified by:
        pause in interface HttpRegistry<DESC extends HttpServerDescriptor,B extends HttpRegistrySidecar<DESC,B>>
        Specified by:
        pause in interface org.refcodes.component.Pausable
        Throws:
        org.refcodes.component.PauseException

      • stop

        public void stop​()
          throws org.refcodes.component.StopException
        Some "out-of-order" status is communicated to the registry server. Also stops a "ping" or "heartbeat" daemon.
        Specified by:
        stop in interface HttpRegistry<DESC extends HttpServerDescriptor,B extends HttpRegistrySidecar<DESC,B>>
        Specified by:
        stop in interface org.refcodes.component.Stoppable
        Throws:
        org.refcodes.component.StopException

      • start

        public void start​()
           throws org.refcodes.component.StartException
        Some "up-and-running" status is communicated to the registry server. May also start a "ping" or "heartbeat" daemon.
        Specified by:
        start in interface HttpRegistry<DESC extends HttpServerDescriptor,B extends HttpRegistrySidecar<DESC,B>>
        Specified by:
        start in interface org.refcodes.component.Startable
        Throws:
        org.refcodes.component.StartException

      • resume

        public void resume​()
            throws org.refcodes.component.ResumeException
        Some "up-and-running (again)" status is communicated to the registry server.
        Specified by:
        resume in interface HttpRegistry<DESC extends HttpServerDescriptor,B extends HttpRegistrySidecar<DESC,B>>
        Specified by:
        resume in interface org.refcodes.component.Resumable
        Throws:
        org.refcodes.component.ResumeException

      • initialize

        public void initialize​()
                throws org.refcodes.component.InitializeException
        Initializes the HttpRegistry by registering it at the service registry with a status such as "starting" or "initializing" or "not-ready-yet".
        Specified by:
        initialize in interface HttpRegistry<DESC extends HttpServerDescriptor,B extends HttpRegistrySidecar<DESC,B>>
        Specified by:
        initialize in interface org.refcodes.component.Initializable
        Throws:
        org.refcodes.component.InitializeException

      • isStoppable

        public boolean isStoppable​()
        Specified by:
        isStoppable in interface org.refcodes.component.Stoppable.StopAutomaton

      • isPausable

        public boolean isPausable​()
        Specified by:
        isPausable in interface org.refcodes.component.Pausable.PauseAutomaton

      • isStartable

        public boolean isStartable​()
        Specified by:
        isStartable in interface org.refcodes.component.Startable.StartAutomaton

      • isResumable

        public boolean isResumable​()
        Specified by:
        isResumable in interface org.refcodes.component.Resumable.ResumeAutomaton

      • isStopped

        public boolean isStopped​()
        Specified by:
        isStopped in interface org.refcodes.component.Stoppable.StopAutomaton

      • isPaused

        public boolean isPaused​()
        Specified by:
        isPaused in interface org.refcodes.component.Pausable.PauseAutomaton

      • isInitalizable

        public boolean isInitalizable​()
        Specified by:
        isInitalizable in interface org.refcodes.component.Initializable.InitializeAutomaton

      • destroy

        public void destroy​()
        This server is taken (removed) from the registry server. Also stops a "ping" or "heartbeat" daemon. Finally the connection is closed.
        Specified by:
        destroy in interface org.refcodes.component.Destroyable
        Specified by:
        destroy in interface HttpRegistry<DESC extends HttpServerDescriptor,B extends HttpRegistrySidecar<DESC,B>>

      • isDestroyable

        public boolean isDestroyable​()
        Specified by:
        isDestroyable in interface org.refcodes.component.Destroyable.DestroyAutomaton

      • isDestroyed

        public boolean isDestroyed​()
        Specified by:
        isDestroyed in interface org.refcodes.component.Destroyable.DestroyAutomaton

      • setInstanceId

        public void setInstanceId​(java.lang.String aInstanceId)
        Specified by:
        setInstanceId in interface org.refcodes.mixin.InstanceIdAccessor.InstanceIdMutator

      • getInstanceId

        public java.lang.String getInstanceId​()
        Specified by:
        getInstanceId in interface org.refcodes.mixin.InstanceIdAccessor

      • setHost

        public void setHost​(java.lang.String aHost)
        Specified by:
        setHost in interface org.refcodes.net.HostAccessor.HostMutator

      • getHost

        public java.lang.String getHost​()
        Specified by:
        getHost in interface org.refcodes.net.HostAccessor

      • getVirtualHost

        public java.lang.String getVirtualHost​()
        Specified by:
        getVirtualHost in interface org.refcodes.net.VirtualHostAccessor

      • setVirtualHost

        public void setVirtualHost​(java.lang.String aVirtualHost)
        Specified by:
        setVirtualHost in interface org.refcodes.net.VirtualHostAccessor.VirtualHostMutator

      • getIpAddress

        public int[] getIpAddress​()
        Specified by:
        getIpAddress in interface org.refcodes.net.IpAddressAccessor

      • setIpAddress

        public void setIpAddress​(int[] aIpAddress)
        Specified by:
        setIpAddress in interface org.refcodes.net.IpAddressAccessor.IpAddressMutator

      • getTrustStoreDescriptor

        public org.refcodes.security.TrustStoreDescriptor getTrustStoreDescriptor​()
        Specified by:
        getTrustStoreDescriptor in interface org.refcodes.security.TrustStoreDescriptorAccessor

      • setTrustStoreDescriptor

        public void setTrustStoreDescriptor​(org.refcodes.security.TrustStoreDescriptor aStoreDescriptor)
        Specified by:
        setTrustStoreDescriptor in interface org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorMutator

      • getHttpRegistryUrl

        public org.refcodes.net.Url getHttpRegistryUrl​()
        Retrieves the URL from the URL property locating the service registry registry.
        Specified by:
        getHttpRegistryUrl in interface HttpRegistryUrlAccessor
        Returns:
        The URL stored by the URL property.

      • setHttpRegistryUrl

        public void setHttpRegistryUrl​(org.refcodes.net.Url aRegistryUrl)
        Sets the URL for the URL property locating the service registry registry.
        Specified by:
        setHttpRegistryUrl in interface HttpRegistryUrlAccessor.HttpRegistryUrlMutator
        Parameters:
        aRegistryUrl - The service registry registry URL to be stored by the URL property.

      • getAlias

        public java.lang.String getAlias​()
        Specified by:
        getAlias in interface org.refcodes.mixin.AliasAccessor

      • setAlias

        public void setAlias​(java.lang.String aAlias)
        Specified by:
        setAlias in interface org.refcodes.mixin.AliasAccessor.AliasMutator

      • getPingPath

        public java.lang.String getPingPath​()
        Retrieves the ping path from the ping path property.
        Specified by:
        getPingPath in interface PingPathAccessor
        Returns:
        The ping path stored by the ping path property.

      • setPingPath

        public void setPingPath​(java.lang.String aPingPath)
        Sets the ping path for the ping path property.
        Specified by:
        setPingPath in interface PingPathAccessor.PingPathMutator
        Parameters:
        aPingPath - The ping path to be stored by the ping path property.

      • toHost

        protected static java.lang.String toHost​(java.lang.String aHost,
                                         org.refcodes.net.HostAccessor.HostProperty aProperty)
                                  throws java.net.UnknownHostException
        Resolves the property from the provided value and the provided property and the and sets the property in case the provided value is not null.
        Parameters:
        aHost - The value to be used when not null.
        aProperty - The property to be used when the value is null and which is to be set when the value is not null.
        Returns:
        The value when not null, else the value of the provided property.
        Throws:
        java.net.UnknownHostException - thrown in case the local machine's host cannot be resolved when the provided host is null.

      • toVirtualHost

        protected static java.lang.String toVirtualHost​(java.lang.String aVirtualHost,
                                                org.refcodes.net.VirtualHostAccessor.VirtualHostProperty aProperty)
        Resolves the property from the provided value and the provided property and the and sets the property in case the provided value is not null.
        Parameters:
        aVirtualHost - The value to be used when not null.
        aProperty - The property to be used when the value is null and which is to be set when the value is not null.
        Returns:
        The value when not null, else the value of the provided property.

      • toIpAddress

        protected static int[] toIpAddress​(int[] aIpAddress,
                                   org.refcodes.net.IpAddressAccessor.IpAddressProperty aProperty)
                            throws java.io.IOException
        Resolves the property from the provided value and the provided property and the and sets the property in case the provided value is not null.
        Parameters:
        aIpAddress - The value to be used when not null.
        aProperty - The property to be used when the value is null and which is to be set when the value is not null.
        Returns:
        The value when not null, else the value of the provided property.
        Throws:
        java.io.IOException - thrown in case the local machine's IP-Address cannot be resolved when the provided IP-Address is null.

      • toAlias

        protected static java.lang.String toAlias​(java.lang.String aAlias,
                                          org.refcodes.mixin.AliasAccessor.AliasProperty aProperty)
        Resolves the property from the provided value and the provided property and the and sets the property in case the provided value is not null.
        Parameters:
        aAlias - The value to be used when not null.
        aProperty - The property to be used when the value is null and which is to be set when the value is not null.
        Returns:
        The value when not null, else the value of the provided property.

      • toScheme

        protected static org.refcodes.data.Scheme toScheme​(org.refcodes.data.Scheme aScheme,
                                                   org.refcodes.net.SchemeAccessor.SchemeProperty aProperty)
        Resolves the property from the provided value and the provided property and the and sets the property in case the provided value is not null.
        Parameters:
        aScheme - The value to be used when not null.
        aProperty - The property to be used when the value is null and which is to be set when the value is not null.
        Returns:
        The value when not null, else the value of the provided property.

      • toPort

        protected static int toPort​(int aPort,
                            org.refcodes.mixin.PortAccessor.PortProperty aProperty)
        Resolves the property from the provided value and the provided property and the and sets the property in case the provided value is not null.
        Parameters:
        aPort - The value to be used when not null.
        aProperty - The property to be used when the value is null and which is to be set when the value is not null.
        Returns:
        The value when not null, else the value of the provided property.

      • toInstanceId

        protected static java.lang.String toInstanceId​(java.lang.String aInstanceId,
                                               java.lang.String aHost,
                                               org.refcodes.mixin.InstanceIdAccessor.InstanceIdProperty aProperty)
        Resolves the property from the provided value and the provided property and the and sets the property in case the provided value is not null.
        Parameters:
        aInstanceId - The value to be used when not null.
        aHost - The value to be used when instance ID is null.
        aProperty - The property to be used when the value is null and which is to be set when the value is not null.
        Returns:
        The value when not null, else the value of the provided property.

      • toPingPath

        protected static java.lang.String toPingPath​(java.lang.String aPingPath,
                                             java.lang.String aDefaultPingPath,
                                             PingPathAccessor.PingPathProperty aProperty)
        Resolves the property from the provided value and the provided property and the and sets the property in case the provided value is not null.
        Parameters:
        aPingPath - The value to be used when not null.
        aDefaultPingPath - The value to be used when the ping path is null.
        aProperty - The property to be used when the value is null and which is to be set when the value is not null.
        Returns:
        The value when not null, else the value of the provided property.

      • toTrustStoreDescriptor

        protected static org.refcodes.security.TrustStoreDescriptor toTrustStoreDescriptor​(org.refcodes.security.TrustStoreDescriptor aStoreDescriptor,
                                                                                   org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorProperty aProperty)
        Resolves the property from the provided value and the provided property and the and sets the property in case the provided value is not null.
        Parameters:
        aStoreDescriptor - The value to be used when not null.
        aProperty - The property to be used when the value is null and which is to be set when the value is not null.
        Returns:
        The value when not null, else the value of the provided property.

      • toHttpRegistryUrl

        protected static org.refcodes.net.Url toHttpRegistryUrl​(org.refcodes.net.Url aRegistryUrl,
                                                        HttpRegistryUrlAccessor.HttpRegistryUrlProperty aProperty)
        Resolves the property from the provided value and the provided property and the and sets the property in case the provided value is not null.
        Parameters:
        aRegistryUrl - The value to be used when not null.
        aProperty - The property to be used when the value is null and which is to be set when the value is not null.
        Returns:
        The value when not null, else the value of the provided property.

      • toHttpServerDescriptor

        protected static <DESC extends HttpServerDescriptor> DESC toHttpServerDescriptor​(DESC aServerDescriptor,
                                                                                 HttpServerDescriptorAccessor.HttpServerDescriptorProperty<DESC> aProperty)
        Resolves the property from the provided value and the provided property and the and sets the property in case the provided value is not null.
        Type Parameters:
        DESC - The type of the server discovery descriptor (the object describing your service and locating the service registry).
        Parameters:
        aServerDescriptor - The value to be used when not null.
        aProperty - The property to be used when the value is null and which is to be set when the value is not null.
        Returns:
        The value when not null, else the value of the provided property.