oracle.ucp.jdbc

Class JDBCConnectionRetrievalInfo

java.lang.Object

oracle.ucp.jdbc.JDBCConnectionRetrievalInfo

All Implemented Interfaces:

ConnectionRetrievalInfo

Direct Known Subclasses:

OracleJDBCConnectionRetrievalInfo

public class JDBCConnectionRetrievalInfo
extends Object
implements ConnectionRetrievalInfo

The connection retrieval info object for JDBC resources. JDBC connections are retrieved based on a user/password combination. This object maintains the user and password to be used when creating a JDBC connection.

See Also:

ConnectionRetrievalInfo

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JDBCConnectionRetrievalInfo.Builder JDBCConnectionRetrievalInfo object builder class

Constructor Summary

Constructors

Constructor and Description
JDBCConnectionRetrievalInfo(JDBCConnectionRetrievalInfo copyCri) Copy constructor
JDBCConnectionRetrievalInfo(String user, String password) Constructor.
JDBCConnectionRetrievalInfo(String user, String password, Properties labels) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addLabel(String key, String value) Adds a connection label to this connection retrieval information object.
static JDBCConnectionRetrievalInfo.Builder	createBuilder()
boolean	equals(Object obj) Checks equality.
ConnectionRetrievalInfo	getCopyWithNewProxyProperties(int type, Properties newProxyProps) Clones this connection retrieval object and adds a new set of proxy properties
ConnectionRetrievalInfo	getCopyWithNoLabels() Clones this connection retrieval object but removes all the connection labels associated.
ConnectionRetrievalInfo	getCopyWithService(String newService) Clones this connection retrieval object with default service
Properties	getLabels() Retrieves all the connection labels stored on this connection retrieval information object.
String	getPassword() Gets the password.
Properties	getPdbRoles() Retrieves the PDB roles if set on the connection retrieval information object.
Properties	getProxyProperties() Retrieves all the dual session proxy properties on this connection retrieval information object.
int	getProxyType()
String	getServiceName() Retrieves the service name if set on the connection retrieval information object.
OracleShardingKey	getShardingKey() Retrieves the Sharding Key object if set on the connection retrieval information object.
OracleShardingKey	getSuperShardingKey() Retrieves the super sharding key if set on the connection retrieval information object.
String	getUser() Gets the user.
int	hashCode() Gets a hash code for this object.
void	removeLabel(String key) Removes the connection label with the given key from this connection retrieval information object.
String	stringValue()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

JDBCConnectionRetrievalInfo

public JDBCConnectionRetrievalInfo(String user,
                                   String password)

Constructor.

Parameters:

user. -

password. -

JDBCConnectionRetrievalInfo

public JDBCConnectionRetrievalInfo(String user,
                                   String password,
                                   Properties labels)

Constructor.

Parameters:

user. -

password. -

labels - The requested connection labels.

JDBCConnectionRetrievalInfo

public JDBCConnectionRetrievalInfo(JDBCConnectionRetrievalInfo copyCri)

Copy constructor

Parameters:

copyCri -

Method Detail

equals

public boolean equals(Object obj)

Checks equality.

Specified by:

equals in interface ConnectionRetrievalInfo

Overrides:

equals in class Object

Parameters:

obj - the object to compare this with

Returns:

true if this object is equal to the given object

hashCode

public int hashCode()

Gets a hash code for this object.

Specified by:

hashCode in interface ConnectionRetrievalInfo

Overrides:

hashCode in class Object

Returns:

hash code.

getUser

public String getUser()

Gets the user.

Returns:

The user. May be null.

getPassword

public String getPassword()

Gets the password.

Returns:

The password. May be null.

addLabel

public void addLabel(String key,
                     String value)
              throws UniversalConnectionPoolException

Adds a connection label to this connection retrieval information object. This can be used for both requested labels during a connection borrowing request, or actual labels applied on a borrowed connection. The addition of connection labels is cumulative; each time this method is called, the supplied key/value pair is added to those connection labels already on this object. However, only the last applied value is retained for each particular label key.

Specified by:

addLabel in interface ConnectionRetrievalInfo

Parameters:

key - The key of the connection label to be added. Cannot be null or an empty string.

value - The value of the connection label to be added. Can be null or an empty string.

Throws:

UniversalConnectionPoolException - If the key is null or an empty string.

removeLabel

public void removeLabel(String key)
                 throws UniversalConnectionPoolException

Removes the connection label with the given key from this connection retrieval information object. This method does nothing if there is no label stored on this object with the specified key.

Specified by:

removeLabel in interface ConnectionRetrievalInfo

Parameters:

key - The key of the connection label to be removed. Cannot be null or an empty string.

Throws:

UniversalConnectionPoolException - If the key is null or an empty string.

getCopyWithNoLabels

public ConnectionRetrievalInfo getCopyWithNoLabels()

Clones this connection retrieval object but removes all the connection labels associated.

Specified by:

getCopyWithNoLabels in interface ConnectionRetrievalInfo

Returns:

A clone ConnectionRetrievalInfo object with all connection labels removed.

getCopyWithNewProxyProperties

public ConnectionRetrievalInfo getCopyWithNewProxyProperties(int type,
                                                             Properties newProxyProps)

Clones this connection retrieval object and adds a new set of proxy properties

Parameters:

type - proxy type to be set on the new CRI object copy.

newProxyProps - proxy properties to be set on the new CRI object copy.

Returns:

A clone ConnectionRetrievalInfo object with new proxy properties.

getCopyWithService

public ConnectionRetrievalInfo getCopyWithService(String newService)

Clones this connection retrieval object with default service

Parameters:

newService - the service name to be set on the cloned CRI object

Returns:

A clone ConnectionRetrievalInfo object with new service name as specified by the parameter

getLabels

public Properties getLabels()

Retrieves all the connection labels stored on this connection retrieval information object. Any change to the result Properties object does not affect the stored labels.

Specified by:

getLabels in interface ConnectionRetrievalInfo

Returns:

A java.util.Properties object storing all the stored labels as key/value pairs. Returns null if there are no stored labels on this connection retrieval info object.

getProxyProperties

public Properties getProxyProperties()

Retrieves all the dual session proxy properties on this connection retrieval information object.

Returns:

A java.util.Properties object storing all the proxy properties. Returns null if there are no dual session proxy properties on this connection retrieval info object.

getProxyType

public int getProxyType()

Returns:

proxy type set on this connection retrieval information object.

getServiceName

public String getServiceName()

Retrieves the service name if set on the connection retrieval information object.

Returns:

the string corresponding to the service name

getShardingKey

public OracleShardingKey getShardingKey()

Retrieves the Sharding Key object if set on the connection retrieval information object.

Returns:

the OracleShardingKey object corresponding to Sharding Key

getSuperShardingKey

public OracleShardingKey getSuperShardingKey()

Retrieves the super sharding key if set on the connection retrieval information object.

Returns:

the OracleShardingKey object corresponding to the super sharding key

getPdbRoles

public Properties getPdbRoles()

Retrieves the PDB roles if set on the connection retrieval information object.

Returns:

the PDB roles properties object corresponding to the role name and password key value pairs.

toString

public String toString()

Overrides:

toString in class Object

Returns:

string representation of the connection retrieval information object

See Also:

Object.toString()

stringValue

public String stringValue()

Returns:

string representation of the connection retrieval information object

createBuilder

public static JDBCConnectionRetrievalInfo.Builder createBuilder()

Returns:

creates and return a new JDBC CRI object builder