Package org.ivoa.dm.executionbroker

Class DockerNetworkPort

java.lang.Object
org.ivoa.dm.executionbroker.DockerNetworkPort
All Implemented Interfaces:
org.ivoa.vodml.jpa.JPAManipulations, org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
@Entity @VoDml(id="execbroker:DockerNetworkPort", role=objectType) public class DockerNetworkPort extends Object implements org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
Details of a network port on the container made available for connection from outside. objectType: DockerNetworkPort

  • Field Details

    • _id

      protected Long _id
      inserted database key

    • access

      @VoDml(id="execbroker:DockerNetworkPort.access", role=attribute, type="ivoa:boolean", typeRole=primitiveType) protected Boolean access
      A flag to indicate whether this port should be listed in the access methods for the execution. : Attribute access : multiplicity 1

    • internal

      @VoDml(id="execbroker:DockerNetworkPort.internal", role=attribute, type="execbroker:DockerInternalPort", typeRole=dataType) protected DockerInternalPort internal
      . : Attribute internal : multiplicity 1

    • external

      @VoDml(id="execbroker:DockerNetworkPort.external", role=attribute, type="execbroker:DockerExternalPort", typeRole=dataType) protected DockerExternalPort external
      . : Attribute external : multiplicity 1

    • protocol

      @VoDml(id="execbroker:DockerNetworkPort.protocol", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String protocol
      The network protocol to use, typically one of [UDP, TCP, HTTP, HTTPS], with a default of `TCP`. This should be defined as part of the description of the executable supplied by the client. The `HTTP` and `HTTPS` values further specify the protocol to use on top of `TCP`. Specifying `HTTPS` may help to meet firewall restrictions at some sites. : Attribute protocol : multiplicity 1

    • path

      @VoDml(id="execbroker:DockerNetworkPort.path", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String path
      The path component of an access URL. This should be defined as part of the description of the executable supplied by the client. This can be used to provide the path of a notebook within a JupyterNotebook container. : Attribute path : multiplicity 1

  • Constructor Details

    • DockerNetworkPort

      public DockerNetworkPort()
      Creates a new DockerNetworkPort

    • DockerNetworkPort

      public DockerNetworkPort(Boolean access, DockerInternalPort internal, DockerExternalPort external, String protocol, String path)
      full parameter constructor.
      Parameters:
      access - A flag to indicate whether this port should be listed in the access methods for the execution.
      internal - .
      external - .
      protocol - The network protocol to use, typically one of [UDP, TCP, HTTP, HTTPS], with a default of `TCP`. This should be defined as part of the description of the executable supplied by the client. The `HTTP` and `HTTPS` values further specify the protocol to use on top of `TCP`. Specifying `HTTPS` may help to meet firewall restrictions at some sites.
      path - The path component of an access URL. This should be defined as part of the description of the executable supplied by the client. This can be used to provide the path of a notebook within a JupyterNotebook container.

    • DockerNetworkPort

      public DockerNetworkPort(DockerNetworkPort other)
      Copy Constructor. Note that references will remain as is rather than be copied.
      Parameters:
      other - the object to be copied.

  • Method Details

    • getId

      public Long getId()
      Specified by:
      getId in interface org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
      Returns:
      the id

    • updateUsing

      public void updateUsing(DockerNetworkPort other)
      Update this object with the content of the given object. Note that references will remain as is rather than be copied.
      Parameters:
      other - the object to be copied.

    • getAccess

      public Boolean getAccess()
      Returns access Attribute.
      Returns:
      access Attribute

    • setAccess

      public void setAccess(Boolean pAccess)
      Set access Attribute.
      Parameters:
      pAccess - value to set

    • withAccess

      public DockerNetworkPort withAccess(Boolean pAccess)
      fluent setter for access Attribute.
      Parameters:
      pAccess - value to set
      Returns:
      DockerNetworkPort

    • getInternal

      public DockerInternalPort getInternal()
      Returns internal Attribute.
      Returns:
      internal Attribute

    • setInternal

      public void setInternal(DockerInternalPort pInternal)
      Set internal Attribute.
      Parameters:
      pInternal - value to set

    • withInternal

      public DockerNetworkPort withInternal(DockerInternalPort pInternal)
      fluent setter for internal Attribute.
      Parameters:
      pInternal - value to set
      Returns:
      DockerNetworkPort

    • getExternal

      public DockerExternalPort getExternal()
      Returns external Attribute.
      Returns:
      external Attribute

    • setExternal

      public void setExternal(DockerExternalPort pExternal)
      Set external Attribute.
      Parameters:
      pExternal - value to set

    • withExternal

      public DockerNetworkPort withExternal(DockerExternalPort pExternal)
      fluent setter for external Attribute.
      Parameters:
      pExternal - value to set
      Returns:
      DockerNetworkPort

    • getProtocol

      public String getProtocol()
      Returns protocol Attribute.
      Returns:
      protocol Attribute

    • setProtocol

      public void setProtocol(String pProtocol)
      Set protocol Attribute.
      Parameters:
      pProtocol - value to set

    • withProtocol

      public DockerNetworkPort withProtocol(String pProtocol)
      fluent setter for protocol Attribute.
      Parameters:
      pProtocol - value to set
      Returns:
      DockerNetworkPort

    • getPath

      public String getPath()
      Returns path Attribute.
      Returns:
      path Attribute

    • setPath

      public void setPath(String pPath)
      Set path Attribute.
      Parameters:
      pPath - value to set

    • withPath

      public DockerNetworkPort withPath(String pPath)
      fluent setter for path Attribute.
      Parameters:
      pPath - value to set
      Returns:
      DockerNetworkPort

    • createDockerNetworkPort

      public static DockerNetworkPort createDockerNetworkPort(Consumer<DockerNetworkPort.DockerNetworkPortBuilder> f)
      create a DockerNetworkPort in functional builder style.
      Parameters:
      f - the functional builder.
      Returns:
      an object initialized from the builder.

    • forceLoad

      public void forceLoad()
      Specified by:
      forceLoad in interface org.ivoa.vodml.jpa.JPAManipulations

    • delete

      public void delete(jakarta.persistence.EntityManager em)
      Specified by:
      delete in interface org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>