oracle.okv.kmip

Class OKVConnection

java.lang.Object

oracle.okv.kmip.OKVConnection

public final class OKVConnection
extends java.lang.Object

Wraps an injected OKVPrimitiveConnection and controls the sending and receiving of the byte arrays to and from an Oracle Key Vault server. It also abstracts the specific connection method (for example, SSL) from the client.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_NAME
static java.util.logging.Logger	logger

Constructor Summary

Constructors

Constructor and Description
OKVConnection(OKVPrimitiveConnection inPrimitiveConnection) Injects this object with an OKVPrimitiveConnection object.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the connection by using the injected OKVPrimitiveConnection object.
OKVPrimitiveConnection	getPrimitiveConnection()
boolean	isClosed() Checks if the connection is closed.
byte[]	okvConnSendRecvBytes(byte[] bytes) API sends and receives a byte array to and from the Oracle Key Vault server by using the injected OKVPrimitiveConnection object.
void	open() Opens a connection by using the injected OKVPrimitiveConnection object.
byte[]	recv() Receives a byte array from the Oracle Key Vault server by using the injected OKVPrimitiveConnection object.
void	send(byte[] bytes) Sends a byte array to the Oracle Key Vault server by using the injected OKVPrimitiveConnection object.
void	setAutoManage(boolean autoConnect) When set to true, OKVConnection opens the connection each time a byte array is sent and closes the connection each time a byte array is received.
void	setPrimitiveConnection(OKVPrimitiveConnection sslConnection)

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_NAME

public static final java.lang.String CLASS_NAME

logger

public static final java.util.logging.Logger logger

Constructor Detail

OKVConnection

public OKVConnection(OKVPrimitiveConnection inPrimitiveConnection)

Injects this object with an OKVPrimitiveConnection object.

Parameters:

inPrimitiveConnection - the primitive connection object

Method Detail

okvConnSendRecvBytes

public byte[] okvConnSendRecvBytes(byte[] bytes)
                            throws OKVConnectionException

API sends and receives a byte array to and from the Oracle Key Vault server by using the injected OKVPrimitiveConnection object. It attempts to reconnect to the Oracle Key Vault server if the connection is lost.

Parameters:

bytes - bytes to be sent

Returns:

bytes received from the server

Throws:

OKVConnectionException

send

public void send(byte[] bytes)
          throws java.io.IOException,
                 OKVConnectionException

Sends a byte array to the Oracle Key Vault server by using the injected OKVPrimitiveConnection object.

Parameters:

bytes - bytes to be sent

Throws:

java.io.IOException

OKVConnectionException

recv

public byte[] recv()
            throws java.io.IOException,
                   OKVConnectionException

Receives a byte array from the Oracle Key Vault server by using the injected OKVPrimitiveConnection object.

Returns:

bytes received from the server

Throws:

java.io.IOException

OKVConnectionException

open

public void open()
          throws OKVConnectionException

Opens a connection by using the injected OKVPrimitiveConnection object.

Throws:

OKVConnectionException

isClosed

public boolean isClosed()

Checks if the connection is closed.

Returns:

true if connection is closed false otherwise

close

public void close()
           throws OKVConnectionException

Closes the connection by using the injected OKVPrimitiveConnection object.

Throws:

OKVConnectionException

getPrimitiveConnection

public OKVPrimitiveConnection getPrimitiveConnection()

setPrimitiveConnection

public void setPrimitiveConnection(OKVPrimitiveConnection sslConnection)

setAutoManage

public void setAutoManage(boolean autoConnect)

When set to true, OKVConnection opens the connection each time a byte array is sent and closes the connection each time a byte array is received.

Parameters:

autoConnect - set to true if client wants the connection to be automatically managed (opened immediately before a send and immediately after a receive)