Interface WSConnectionSpec

  • All Known Subinterfaces:
    JDBCConnectionSpec

    public interface WSConnectionSpec

    Enables connections to be requested and matched based on additional attributes.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getCatalog()
      Get the catalog name.
      int getHoldability()
      Get the cursor holdability value.
      int getNetworkTimeout()
      Gets the requested network timeout.
      java.lang.String getPassword()
      Get the password.
      java.lang.String getSchema()
      Gets the requested schema.
      java.util.Map getTypeMap()
      Get the type map, which is used for the custom mapping of SQL structured types and distinct types.
      java.lang.String getUserName()
      Get the user name.
      java.lang.Boolean isReadOnly()
      Get the read-only indicator for the database.
      void setCatalog​(java.lang.String catalog)
      Set the catalog name.
      void setHoldability​(int holdability)
      Sets the cursor holdability value.
      void setNetworkTimeout​(int networkTimeout)
      Sets the requested network timeout.
      void setPassword​(java.lang.String pwd)
      Set the password.
      void setReadOnly​(java.lang.Boolean readOnly)
      Indicate whether the connection is read only.
      void setSchema​(java.lang.String schema)
      Sets the requested schema.
      void setTypeMap​(java.util.Map map)
      Set the type map for this connection.
      void setUserName​(java.lang.String userName)
      Set the user name.
    • Method Detail

      • getCatalog

        java.lang.String getCatalog()
        Get the catalog name.
        Returns:
        the catalog name.
      • getPassword

        java.lang.String getPassword()
        Get the password.
        Returns:
        the password.
      • getTypeMap

        java.util.Map getTypeMap()
        Get the type map, which is used for the custom mapping of SQL structured types and distinct types.
        Returns:
        the type map.
      • getHoldability

        int getHoldability()

        Get the cursor holdability value. 0 indicates to use the JDBC driver's default.

        Returns:
        the cursor holdability.
      • getUserName

        java.lang.String getUserName()
        Get the user name.
        Returns:
        the user name.
      • isReadOnly

        java.lang.Boolean isReadOnly()
        Get the read-only indicator for the database.
        Returns:
        true if the connection is read only; otherwise false. Value will be null if the readOnly property was never set, which means the database default will be used.
      • getSchema

        java.lang.String getSchema()
        Gets the requested schema.
        Returns:
        the schema.
      • getNetworkTimeout

        int getNetworkTimeout()
        Gets the requested network timeout.
        Returns:
        the network timeout.
      • setCatalog

        void setCatalog​(java.lang.String catalog)
        Set the catalog name. A value of null indicates to use the database default.
        Parameters:
        catalog - the catalog name.
      • setPassword

        void setPassword​(java.lang.String pwd)
        Set the password.
        Parameters:
        pwd - the password.
      • setReadOnly

        void setReadOnly​(java.lang.Boolean readOnly)
        Indicate whether the connection is read only. A value of null indicates to use the database default.
        Parameters:
        readOnly - a flag indicating whether the connection is read only.
      • setTypeMap

        void setTypeMap​(java.util.Map map)
        Set the type map for this connection. The type map is used for the custom mapping of SQL structured types and distinct types. A value of null indicates to use the database default.
        Parameters:
        map - the type map.
      • setUserName

        void setUserName​(java.lang.String userName)
        Set the user name.
        Parameters:
        userName - the user name.
      • setHoldability

        void setHoldability​(int holdability)
        Sets the cursor holdability value. A value of 0 indicates to use the JDBC driver's default. If the JDBC driver doesn't support setting the cursor holdability via the JDBC spec-defined mechanism, you can set the holdability value to 0.
        Parameters:
        holdability - the cursor holdability
      • setSchema

        void setSchema​(java.lang.String schema)
        Sets the requested schema.
        Parameters:
        schema - the schema.
      • setNetworkTimeout

        void setNetworkTimeout​(int networkTimeout)
        Sets the requested network timeout.
        Parameters:
        networkTimeout - the network timeout.