NetConnection

Documentation of 'org.apache.derby.client.net.NetConnection' Java class NetConnection

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- org.apache.derby.client.am.ClientConnection
- - org.apache.derby.client.net.NetConnection

All Implemented Interfaces:

java.lang.AutoCloseable, java.sql.Connection, java.sql.Wrapper, ConnectionCallbackInterface
```
public class NetConnection
extends ClientConnection
```

Field Summary
- Fields inherited from class org.apache.derby.client.am.ClientConnection
  agent_, autoCommit_, commBufferSize_, databaseMetaData_, databaseName_, dataSource_, portNumber_, productID_, resetConnectionAtFirstSql_, serverNameIP_, XA_T0_NOT_ASSOCIATED, XA_T1_ASSOCIATED, xaHostVersion_
- Fields inherited from interface java.sql.Connection
  TRANSACTION_NONE, TRANSACTION_READ_COMMITTED, TRANSACTION_READ_UNCOMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Close the connection and release its resources.
`java.sql.Array`	`createArrayOf(java.lang.String typeName, java.lang.Object[] elements)`
`java.sql.NClob`	`createNClob()`
`java.sql.SQLXML`	`createSQLXML()`
`java.sql.Struct`	`createStruct(java.lang.String typeName, java.lang.Object[] attributes)`
`int`	`getAGENT()`
`java.util.Properties`	`getClientInfo()` `getClientInfo` always returns an empty `Properties` object since Derby doesn't support ClientInfoProperties.
`java.lang.String`	`getClientInfo(java.lang.String name)` `getClientInfo` always returns a `null String` since Derby doesn't support ClientInfoProperties.
`int`	`getCMNTCPIP()`
`EncryptionManager`	`getEncryptionManager()`
`java.io.InputStream`	`getInputStream()`
`java.io.OutputStream`	`getOutputStream()`
`java.lang.String`	`getProductID()`
`int`	`getRDB()`
`int`	`getRSYNCMGR()`
`int`	`getSECMGR()`
`int`	`getSecurityMechanism()`
`int`	`getSQLAM()`
`int`	`getSYNCPTMGR()`
`byte[]`	`getTargetPublicKey()`
`int`	`getXAMGR()`
`boolean`	`isConnectionNull()`
`boolean`	`isOpen()` Returns if a transaction is in process
`boolean`	`isValid(int timeout)` Checks if the connection has not been closed and is still valid.
`boolean`	`isWrapperFor(java.lang.Class<?> interfaces)` Returns false unless `interfaces` is implemented
`SectionManager`	`newSectionManager(Agent agent)`
`void`	`readCommitSubstitute_()`
`void`	`readLocalCommit_()`
`void`	`readLocalRollback_()`
`void`	`readLocalXACommit_()`
`void`	`readLocalXARollback_()`
`void`	`readLocalXAStart_()`
`void`	`readTransactionStart()`
`boolean`	`serverSupportLongRDBNAM()`
`boolean`	`serverSupportsLayerBStreaming()`
`void`	`setClientInfo(java.util.Properties properties)` `setClientInfo` will throw a `SQLClientInfoException` unless the `properties` parameter is empty, since Derby does not support any properties.
`void`	`setClientInfo(java.lang.String name, java.lang.String value)` `setClientInfo` will always throw a `SQLClientInfoException` since Derby does not support any properties.
`void`	`setConnectionNull(boolean connectionNull)`
`void`	`setIndoubtTransactions(java.util.List<javax.transaction.xa.Xid> indoubtTransactions)`
`void`	`setInputStream(java.io.InputStream inputStream)`
`void`	`setOutputStream(java.io.OutputStream outputStream)`
`<T> T`	`unwrap(java.lang.Class<T> interfaces)` Returns `this` if this class implements the interface
`boolean`	`willAutoCommitGenerateFlow()`
`void`	`writeCommitSubstitute_()`
`void`	`writeLocalCommit_()`
`void`	`writeLocalRollback_()`
`void`	`writeLocalXACommit_()`
`void`	`writeLocalXARollback_()`
`void`	`writeLocalXAStart_()`
`void`	`writeTransactionStart(ClientStatement statement)`

Methods inherited from class org.apache.derby.client.am.ClientConnection
abort, clearWarnings, closeResources, commit, completeAbnormalUnitOfWork, completeAbnormalUnitOfWork, completeChainBreakingDisconnect, completeConnect, completeInitialPiggyBackIsolation, completeInitialPiggyBackSchema, completeLocalCommit, completeLocalRollback, completePiggyBackIsolation, completePiggyBackSchema, completeSqlca, createBlob, createClob, createStatement, createStatement, createStatement, flowAutoCommit, getAutoCommit, getCatalog, getCurrentSchemaName, getHoldability, getMetaData, getNetworkTimeout, getSchema, getServerVersion, getTransactionID, getTransactionIsolation, getTransactionIsolationX, getTypeMap, getWarnings, getXAState, isAborting, isClosed, isClosedX, isPhysicalConnClosed, isReadOnly, isXAConnection, lightReset, nativeSQL, prepareCall, prepareCall, prepareCall, prepareStatement, prepareStatement, prepareStatement, prepareStatement, prepareStatement, prepareStatement, releaseSavepoint, reset, rollback, rollback, setAutoCommit, setCatalog, setHoldability, setNetworkTimeout, setReadOnly, setSavepoint, setSavepoint, setSchema, setTransactionIsolation, setTypeMap, setXAState, transactionInProgress

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getSQLAM
```
public int getSQLAM()
```
  - getAGENT
```
public int getAGENT()
```
  - getCMNTCPIP
```
public int getCMNTCPIP()
```
  - getRDB
```
public int getRDB()
```
  - getSECMGR
```
public int getSECMGR()
```
  - getXAMGR
```
public int getXAMGR()
```
  - getSYNCPTMGR
```
public int getSYNCPTMGR()
```
  - getRSYNCMGR
```
public int getRSYNCMGR()
```
  - writeCommitSubstitute_
```
public void writeCommitSubstitute_()
                            throws SqlException
```
    Specified by:
    
    writeCommitSubstitute_ in class ClientConnection
    
    Throws:
    
    SqlException
  - readCommitSubstitute_
```
public void readCommitSubstitute_()
                           throws SqlException
```
    Specified by:
    
    readCommitSubstitute_ in class ClientConnection
    
    Throws:
    
    SqlException
  - writeLocalXAStart_
```
public void writeLocalXAStart_()
                        throws SqlException
```
    Specified by:
    
    writeLocalXAStart_ in class ClientConnection
    
    Throws:
    
    SqlException
  - readLocalXAStart_
```
public void readLocalXAStart_()
                       throws SqlException
```
    Specified by:
    
    readLocalXAStart_ in class ClientConnection
    
    Throws:
    
    SqlException
  - writeLocalXACommit_
```
public void writeLocalXACommit_()
                         throws SqlException
```
    Specified by:
    
    writeLocalXACommit_ in class ClientConnection
    
    Throws:
    
    SqlException
  - readLocalXACommit_
```
public void readLocalXACommit_()
                        throws SqlException
```
    Specified by:
    
    readLocalXACommit_ in class ClientConnection
    
    Throws:
    
    SqlException
  - writeLocalXARollback_
```
public void writeLocalXARollback_()
                           throws SqlException
```
    Specified by:
    
    writeLocalXARollback_ in class ClientConnection
    
    Throws:
    
    SqlException
  - readLocalXARollback_
```
public void readLocalXARollback_()
                          throws SqlException
```
    Specified by:
    
    readLocalXARollback_ in class ClientConnection
    
    Throws:
    
    SqlException
  - writeLocalCommit_
```
public void writeLocalCommit_()
                       throws SqlException
```
    Specified by:
    
    writeLocalCommit_ in class ClientConnection
    
    Throws:
    
    SqlException
  - readLocalCommit_
```
public void readLocalCommit_()
                      throws SqlException
```
    Specified by:
    
    readLocalCommit_ in class ClientConnection
    
    Throws:
    
    SqlException
  - writeLocalRollback_
```
public void writeLocalRollback_()
                         throws SqlException
```
    Specified by:
    
    writeLocalRollback_ in class ClientConnection
    
    Throws:
    
    SqlException
  - readLocalRollback_
```
public void readLocalRollback_()
                        throws SqlException
```
    Specified by:
    
    readLocalRollback_ in class ClientConnection
    
    Throws:
    
    SqlException
  - setInputStream
```
public void setInputStream(java.io.InputStream inputStream)
```
  - setOutputStream
```
public void setOutputStream(java.io.OutputStream outputStream)
```
  - getInputStream
```
public java.io.InputStream getInputStream()
```
  - getOutputStream
```
public java.io.OutputStream getOutputStream()
```
  - writeTransactionStart
```
public void writeTransactionStart(ClientStatement statement)
                           throws SqlException
```
    Overrides:
    
    writeTransactionStart in class ClientConnection
    
    Throws:
    
    SqlException
  - readTransactionStart
```
public void readTransactionStart()
                          throws SqlException
```
    Overrides:
    
    readTransactionStart in class ClientConnection
    
    Throws:
    
    SqlException
  - setIndoubtTransactions
```
public void setIndoubtTransactions(java.util.List<javax.transaction.xa.Xid> indoubtTransactions)
```
  - newSectionManager
```
public SectionManager newSectionManager(Agent agent)
```
    Specified by:
    
    newSectionManager in class ClientConnection
  - willAutoCommitGenerateFlow
```
public boolean willAutoCommitGenerateFlow()
```
    Overrides:
    
    willAutoCommitGenerateFlow in class ClientConnection
  - getSecurityMechanism
```
public int getSecurityMechanism()
```
  - getEncryptionManager
```
public EncryptionManager getEncryptionManager()
```
  - getTargetPublicKey
```
public byte[] getTargetPublicKey()
```
  - getProductID
```
public java.lang.String getProductID()
```
  - isConnectionNull
```
public final boolean isConnectionNull()
```
    Returns:
    
    Returns the connectionNull.
  - setConnectionNull
```
public void setConnectionNull(boolean connectionNull)
```
    Parameters:
    
    connectionNull - The connectionNull to set.
  - serverSupportsLayerBStreaming
```
public final boolean serverSupportsLayerBStreaming()
```
  - serverSupportLongRDBNAM
```
public final boolean serverSupportLongRDBNAM()
```
  - isOpen
```
public boolean isOpen()
```
    Returns if a transaction is in process
    
    Returns:
    
    open
  - createArrayOf
```
public java.sql.Array createArrayOf(java.lang.String typeName,
                                    java.lang.Object[] elements)
                             throws java.sql.SQLException
```
    Throws:
    
    java.sql.SQLException
  - createNClob
```
public java.sql.NClob createNClob()
                           throws java.sql.SQLException
```
    Throws:
    
    java.sql.SQLException
  - createSQLXML
```
public java.sql.SQLXML createSQLXML()
                             throws java.sql.SQLException
```
    Throws:
    
    java.sql.SQLException
  - createStruct
```
public java.sql.Struct createStruct(java.lang.String typeName,
                                    java.lang.Object[] attributes)
                             throws java.sql.SQLException
```
    Throws:
    
    java.sql.SQLException
  - isValid
```
public boolean isValid(int timeout)
                throws java.sql.SQLException
```
    Checks if the connection has not been closed and is still valid. The validity is checked by running a simple query against the database. The timeout specified by the caller is implemented as follows: On the server: uses the queryTimeout functionality to make the query time out on the server in case the server has problems or is highly loaded. On the client: uses a timeout on the socket to make sure that the client is not blocked forever in the cases where the server is "hanging" or not sending the reply.
    
    Parameters:
    
    timeout - The time in seconds to wait for the database operation used to validate the connection to complete. If the timeout period expires before the operation completes, this method returns false. A value of 0 indicates a timeout is not applied to the database operation.
    
    Returns:
    
    true if the connection is valid, false otherwise
    
    Throws:
    
    java.sql.SQLException - if the parameter value is illegal or if a database error has occurred
  - close
```
public void close()
           throws java.sql.SQLException
```
    Close the connection and release its resources.
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Specified by:
    
    close in interface java.sql.Connection
    
    Overrides:
    
    close in class ClientConnection
    
    Throws:
    
    java.sql.SQLException - if a database-access error occurs.
  - setClientInfo
```
public void setClientInfo(java.lang.String name,
                          java.lang.String value)
                   throws java.sql.SQLClientInfoException
```
    setClientInfo will always throw a SQLClientInfoException since Derby does not support any properties.
    
    Parameters:
    
    name - a property key String
    
    value - a property value String
    
    Throws:
    
    java.sql.SQLClientInfoException - always.
  - setClientInfo
```
public void setClientInfo(java.util.Properties properties)
                   throws java.sql.SQLClientInfoException
```
    setClientInfo will throw a SQLClientInfoException unless the properties parameter is empty, since Derby does not support any properties. All the property keys in the properties parameter are added to failedProperties of the exception thrown, with REASON_UNKNOWN_PROPERTY as the value.
    
    Parameters:
    
    properties - a Properties object with the properties to set.
    
    Throws:
    
    java.sql.SQLClientInfoException - unless the properties parameter is null or empty.
  - getClientInfo
```
public java.lang.String getClientInfo(java.lang.String name)
                               throws java.sql.SQLException
```
    getClientInfo always returns a null String since Derby doesn't support ClientInfoProperties.
    
    Parameters:
    
    name - a String value
    
    Returns:
    
    a null String value
    
    Throws:
    
    java.sql.SQLException - if the connection is closed.
  - getClientInfo
```
public java.util.Properties getClientInfo()
                                   throws java.sql.SQLException
```
    getClientInfo always returns an empty Properties object since Derby doesn't support ClientInfoProperties.
    
    Returns:
    
    an empty Properties object.
    
    Throws:
    
    java.sql.SQLException - if the connection is closed.
  - isWrapperFor
```
public boolean isWrapperFor(java.lang.Class<?> interfaces)
                     throws java.sql.SQLException
```
    Returns false unless interfaces is implemented
    
    Parameters:
    
    interfaces - a Class defining an interface.
    
    Returns:
    
    true if this implements the interface or directly or indirectly wraps an object that does.
    
    Throws:
    
    java.sql.SQLException - if an error occurs while determining whether this is a wrapper for an object with the given interface.
  - unwrap
```
public <T> T unwrap(java.lang.Class<T> interfaces)
             throws java.sql.SQLException
```
    Returns this if this class implements the interface
    
    Parameters:
    
    interfaces - a Class defining an interface
    
    Returns:
    
    an object that implements the interface
    
    Throws:
    
    java.sql.SQLException - if no object if found that implements the interface

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Class NetConnection

Field Summary

Fields inherited from class org.apache.derby.client.am.ClientConnection

Fields inherited from interface java.sql.Connection

Method Summary

Methods inherited from class org.apache.derby.client.am.ClientConnection

Methods inherited from class java.lang.Object

Method Detail

getSQLAM

getAGENT

getCMNTCPIP

getRDB

getSECMGR

getXAMGR

getSYNCPTMGR

getRSYNCMGR

writeCommitSubstitute_

readCommitSubstitute_

writeLocalXAStart_

readLocalXAStart_

writeLocalXACommit_

readLocalXACommit_

writeLocalXARollback_

readLocalXARollback_

writeLocalCommit_

readLocalCommit_

writeLocalRollback_

readLocalRollback_

setInputStream

setOutputStream

getInputStream

getOutputStream

writeTransactionStart

readTransactionStart

setIndoubtTransactions

newSectionManager

willAutoCommitGenerateFlow

getSecurityMechanism

getEncryptionManager

getTargetPublicKey

getProductID

isConnectionNull

setConnectionNull

serverSupportsLayerBStreaming

serverSupportLongRDBNAM

isOpen

createArrayOf

createNClob

createSQLXML

createStruct

isValid

close

setClientInfo

setClientInfo

getClientInfo

getClientInfo

isWrapperFor

unwrap