oracle.jdeveloper.cm
Class ConnectionDescriptor

java.lang.Object
  java.util.Dictionary
      java.util.Hashtable
          java.util.Properties
              oracle.jdeveloper.cm.ConnectionDescriptor

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map, java.io.Serializable

public class ConnectionDescriptor

extends java.util.Properties

ConnectionDescriptor is a subclass of java.util.Properties and is used to describe Connections.

See Also:

Properties, Serialized Form

Field Summary

static java.lang.String	ALWAYS_PROMPT Property name: should be prompted for security information.
static java.lang.String	BATCH_VALUE Property name: Oracle JDBC extension specifying the default batch value.
static java.lang.String	CLASS_APPSERVER
static java.lang.String	CLASS_DATABASE
static java.lang.String	CONN_FTP constant: FTP Connection.
static java.lang.String	CONN_IAS Deprecated. Use CONN_OC4J instead.
static java.lang.String	CONN_IAS_DCM Deprecated. Use CONN_IAS_LOCAL_DCM instead.
static java.lang.String	CONN_IAS_LOCAL_DCM constant: iAS (via local DCM) Connection
static java.lang.String	CONN_IAS_REMOTE_DCM constant: iAS (via remote DCM) Connection
static java.lang.String	CONN_JDBC_ODBC constant: JDBC-ODBC Bridge Connection (WIN32 Only)
static java.lang.String	CONN_JNDI constant: JNDI Connection
static java.lang.String	CONN_OC4J constant: OC4J Connection
static java.lang.String	CONN_ORACLE_JDBC constant: Oracle JDBC Only.
static java.lang.String	CONN_ORACLE_JSERVER constant: Oracle JServer Connection.
static java.lang.String	CONN_ORACLE_LITE constant: Oracle Lite.
static java.lang.String	CONN_OTHER_JDBC constant: Other Generic JDBC Connection.
static java.lang.String	CONN_WEBLOGIC Deprecated. Use Weblogic6ConnectionType.CONN_WEBLOGIC_6 instead.
static java.lang.String	CONNECTION_NAME Property name: names the connection.
static java.lang.String	CONNECTION_TYPE Property name: connection type.
static java.lang.String	DEFAULT_SESSION Not used.
static java.lang.String	DEPLOY_PASSWORD Property name: deploy the password to the runtime environment.
static java.lang.String	EXPERT_MODE Property name: Expert Mode (user entered connect string)
static java.lang.String	EXTRA_PARAMS Property name: Extra Parameters, mostly for ODBC Connections
static java.lang.String	HOSTNAME Property name: Hostname
static java.lang.String	IAS_HOME Deprecated. Use OC4J_HOME
static java.lang.String	IIOP_LOGIN_METH Not used.
static java.lang.String	IIOP_NON_SSL_CREDENTIAL Not used.
static java.lang.String	IIOP_NON_SSL_LOGIN Not used.
static java.lang.String	IIOP_PORT REMOVED Property name: IIOP Port Number (for Jserver)
static java.lang.String	IIOP_SSL_CREDENTIAL Not used.
static java.lang.String	IIOP_SSL_LOGIN Not used.
static java.lang.String	JDBC_DRIVER Property name: JDBC driver (if applicable).
static java.lang.String	JDBC_PORT Property name: JDBC Port Number
static java.lang.String	JNDI_INITIAL_CONTEXT_FACTORY Property name: JNDI Initial Context Factory class.
static java.lang.String	LEGACY_TYPE_IIOP REMOVED: constant: IIOP type connection.
static java.lang.String	LEGACY_TYPE_JDBC constant: JDBC type connection.
static java.lang.String	OC4J_HOME This should not be used by clients
static java.lang.String	ODBC_DSN Property name: ODBC Datasource Name
static java.lang.String	ORACLE_HOME
static java.lang.String	ORACLE_JDBC_TYPE Property name: Oracle JDBC Driver (THIN/OCI)
static java.lang.String	PASSWORD Property name: connection password.
static java.lang.String	PORT Property name: Port
static java.lang.String	PREFETCH Property name: Oracle JDBC extension specifing default row prefetch value.
static java.lang.String	PRESENTATION_FTP FTP
static java.lang.String	PRESENTATION_IIOP REMOVED: IIOP
static java.lang.String	PRESENTATION_JDBC JDBC
static java.lang.String	PRESENTATION_JNDI JNDI
static java.lang.String	REMARKS Property name: Oracle JDBC extension specifying whether to retrieve table remarks.
static java.lang.String	ROLE Property name: connection role (if applicable).
static java.lang.String	SID Property name: Database SID
static java.lang.String	TARGET_NODE Property name: target node -- for OC4J web site name and Weblogic node
static java.lang.String	URL Property name: connection URL.
static java.lang.String	USERNAME Property name: connection username.

Fields inherited from class java.util.Properties

defaults

Constructor Summary

ConnectionDescriptor()

Method Summary

boolean	equals(java.lang.Object o) compares the contents of all key-value pairs to see if two ConnectionDescriptor objects are identical.
java.lang.String	getConnectionName() returns the stored name.
java.lang.String	getConnectionType() returns the stored type.
java.lang.String	getDefaultSession() returns the stored default IIOP context name.
java.lang.String	getHostname() returns the Hostname (used by various connection types)
java.lang.String	getIiopLoginMethod() returns the stored IIOP login method.
java.lang.String	getIiopPort() returns the port number for IIOP Connections to Oracle JServer
java.lang.String	getJdbcDriver() returns the stored JDBC Driver.
java.lang.String	getJdbcPort() returns the port number for JDBC Connections
java.lang.String	getOracleJdbcType() returns the Oracle JDBC Driver type
java.lang.String	getPassword() returns the stored password.
java.lang.String	getPort() returns the Port associated with the hostname
java.lang.String	getRole() returns the stored role.
java.lang.String	getSid() returns the SID for the Oracle connection
java.lang.String	getURL() Returns the URL property in the ConnectionDescriptor.
java.lang.String	getUsername() returns the stored username.
boolean	isAlwaysPrompt() Deprecated.
boolean	isDeployPassword()
boolean	isExpertMode() returns whether or not a user entered connect string is given otherwise one will be created for the user as host:port:sid for JDBC connections
java.lang.Object	put(java.lang.Object key, java.lang.Object value) ensures that null or empty values are not placed in the ConnectionDescriptor before calling super.put()

Methods inherited from class java.util.Properties

getProperty, getProperty, list, list, load, propertyNames, save, setProperty, store

Methods inherited from class java.util.Hashtable

clear, clone, contains, containsKey, containsValue, elements, entrySet, get, hashCode, isEmpty, keys, keySet, putAll, rehash, remove, size, toString, values

Methods inherited from class java.lang.Object

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

Field Detail

ALWAYS_PROMPT

public static final java.lang.String ALWAYS_PROMPT

Property name: should be prompted for security information.

See Also:

Constant Field Values

CONNECTION_NAME

public static final java.lang.String CONNECTION_NAME

Property name: names the connection.

See Also:

Constant Field Values

DEPLOY_PASSWORD

public static final java.lang.String DEPLOY_PASSWORD

Property name: deploy the password to the runtime environment.

See Also:

Constant Field Values

URL

public static final java.lang.String URL

Property name: connection URL.

See Also:

Constant Field Values

EXPERT_MODE

public static final java.lang.String EXPERT_MODE

Property name: Expert Mode (user entered connect string)

See Also:

Constant Field Values

HOSTNAME

public static final java.lang.String HOSTNAME

Property name: Hostname

See Also:

Constant Field Values

SID

public static final java.lang.String SID

Property name: Database SID

See Also:

Constant Field Values

JDBC_PORT

public static final java.lang.String JDBC_PORT

Property name: JDBC Port Number

See Also:

Constant Field Values

IIOP_PORT

public static final java.lang.String IIOP_PORT

REMOVED Property name: IIOP Port Number (for Jserver)

See Also:

Constant Field Values

PORT

public static final java.lang.String PORT

Property name: Port

See Also:

Constant Field Values

TARGET_NODE

public static final java.lang.String TARGET_NODE

Property name: target node -- for OC4J web site name and Weblogic node

See Also:

Constant Field Values

JDBC_DRIVER

public static final java.lang.String JDBC_DRIVER

Property name: JDBC driver (if applicable).

See Also:

Constant Field Values

JNDI_INITIAL_CONTEXT_FACTORY

public static final java.lang.String JNDI_INITIAL_CONTEXT_FACTORY

Property name: JNDI Initial Context Factory class.

See Also:

Constant Field Values

ORACLE_JDBC_TYPE

public static final java.lang.String ORACLE_JDBC_TYPE

Property name: Oracle JDBC Driver (THIN/OCI)

See Also:

Constant Field Values

PASSWORD

public static final java.lang.String PASSWORD

Property name: connection password.

See Also:

Constant Field Values

ROLE

public static final java.lang.String ROLE

Property name: connection role (if applicable).

See Also:

Constant Field Values

USERNAME

public static final java.lang.String USERNAME

Property name: connection username.

See Also:

Constant Field Values

CONNECTION_TYPE

public static final java.lang.String CONNECTION_TYPE

Property name: connection type.

See Also:

Constant Field Values

IIOP_LOGIN_METH

public static final java.lang.String IIOP_LOGIN_METH

Not used.

See Also:

Constant Field Values

DEFAULT_SESSION

public static final java.lang.String DEFAULT_SESSION

Not used.

See Also:

Constant Field Values

PREFETCH

public static final java.lang.String PREFETCH

Property name: Oracle JDBC extension specifing default row prefetch value.

See Also:

Constant Field Values

REMARKS

public static final java.lang.String REMARKS

Property name: Oracle JDBC extension specifying whether to retrieve table remarks.

See Also:

Constant Field Values

BATCH_VALUE

public static final java.lang.String BATCH_VALUE

Property name: Oracle JDBC extension specifying the default batch value.

See Also:

Constant Field Values

LEGACY_TYPE_JDBC

public static final java.lang.String LEGACY_TYPE_JDBC

constant: JDBC type connection.

See Also:

Constant Field Values

LEGACY_TYPE_IIOP

public static final java.lang.String LEGACY_TYPE_IIOP

REMOVED: constant: IIOP type connection.

See Also:

Constant Field Values

CONN_ORACLE_JSERVER

public static final java.lang.String CONN_ORACLE_JSERVER

constant: Oracle JServer Connection.

See Also:

Constant Field Values

CONN_ORACLE_JDBC

public static final java.lang.String CONN_ORACLE_JDBC

constant: Oracle JDBC Only.

See Also:

Constant Field Values

CONN_ORACLE_LITE

public static final java.lang.String CONN_ORACLE_LITE

constant: Oracle Lite.

See Also:

Constant Field Values

CONN_JDBC_ODBC

public static final java.lang.String CONN_JDBC_ODBC

constant: JDBC-ODBC Bridge Connection (WIN32 Only)

See Also:

Constant Field Values

CONN_OTHER_JDBC

public static final java.lang.String CONN_OTHER_JDBC

constant: Other Generic JDBC Connection.

See Also:

Constant Field Values

CONN_FTP

public static final java.lang.String CONN_FTP

constant: FTP Connection.

See Also:

Constant Field Values

CONN_JNDI

public static final java.lang.String CONN_JNDI

constant: JNDI Connection

See Also:

Constant Field Values

CONN_OC4J

public static final java.lang.String CONN_OC4J

constant: OC4J Connection

See Also:

Constant Field Values

CONN_IAS

public static final java.lang.String CONN_IAS

Deprecated. Use CONN_OC4J instead.

See Also:

Constant Field Values

CONN_IAS_LOCAL_DCM

public static final java.lang.String CONN_IAS_LOCAL_DCM

constant: iAS (via local DCM) Connection

See Also:

Constant Field Values

CONN_IAS_REMOTE_DCM

public static final java.lang.String CONN_IAS_REMOTE_DCM

constant: iAS (via remote DCM) Connection

See Also:

Constant Field Values

CONN_IAS_DCM

public static final java.lang.String CONN_IAS_DCM

Deprecated. Use CONN_IAS_LOCAL_DCM instead.

See Also:

Constant Field Values

CONN_WEBLOGIC

public static final java.lang.String CONN_WEBLOGIC

Deprecated. Use Weblogic6ConnectionType.CONN_WEBLOGIC_6 instead.

See Also:

Constant Field Values

ODBC_DSN

public static final java.lang.String ODBC_DSN

Property name: ODBC Datasource Name

See Also:

Constant Field Values

EXTRA_PARAMS

public static final java.lang.String EXTRA_PARAMS

Property name: Extra Parameters, mostly for ODBC Connections

See Also:

Constant Field Values

PRESENTATION_JDBC

public static final java.lang.String PRESENTATION_JDBC

JDBC

See Also:

Constant Field Values

PRESENTATION_IIOP

public static final java.lang.String PRESENTATION_IIOP

REMOVED: IIOP

See Also:

Constant Field Values

PRESENTATION_JNDI

public static final java.lang.String PRESENTATION_JNDI

JNDI

See Also:

Constant Field Values

PRESENTATION_FTP

public static final java.lang.String PRESENTATION_FTP

FTP

See Also:

Constant Field Values

CLASS_DATABASE

public static final java.lang.String CLASS_DATABASE

See Also:

Constant Field Values

CLASS_APPSERVER

public static final java.lang.String CLASS_APPSERVER

See Also:

Constant Field Values

IIOP_NON_SSL_CREDENTIAL

public static final java.lang.String IIOP_NON_SSL_CREDENTIAL

Not used.

See Also:

Constant Field Values

IIOP_NON_SSL_LOGIN

public static final java.lang.String IIOP_NON_SSL_LOGIN

Not used.

See Also:

Constant Field Values

IIOP_SSL_CREDENTIAL

public static final java.lang.String IIOP_SSL_CREDENTIAL

Not used.

See Also:

Constant Field Values

IIOP_SSL_LOGIN

public static final java.lang.String IIOP_SSL_LOGIN

Not used.

See Also:

Constant Field Values

OC4J_HOME

public static final java.lang.String OC4J_HOME

This should not be used by clients

See Also:

Constant Field Values

IAS_HOME

public static final java.lang.String IAS_HOME

Deprecated. Use OC4J_HOME

See Also:

Constant Field Values

ORACLE_HOME

public static final java.lang.String ORACLE_HOME

See Also:

Constant Field Values

Constructor Detail

ConnectionDescriptor

public ConnectionDescriptor()

Method Detail

put

public java.lang.Object put(java.lang.Object key,
                            java.lang.Object value)

ensures that null or empty values are not placed in the ConnectionDescriptor before calling super.put()

See Also:

Hashtable.put(java.lang.Object, java.lang.Object)

equals

public boolean equals(java.lang.Object o)

compares the contents of all key-value pairs to see if two ConnectionDescriptor objects are identical.

Parameters:

o - the object to compare to the ConnectionDescriptor

getConnectionName

public java.lang.String getConnectionName()

returns the stored name.

Returns:

the stored name.

getConnectionType

public java.lang.String getConnectionType()

returns the stored type.

Returns:

the stored type.

getDefaultSession

public java.lang.String getDefaultSession()

returns the stored default IIOP context name.

Returns:

the stored default IIOP context name.

getJdbcDriver

public java.lang.String getJdbcDriver()

returns the stored JDBC Driver.

Returns:

the stored JDBC Driver.

getIiopLoginMethod

public java.lang.String getIiopLoginMethod()

returns the stored IIOP login method.

Returns:

the stored IIOP login method.

getPassword

public java.lang.String getPassword()

returns the stored password.

Returns:

the stored password.

getRole

public java.lang.String getRole()

returns the stored role.

Returns:

the stored role.

getURL

public java.lang.String getURL()

Returns the URL property in the ConnectionDescriptor. This value may or may not be set depending on the Presentation.

To obtain a valid URL to use when connecting, use CMUtils.getUrl(String, ConnectionDescriptor)

Returns:

the URL property or null if no property is set.

getJdbcPort

public java.lang.String getJdbcPort()

returns the port number for JDBC Connections

Returns:

the JDBC port number.

getOracleJdbcType

public java.lang.String getOracleJdbcType()

returns the Oracle JDBC Driver type

Returns:

the Oracle JDBC Driver Type

getIiopPort

public java.lang.String getIiopPort()

returns the port number for IIOP Connections to Oracle JServer

Returns:

the IIOP port number.

getHostname

public java.lang.String getHostname()

returns the Hostname (used by various connection types)

Returns:

the host name

getPort

public java.lang.String getPort()

returns the Port associated with the hostname

Returns:

the port

getSid

public java.lang.String getSid()

returns the SID for the Oracle connection

Returns:

the database SID

getUsername

public java.lang.String getUsername()

returns the stored username.

Returns:

the stored username.

isExpertMode

public boolean isExpertMode()

returns whether or not a user entered connect string is given otherwise one will be created for the user as host:port:sid for JDBC connections

Returns:

status of the expert mode setting

isAlwaysPrompt

public boolean isAlwaysPrompt()

Deprecated.

returns whether the user should always be prompted for connect information.

Returns:

whether the user should be prompted for connect information.

isDeployPassword

public boolean isDeployPassword()