|
Oracle Fusion Middleware Java API Reference for Oracle ADF Model 11g Release 1 (11.1.1) E10653-04 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectoracle.jbo.client.Configuration
public class Configuration
Class to manage 'Configuration' file created during the design time.
The Configuaration file contains one or more named 'Configuration's. A
'Configuration' is a named collection of property-value pairs. They
correspond to the list of property-value pairs, needed to perform a
JNDI lookup and create an AppModule.
The property values stored in the external file might be mapped to
another property name before being used in a JNDI lookup.
This mapping is neeed for some properties such as the JDBC connection name.
For ease, of editing in the design time, the JDBC connection is stored
as a named connection and might need to be mapped to another property name.
This class can retrieve a Configuration created during the design
time or create a new 'Configuration'.
This class along with the Configuration file provides an alternative way
to store the list of parameters needed to create an AppModule. Clients who
wish to store/retrieve the parameters from the Configuration file should
use this class.
Configuration c = new Configuration(
Configuration.buildConfigFileName("package10"));
Hashtable env = c.getConfiguration("Oracle8iCorba");
ApplicationModuleHome home =
(ApplicationModuleHome)ic.lookup(
env.get(Configuration.APPMODULE_JNDI_NAME);
.....
.....
Field Summary | |
---|---|
protected static java.lang.String |
APP_MODULE_CONFIG_BAG
|
protected static java.lang.String |
APP_MODULE_CONFIG_NAME
|
static java.lang.String |
APPLICATION_NAME_PROPERTY
name of the property in the Config, which identifies the package qualified AppModuleName |
static java.lang.String |
APPLICATION_TYPE_PROPERTY
name of the property in the Config, which identifies the meaning of the APPLICATION_NAME_PROPERTY. |
static java.lang.String |
APPLICATION_TYPE_VALUE_APPMODULE
|
static java.lang.String |
APPLICATION_TYPE_VALUE_PACKAGE
|
static java.lang.String |
APPMODULE_JNDI_NAME
name of the property in the Config, which identifies the jndi name used to lookup the appmodule home. |
static java.lang.String |
APPSERVER_CONNECTION_NAME
|
protected static java.lang.String |
ATTR_CONFIG_NAME
|
static java.lang.String |
BC4J_CONFIG
Name of the tag, which in turn holds the AppModuleConfig nodes |
static java.lang.String |
BC4J_CONFIG_NAME
|
static java.lang.String |
BC4J_CONFIG_NAMES
name of the property in the Config, which identifies the list of existing configurations. |
static java.lang.String |
COMMON
name of the common package |
protected XMLDocument |
configDocument
|
static java.lang.String |
CONFIGURATION_NAME
The package qualified configuration name of the configuration. |
protected static java.lang.String |
CURRENT_VERSION
|
static java.lang.String |
DB_CONNECT_STRING_PROPERTY
|
static java.lang.String |
DB_CONNECTION_PROPERTY
|
static java.lang.String |
DB_DATASOURCE_PASSWD_PROPERTY
Deprecated. |
static java.lang.String |
DB_DATASOURCE_PROPERTY
|
static java.lang.String |
DB_DATASOURCE_USERNAME_PROPERTY
Deprecated. |
static java.lang.String |
DB_PASSWORD_PROPERTY
|
static java.lang.String |
DB_REQUIRES_CONNECTION
|
static java.lang.String |
DB_USERNAME_PROPERTY
|
static java.lang.String |
DEFAULT_CONFIG_FILE
|
static java.lang.String |
DEFAULT_CONFIG_FILE_EXT
default name for the configuration file, created by the Wizards. |
static java.lang.String |
DEFAULT_CONFIG_FILENAME
|
protected DOMParser |
domParser
|
static java.lang.String |
DT_COMMONDEPLOYMENTPROFILE
|
static java.lang.String |
DT_DEPLOYMENTPROFILE
name of the designtime deployment profile that created the configuration Currently only supported on ejb. |
static java.lang.String |
DT_MIDDLETIERDEPLOYMENTPROFILE
|
static int |
FLAG_RESOLVE_CONNECTION
|
static int |
FLAG_RESOLVE_ENV_INFO_PROVIDER
|
static java.lang.String |
HTTP_CONNECTION_NAME
constant to indicate the HTTP connection name |
static java.lang.String |
IIOP_CONNECTION_NAME
constant to indicate the IIOP connection name |
static java.lang.String |
IS_INTERNAL
If the configuration is internal and specifies the embedded instance. |
static java.lang.String |
JBO_COOKIE_HANDLE
|
static java.lang.String |
JDBC_CONNECTION_NAME
name of the property in the Config, which identifies the connect string. |
static java.lang.String |
JDBC_DS_NAME
Name of the JDBC2.0 datasource. |
static java.lang.String |
LAST_USED_CONFIGURATION
Name for the default configuration property. |
protected static java.lang.String |
NAME_SPACE
|
static java.lang.String |
O8I_CONNECT_STRING
default connect string for an 8i connection |
static java.lang.String |
TESTER_CONFIG_FILENAME
|
protected static java.lang.String |
VERSION
|
Constructor Summary | |
---|---|
Configuration()
|
Method Summary | |
---|---|
protected void |
addProperties(java.util.Hashtable h)
|
static java.lang.String |
buildConfigurationFileName(java.lang.String fileName)
A helper function which hides the details of building a package qualified filename for the Configuration file. |
static java.lang.String |
buildConfigurationFileNameFromClassPath(java.lang.String packageName)
|
void |
createNewConnectionEntry(java.lang.String sName,
java.util.Properties props)
|
static ApplicationModule |
createRootApplicationModule(java.lang.String qualifiedAMDefName,
java.lang.String configName)
Creates and connects an application module using the specified configuration. |
static ApplicationModule |
createRootApplicationModule(java.lang.String qualifiedAMDefName,
java.lang.String configName,
EnvInfoProvider envInfo)
Creates and connects an application module using the specified configuration. |
ApplicationModule |
createRootApplicationModuleFromConfig(java.lang.String configName,
EnvInfoProvider envInfo)
|
static ApplicationModuleHandle |
createRootApplicationModuleHandle(java.lang.String qualifiedAMDefName,
java.lang.String configName)
Returns an application module handle. |
static ApplicationModuleHandle |
createRootApplicationModuleHandle(java.lang.String qualifiedAMDefName,
java.lang.String configName,
EnvInfoProvider envInfo)
Returns an application module handle. |
protected java.lang.String |
findProperty(Node n,
java.lang.String propertyName)
return a general property value. |
protected Node |
getAppModuleConfigBagNode()
|
protected NodeList |
getAppModuleConfigNodes()
|
static java.lang.String |
getChecksumValue(java.lang.String pwd)
|
static java.util.Hashtable |
getConfiguration(Node node)
If the node is a version11 configuration node, then this method returns the complete configuration. |
java.util.Hashtable |
getConfiguration(java.lang.String configName)
Get the list of properties for a given Configuration. |
java.util.Hashtable |
getConfiguration(java.lang.String configName,
boolean resolveConn)
Get the list of properties for a given Configuration. |
void |
getConfiguration(java.lang.String configName,
java.util.Hashtable env)
|
void |
getConfiguration(java.lang.String configName,
java.util.Hashtable env,
boolean resolveConn)
|
java.util.List |
getConfiguration(java.lang.String configName,
java.util.Hashtable env,
int flags)
|
java.lang.String[] |
getConfigurationNameList()
Get the list of 'named' Configuration defined in this file. |
java.lang.String[] |
getConfigurationNameList(java.lang.String appName)
retrieve the list of configuration names available for the specified appName |
protected Node |
getConfigurationNode(java.lang.String name)
Helper function to get a named config node |
protected NodeList |
getConnectionDefinitionNodes()
|
java.lang.String[] |
getExternalConfigurationNameList()
|
protected java.lang.String |
getNameSpace()
|
static java.lang.String |
getNameSpaceUri()
|
static java.lang.String |
getPassword(Node node)
|
static java.lang.String |
getRestoredChecksumValue(java.lang.String pwd)
|
protected XMLDocument |
getXMLDocument(java.io.InputStream inputStream)
|
protected XMLDocument |
getXMLDocument(java.io.Reader reader)
|
void |
initializeFromConnectionName(java.util.Hashtable ht)
|
static boolean |
isEmbeddedConfig(java.util.Hashtable env)
May be invoked to determine if the specified configuration environment represents an embedded configuration. |
boolean |
isEmbeddedConfig(java.lang.String configName)
May be invoked to determine if the specified configuration represents an embedded configuration. |
boolean |
isOldVersion()
Configurations loaded through JDeveloper are migrated automatically. |
protected boolean |
isVersion11()
|
void |
loadFromClassPath(java.lang.String classPathConfigurationFileName)
Pass the name of the Configuration file. |
void |
loadFromFile(java.lang.String configurationFileName)
|
void |
loadFromReader(java.io.Reader reader)
|
void |
loadFromStream(java.io.InputStream in)
Build a Configuration class using the input stream on the config file. |
static void |
main(java.lang.String[] args)
|
protected void |
registerConnectionsFromDocument()
|
static void |
releaseRootApplicationModule(ApplicationModule appModule,
boolean remove)
Release the specified application module. |
static void |
releaseRootApplicationModuleHandle(ApplicationModuleHandle handle,
boolean remove)
Releases the application module associated with the handle created from createRootApplicationModuleHandle(String, String) . |
protected void |
removeConfigurationProperty(java.lang.String configName,
java.lang.String property)
|
protected void |
removeConnectionEntry(java.lang.String sName)
|
static boolean |
wasCreatedByConfiguration(ApplicationModule appModule)
Internal use only. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int FLAG_RESOLVE_CONNECTION
public static final int FLAG_RESOLVE_ENV_INFO_PROVIDER
protected static final java.lang.String NAME_SPACE
protected static final java.lang.String VERSION
protected static final java.lang.String CURRENT_VERSION
public static final java.lang.String BC4J_CONFIG
protected static final java.lang.String APP_MODULE_CONFIG_BAG
protected static final java.lang.String APP_MODULE_CONFIG_NAME
protected static final java.lang.String ATTR_CONFIG_NAME
public static final java.lang.String CONFIGURATION_NAME
public static final java.lang.String APPLICATION_NAME_PROPERTY
public static final java.lang.String APPMODULE_JNDI_NAME
public static final java.lang.String BC4J_CONFIG_NAME
public static final java.lang.String BC4J_CONFIG_NAMES
public static final java.lang.String APPLICATION_TYPE_PROPERTY
public static final java.lang.String APPLICATION_TYPE_VALUE_PACKAGE
public static final java.lang.String APPLICATION_TYPE_VALUE_APPMODULE
public static final java.lang.String DB_CONNECTION_PROPERTY
public static final java.lang.String DB_USERNAME_PROPERTY
public static final java.lang.String DB_PASSWORD_PROPERTY
public static final java.lang.String DB_CONNECT_STRING_PROPERTY
public static final java.lang.String DB_REQUIRES_CONNECTION
public static final java.lang.String DB_DATASOURCE_PROPERTY
public static final java.lang.String DB_DATASOURCE_USERNAME_PROPERTY
public static final java.lang.String DB_DATASOURCE_PASSWD_PROPERTY
public static final java.lang.String IS_INTERNAL
public static final java.lang.String JDBC_CONNECTION_NAME
public static final java.lang.String DT_DEPLOYMENTPROFILE
public static final java.lang.String DT_COMMONDEPLOYMENTPROFILE
public static final java.lang.String DT_MIDDLETIERDEPLOYMENTPROFILE
public static final java.lang.String IIOP_CONNECTION_NAME
public static final java.lang.String APPSERVER_CONNECTION_NAME
public static final java.lang.String HTTP_CONNECTION_NAME
public static final java.lang.String JDBC_DS_NAME
public static final java.lang.String O8I_CONNECT_STRING
public static final java.lang.String COMMON
public static final java.lang.String LAST_USED_CONFIGURATION
public static final java.lang.String DEFAULT_CONFIG_FILE_EXT
public static final java.lang.String DEFAULT_CONFIG_FILE
public static final java.lang.String DEFAULT_CONFIG_FILENAME
public static final java.lang.String TESTER_CONFIG_FILENAME
public static final java.lang.String JBO_COOKIE_HANDLE
protected XMLDocument configDocument
protected DOMParser domParser
Constructor Detail |
---|
public Configuration()
Method Detail |
---|
public static final java.lang.String getNameSpaceUri()
public boolean isOldVersion()
public static java.util.Hashtable getConfiguration(Node node)
node
-
protected final boolean isVersion11()
public void loadFromStream(java.io.InputStream in) throws JboException
in
- The input stream on the config file
JboException
public void loadFromReader(java.io.Reader reader) throws JboException
JboException
public void loadFromFile(java.lang.String configurationFileName) throws JboException
JboException
public void loadFromClassPath(java.lang.String classPathConfigurationFileName) throws JboException
classPathConfigurationFileName
- Package qualified name of the Configuration file.
The configuratin file named bc4j.xcfg is stored in the
common package of an AppModule
JboException
public java.util.Hashtable getConfiguration(java.lang.String configName) throws JboException
configName
- which was created in the design time
using the Configurations dialog.
JboException
- if the named Configuration is not foundpublic java.util.Hashtable getConfiguration(java.lang.String configName, boolean resolveConn)
configName
- which was created in the design time
using the Configurations dialog.resolveConn
- resolve the Configuration's named connection, if
it is defined.
JboException
- if the named Configuration is not foundpublic void getConfiguration(java.lang.String configName, java.util.Hashtable env) throws JboException
JboException
public void getConfiguration(java.lang.String configName, java.util.Hashtable env, boolean resolveConn)
public java.util.List getConfiguration(java.lang.String configName, java.util.Hashtable env, int flags)
public boolean isEmbeddedConfig(java.lang.String configName)
public static boolean isEmbeddedConfig(java.util.Hashtable env)
protected void addProperties(java.util.Hashtable h)
public java.lang.String[] getConfigurationNameList() throws JboException
JboException
- if the named Configuration is not foundpublic java.lang.String[] getConfigurationNameList(java.lang.String appName) throws JboException
appName
- the name of the application module
JboException
public java.lang.String[] getExternalConfigurationNameList()
public static java.lang.String buildConfigurationFileName(java.lang.String fileName)
fileName
- pass the name of the ApplicationModule package.,
ex., pass package10, for package10.Package10Module
public static java.lang.String buildConfigurationFileNameFromClassPath(java.lang.String packageName)
protected Node getConfigurationNode(java.lang.String name)
protected final java.lang.String getNameSpace()
protected NodeList getAppModuleConfigNodes()
protected Node getAppModuleConfigBagNode()
protected XMLDocument getXMLDocument(java.io.InputStream inputStream) throws JboException
JboException
protected XMLDocument getXMLDocument(java.io.Reader reader) throws JboException
JboException
public void initializeFromConnectionName(java.util.Hashtable ht)
protected void registerConnectionsFromDocument() throws JboException
JboException
public void createNewConnectionEntry(java.lang.String sName, java.util.Properties props)
protected void removeConnectionEntry(java.lang.String sName)
protected NodeList getConnectionDefinitionNodes()
protected final java.lang.String findProperty(Node n, java.lang.String propertyName)
protected void removeConfigurationProperty(java.lang.String configName, java.lang.String property)
public static void releaseRootApplicationModule(ApplicationModule appModule, boolean remove)
appModule
- an application module which was created with createRootApplicationModule(String, String, EnvInfoProvider)
remove
- indicates whether the application module should be removed
true: remove the application module
false: retain the application module for future usepublic static void releaseRootApplicationModuleHandle(ApplicationModuleHandle handle, boolean remove)
createRootApplicationModuleHandle(String, String)
. After release
the handle is no longer usable to obtain another application module
instance. An attempt to do so will throw an exception.
handle
- application module handle obtained from
createRootApplicationModuleHandle(String, String)
remove
- indicates whether the application module should be removedpublic static ApplicationModule createRootApplicationModule(java.lang.String qualifiedAMDefName, java.lang.String configName)
qualifiedAMDefName
- the package qualified application module definition nameconfigName
- the name ofthe configurationcreateRootApplicationModuleHandle(String, String)
public static ApplicationModule createRootApplicationModule(java.lang.String qualifiedAMDefName, java.lang.String configName, EnvInfoProvider envInfo)
qualifiedAMDefName
- the package qualified application module definition nameconfigName
- the name ofthe configurationenvInfo
- an EnvInfoProvider which may be used to provide additional
information when the application module is connectedcreateRootApplicationModuleHandle(String, String, EnvInfoProvider)
public ApplicationModule createRootApplicationModuleFromConfig(java.lang.String configName, EnvInfoProvider envInfo)
public static ApplicationModuleHandle createRootApplicationModuleHandle(java.lang.String qualifiedAMDefName, java.lang.String configName)
releaseRootApplicationModuleHandle(ApplicationModuleHandle, boolean)
.
e.g.)
This method is recommended overApplicationModuleHandle handle = Configuration.createRootApplicationModuleHandle("mypkg.AppModule", "AppModuleShared"); ApplicationModule sharedAM = handle.useApplicationModule(); ... Configuration.releaseRootApplicationModuleHandle(handle, false);
createRootApplicationModule(String, String)
for creating shared
application modules.
qualifiedAMDefName
- configName
- public static ApplicationModuleHandle createRootApplicationModuleHandle(java.lang.String qualifiedAMDefName, java.lang.String configName, EnvInfoProvider envInfo)
releaseRootApplicationModuleHandle(ApplicationModuleHandle, boolean)
.
This method is recommended over
createRootApplicationModule(String, String, EnvInfoProvider)
for
creating shared application modules.
qualifiedAMDefName
- the package qualified application module definition nameconfigName
- the name of configurationenvInfo
- an EnvInfoProvider which may be used to provide additional
information when the application module is connectedpublic static boolean wasCreatedByConfiguration(ApplicationModule appModule)
public static void main(java.lang.String[] args)
public static java.lang.String getPassword(Node node)
public static final java.lang.String getChecksumValue(java.lang.String pwd)
public static final java.lang.String getRestoredChecksumValue(java.lang.String pwd)
|
Oracle Fusion Middleware Java API Reference for Oracle ADF Model 11g Release 1 (11.1.1) E10653-04 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |