Package org.ivoa.dm.regtap

Class Interface

java.lang.Object
org.ivoa.dm.regtap.Interface
All Implemented Interfaces:
org.ivoa.vodml.jpa.JPAManipulations, org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
@Entity @VoDml(id="RegTAP:Interface", role=objectType) public class Interface extends Object implements org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
Information on access modes of a capability. objectType: Interface

  • Field Details

    • _id

      protected Long _id
      inserted database key

    • cap_index

      @VoDml(id="RegTAP:Interface.cap_index", role=attribute, type="ivoa:nonnegativeInteger", typeRole=primitiveType) protected Integer cap_index
      The index of the parent capability. : Attribute cap_index : multiplicity 1

    • intf_index

      @VoDml(id="RegTAP:Interface.intf_index", role=attribute, type="ivoa:nonnegativeInteger", typeRole=primitiveType) protected Integer intf_index
      An arbitrary identifier for the interfaces of a resource. : Attribute intf_index : multiplicity 1

    • intf_type

      @VoDml(id="RegTAP:Interface.intf_type", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String intf_type
      The type of the interface (vr:webbrowser, vs:paramhttp, etc). : Attribute intf_type : multiplicity 1

    • intf_role

      @VoDml(id="RegTAP:Interface.intf_role", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String intf_role
      An identifier for the role the interface plays in the particular capability. If the value is equal to 'std' or begins with 'std:', then the interface refers to a standard interface defined by the standard referred to by the capability's standardID attribute. : Attribute intf_role : multiplicity 1

    • std_version

      @VoDml(id="RegTAP:Interface.std_version", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String std_version
      The version of a standard interface specification that this interface complies with. When the interface is provided in the context of a Capability element, then the standard being refered to is the one identified by the Capability's standardID element. : Attribute std_version : multiplicity 1

    • query_type

      @VoDml(id="RegTAP:Interface.query_type", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String query_type
      Hash-joined list of expected HTTP method (get or post) supported by the service. : Attribute query_type : multiplicity 1

    • result_type

      @VoDml(id="RegTAP:Interface.result_type", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String result_type
      The MIME type of a document returned in the HTTP response. : Attribute result_type : multiplicity 1

    • wsdl_url

      @VoDml(id="RegTAP:Interface.wsdl_url", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String wsdl_url
      The location of the WSDL that describes this Web Service. If NULL, the location can be assumed to be the accessURL with '?wsdl' appended. : Attribute wsdl_url : multiplicity 0..1

    • url_use

      @VoDml(id="RegTAP:Interface.url_use", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String url_use
      A flag indicating whether this should be interpreted as a base URL ('base'), a full URL ('full'), or a URL to a directory that will produce a listing of files ('dir'). : Attribute url_use : multiplicity 1

    • access_url

      @VoDml(id="RegTAP:Interface.access_url", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String access_url
      The URL at which the interface is found. : Attribute access_url : multiplicity 1

    • mirror_url

      @VoDml(id="RegTAP:Interface.mirror_url", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String mirror_url
      Secondary access URLs of this interface, separated by hash characters. : Attribute mirror_url : multiplicity 1

    • authenticated_only

      @VoDml(id="RegTAP:Interface.authenticated_only", role=attribute, type="ivoa:integer", typeRole=primitiveType) protected Integer authenticated_only
      A flag for whether an interface is available for anonymous use (=0) or only authenticated clients are served (=1). : Attribute authenticated_only : multiplicity 1

  • Constructor Details

    • Interface

      public Interface()
      Creates a new Interface

    • Interface

      public Interface(Integer cap_index, Integer intf_index, String intf_type, String intf_role, String std_version, String query_type, String result_type, String wsdl_url, String url_use, String access_url, String mirror_url, Integer authenticated_only)
      full parameter constructor.
      Parameters:
      cap_index - The index of the parent capability.
      intf_index - An arbitrary identifier for the interfaces of a resource.
      intf_type - The type of the interface (vr:webbrowser, vs:paramhttp, etc).
      intf_role - An identifier for the role the interface plays in the particular capability. If the value is equal to 'std' or begins with 'std:', then the interface refers to a standard interface defined by the standard referred to by the capability's standardID attribute.
      std_version - The version of a standard interface specification that this interface complies with. When the interface is provided in the context of a Capability element, then the standard being refered to is the one identified by the Capability's standardID element.
      query_type - Hash-joined list of expected HTTP method (get or post) supported by the service.
      result_type - The MIME type of a document returned in the HTTP response.
      wsdl_url - The location of the WSDL that describes this Web Service. If NULL, the location can be assumed to be the accessURL with '?wsdl' appended.
      url_use - A flag indicating whether this should be interpreted as a base URL ('base'), a full URL ('full'), or a URL to a directory that will produce a listing of files ('dir').
      access_url - The URL at which the interface is found.
      mirror_url - Secondary access URLs of this interface, separated by hash characters.
      authenticated_only - A flag for whether an interface is available for anonymous use (=0) or only authenticated clients are served (=1).

    • Interface

      public Interface(Interface 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(Interface 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.

    • getCap_index

      public Integer getCap_index()
      Returns cap_index Attribute.
      Returns:
      cap_index Attribute

    • setCap_index

      public void setCap_index(Integer pCap_index)
      Set cap_index Attribute.
      Parameters:
      pCap_index - value to set

    • withCap_index

      public Interface withCap_index(Integer pCap_index)
      fluent setter for cap_index Attribute.
      Parameters:
      pCap_index - value to set
      Returns:
      Interface

    • getIntf_index

      public Integer getIntf_index()
      Returns intf_index Attribute.
      Returns:
      intf_index Attribute

    • setIntf_index

      public void setIntf_index(Integer pIntf_index)
      Set intf_index Attribute.
      Parameters:
      pIntf_index - value to set

    • withIntf_index

      public Interface withIntf_index(Integer pIntf_index)
      fluent setter for intf_index Attribute.
      Parameters:
      pIntf_index - value to set
      Returns:
      Interface

    • getIntf_type

      public String getIntf_type()
      Returns intf_type Attribute.
      Returns:
      intf_type Attribute

    • setIntf_type

      public void setIntf_type(String pIntf_type)
      Set intf_type Attribute.
      Parameters:
      pIntf_type - value to set

    • withIntf_type

      public Interface withIntf_type(String pIntf_type)
      fluent setter for intf_type Attribute.
      Parameters:
      pIntf_type - value to set
      Returns:
      Interface

    • getIntf_role

      public String getIntf_role()
      Returns intf_role Attribute.
      Returns:
      intf_role Attribute

    • setIntf_role

      public void setIntf_role(String pIntf_role)
      Set intf_role Attribute.
      Parameters:
      pIntf_role - value to set

    • withIntf_role

      public Interface withIntf_role(String pIntf_role)
      fluent setter for intf_role Attribute.
      Parameters:
      pIntf_role - value to set
      Returns:
      Interface

    • getStd_version

      public String getStd_version()
      Returns std_version Attribute.
      Returns:
      std_version Attribute

    • setStd_version

      public void setStd_version(String pStd_version)
      Set std_version Attribute.
      Parameters:
      pStd_version - value to set

    • withStd_version

      public Interface withStd_version(String pStd_version)
      fluent setter for std_version Attribute.
      Parameters:
      pStd_version - value to set
      Returns:
      Interface

    • getQuery_type

      public String getQuery_type()
      Returns query_type Attribute.
      Returns:
      query_type Attribute

    • setQuery_type

      public void setQuery_type(String pQuery_type)
      Set query_type Attribute.
      Parameters:
      pQuery_type - value to set

    • withQuery_type

      public Interface withQuery_type(String pQuery_type)
      fluent setter for query_type Attribute.
      Parameters:
      pQuery_type - value to set
      Returns:
      Interface

    • getResult_type

      public String getResult_type()
      Returns result_type Attribute.
      Returns:
      result_type Attribute

    • setResult_type

      public void setResult_type(String pResult_type)
      Set result_type Attribute.
      Parameters:
      pResult_type - value to set

    • withResult_type

      public Interface withResult_type(String pResult_type)
      fluent setter for result_type Attribute.
      Parameters:
      pResult_type - value to set
      Returns:
      Interface

    • getWsdl_url

      public String getWsdl_url()
      Returns wsdl_url Attribute.
      Returns:
      wsdl_url Attribute

    • setWsdl_url

      public void setWsdl_url(String pWsdl_url)
      Set wsdl_url Attribute.
      Parameters:
      pWsdl_url - value to set

    • withWsdl_url

      public Interface withWsdl_url(String pWsdl_url)
      fluent setter for wsdl_url Attribute.
      Parameters:
      pWsdl_url - value to set
      Returns:
      Interface

    • getUrl_use

      public String getUrl_use()
      Returns url_use Attribute.
      Returns:
      url_use Attribute

    • setUrl_use

      public void setUrl_use(String pUrl_use)
      Set url_use Attribute.
      Parameters:
      pUrl_use - value to set

    • withUrl_use

      public Interface withUrl_use(String pUrl_use)
      fluent setter for url_use Attribute.
      Parameters:
      pUrl_use - value to set
      Returns:
      Interface

    • getAccess_url

      public String getAccess_url()
      Returns access_url Attribute.
      Returns:
      access_url Attribute

    • setAccess_url

      public void setAccess_url(String pAccess_url)
      Set access_url Attribute.
      Parameters:
      pAccess_url - value to set

    • withAccess_url

      public Interface withAccess_url(String pAccess_url)
      fluent setter for access_url Attribute.
      Parameters:
      pAccess_url - value to set
      Returns:
      Interface

    • getMirror_url

      public String getMirror_url()
      Returns mirror_url Attribute.
      Returns:
      mirror_url Attribute

    • setMirror_url

      public void setMirror_url(String pMirror_url)
      Set mirror_url Attribute.
      Parameters:
      pMirror_url - value to set

    • withMirror_url

      public Interface withMirror_url(String pMirror_url)
      fluent setter for mirror_url Attribute.
      Parameters:
      pMirror_url - value to set
      Returns:
      Interface

    • getAuthenticated_only

      public Integer getAuthenticated_only()
      Returns authenticated_only Attribute.
      Returns:
      authenticated_only Attribute

    • setAuthenticated_only

      public void setAuthenticated_only(Integer pAuthenticated_only)
      Set authenticated_only Attribute.
      Parameters:
      pAuthenticated_only - value to set

    • withAuthenticated_only

      public Interface withAuthenticated_only(Integer pAuthenticated_only)
      fluent setter for authenticated_only Attribute.
      Parameters:
      pAuthenticated_only - value to set
      Returns:
      Interface

    • createInterface

      public static Interface createInterface(Consumer<Interface.InterfaceBuilder> f)
      create a Interface 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>