oracle.rc.asadapter.connection

Class ConnectionDescriptor

java.lang.Object

oracle.rc.asadapter.connection.ConnectionDescriptor

Direct Known Subclasses:

AppServerConnectionDescriptor

public abstract class ConnectionDescriptor
extends java.lang.Object

An adapter to read/write common connection properties. This static method ConnectionDescriptor.getAppServerType may be used to do an initial determination of the type of connection, after which a more platform-specific adapter that sub-classes this may be created using ConnectionDescriptor.newInstance() to read/write further properties.

Connection properties should only be written through the correct adapter to ensure data integrity. Use isMatchingType() to ensure this.

This class defines some property names to promote uniformity, but imposes no conditions on how and when they should be used. The appropriate derived Descriptor would be the best source for reference.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ALWAYS_PROMPT Property name: should be prompted for security information.
static java.lang.String	APPSERVER_TYPE Property name: connection type.
protected AppServerProvider	asProvider_
static java.lang.String	CONNECTION_NAME Property name: names the connection.
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	DEPLOYMENT_URL Deployment URL.
static java.lang.String	EXPERT_MODE Property name: Expert Mode (user entered connect string)
static java.lang.String	HOSTNAME Property name: Hostname
static java.lang.String	HTTP_HOSTNAME Property: Public (external) Http host name
static java.lang.String	HTTP_PORT Property: Http port
static java.lang.String	HTTPS_PORT Property: Https Port
static java.lang.String	IIOP_LOGIN_METH Not used.
static java.lang.String	JMX_CONNECTOR_HOST Property: JMX Connection Host
static java.lang.String	JMX_CONNECTOR_PATH Property: JMX Connection Path
static java.lang.String	JMX_CONNECTOR_PORT Property: JMX Connection Port
static java.lang.String	JMX_CONNECTOR_SSL_PORT Property: JMX Connection SSL Port
static java.lang.String	LOCALHOST
static java.lang.String	LOOPBACK
static java.lang.String	PASSWORD Property name: connection password.
static java.lang.String	RMI_PORT Property: RMI Port
static java.lang.String	ROLE Property name: connection role (if applicable).
static java.lang.String	SOAP_PORT Property: Soap Port
static java.lang.String	URL Property name: connection URL.
static java.lang.String	USE_SSL Property: Use SSL connections
static java.lang.String	USERNAME Property name: connection username.

Constructor Summary

Constructors

Constructor and Description
ConnectionDescriptor(AppServerProvider asProvider)

Method Summary

Methods

Modifier and Type	Method and Description
protected static java.lang.String	get(AppServerProvider provider, java.lang.String property)
java.lang.String	get(java.lang.String property)
AppServerProvider	getAppServerProvider()
java.lang.String	getAppServerType() Retrieve the stored AppServer type property from AppServerProvider.
static java.lang.String	getAppServerType(AppServerProvider provider)
protected abstract java.lang.String[]	getDefaultProperties() Return an linear array of key-value pairs that denote a template for creating a new descriptor of a specific type.
java.lang.String	getDeploymentURL() Returns the Deployment URL if applicable.
boolean	getDeployPassword()
static boolean	getDeployPassword(AppServerProvider provider)
abstract java.lang.String	getDescriptorType() This should be implemented by sub-classes to specify the unique string that identifies each AppServer type.
java.lang.String	getPassword()
static java.lang.String	getPassword(AppServerProvider provider)
java.lang.String	getURL() Get the connection URL spec if applicable.
java.lang.String	getUserName()
static java.lang.String	getUserName(AppServerProvider provider)
static boolean	isMatchingType(AppServerProvider provider, java.lang.Class<? extends ConnectionDescriptor> cdClass)
boolean	isMatchingType(java.lang.Class<? extends ConnectionDescriptor> descClass)
static <T extends ConnectionDescriptor> T	newInstance(java.lang.Class<T> cdClass, AppServerProvider provider)
protected static java.lang.String	set(AppServerProvider provider, java.lang.String property, java.lang.String value)
void	set(java.lang.String property, java.lang.String value)
static void	setAppServerType(AppServerProvider provider, java.lang.String type)
void	setAppServerType(java.lang.String type)
static void	setDeployPassword(AppServerProvider provider, boolean deployPasswd)
void	setDeployPassword(boolean b)
void	setFactoryDefaults()
static void	setPassword(AppServerProvider provider, java.lang.String s)
void	setPassword(java.lang.String s)
static void	setUserName(AppServerProvider provider, java.lang.String name)
void	setUserName(java.lang.String name)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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

DEPLOYMENT_URL

public static final java.lang.String DEPLOYMENT_URL

Deployment 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

JMX_CONNECTOR_HOST

public static final java.lang.String JMX_CONNECTOR_HOST

Property: JMX Connection Host

See Also:

Constant Field Values

JMX_CONNECTOR_PORT

public static final java.lang.String JMX_CONNECTOR_PORT

Property: JMX Connection Port

See Also:

Constant Field Values

JMX_CONNECTOR_SSL_PORT

public static final java.lang.String JMX_CONNECTOR_SSL_PORT

Property: JMX Connection SSL Port

See Also:

Constant Field Values

JMX_CONNECTOR_PATH

public static final java.lang.String JMX_CONNECTOR_PATH

Property: JMX Connection Path

See Also:

Constant Field Values

HTTP_HOSTNAME

public static final java.lang.String HTTP_HOSTNAME

Property: Public (external) Http host name

See Also:

Constant Field Values

HTTP_PORT

public static final java.lang.String HTTP_PORT

Property: Http port

See Also:

Constant Field Values

HTTPS_PORT

public static final java.lang.String HTTPS_PORT

Property: Https Port

See Also:

Constant Field Values

SOAP_PORT

public static final java.lang.String SOAP_PORT

Property: Soap Port

See Also:

Constant Field Values

RMI_PORT

public static final java.lang.String RMI_PORT

Property: RMI Port

See Also:

Constant Field Values

USE_SSL

public static final java.lang.String USE_SSL

Property: Use SSL connections

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

APPSERVER_TYPE

public static final java.lang.String APPSERVER_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

LOCALHOST

public static final java.lang.String LOCALHOST

See Also:

Constant Field Values

LOOPBACK

public static final java.lang.String LOOPBACK

See Also:

Constant Field Values

asProvider_

protected AppServerProvider asProvider_

Constructor Detail

ConnectionDescriptor

public ConnectionDescriptor(AppServerProvider asProvider)

Method Detail

getAppServerProvider

public AppServerProvider getAppServerProvider()

getAppServerType

public java.lang.String getAppServerType()

Retrieve the stored AppServer type property from AppServerProvider. This should in most cases match the string returned by getDescriptorType(). If it does not match, the descriptor may be used to read, but not write to the provider.

Returns:

setAppServerType

public void setAppServerType(java.lang.String type)

isMatchingType

public boolean isMatchingType(java.lang.Class<? extends ConnectionDescriptor> descClass)

setFactoryDefaults

public void setFactoryDefaults()

getDefaultProperties

protected abstract java.lang.String[] getDefaultProperties()

Return an linear array of key-value pairs that denote a template for creating a new descriptor of a specific type.

Returns:

getDescriptorType

public abstract java.lang.String getDescriptorType()

This should be implemented by sub-classes to specify the unique string that identifies each AppServer type.

Returns:

getURL

public java.lang.String getURL()

Get the connection URL spec if applicable. This may return only one of many URLs if the connection definition supports different Presentations each with its own URL, or it may return the default URL.

Returns:

null if a default URL has not been set, or of it is null.

getDeploymentURL

public java.lang.String getDeploymentURL()

Returns the Deployment URL if applicable.

Returns:

getUserName

public java.lang.String getUserName()

setUserName

public void setUserName(java.lang.String name)

getPassword

public java.lang.String getPassword()

setPassword

public void setPassword(java.lang.String s)

getDeployPassword

public boolean getDeployPassword()

setDeployPassword

public void setDeployPassword(boolean b)

get

public java.lang.String get(java.lang.String property)

set

public void set(java.lang.String property,
       java.lang.String value)

get

protected static java.lang.String get(AppServerProvider provider,
                   java.lang.String property)

set

protected static java.lang.String set(AppServerProvider provider,
                   java.lang.String property,
                   java.lang.String value)

isMatchingType

public static boolean isMatchingType(AppServerProvider provider,
                     java.lang.Class<? extends ConnectionDescriptor> cdClass)

getAppServerType

public static java.lang.String getAppServerType(AppServerProvider provider)

setAppServerType

public static void setAppServerType(AppServerProvider provider,
                    java.lang.String type)

getUserName

public static java.lang.String getUserName(AppServerProvider provider)

setUserName

public static void setUserName(AppServerProvider provider,
               java.lang.String name)

getPassword

public static java.lang.String getPassword(AppServerProvider provider)

setPassword

public static void setPassword(AppServerProvider provider,
               java.lang.String s)

getDeployPassword

public static boolean getDeployPassword(AppServerProvider provider)

setDeployPassword

public static void setDeployPassword(AppServerProvider provider,
                     boolean deployPasswd)

newInstance

public static <T extends ConnectionDescriptor> T newInstance(java.lang.Class<T> cdClass,
                                             AppServerProvider provider)