weblogic.management

Interface RuntimeDir

All Known Implementing Classes:

DomainDir.Instance, PartitionDir

public interface RuntimeDir

An interface that contains methods that provide an abstract for the domain or partition directory paths. It contains methods to get File and directory paths relative to the various directories in the domain. It does NOT contain methods that provide an abstract for individual files in the domain directories - that is the responsibility of the subsystems. The directory structure includes the following directories: Root Directory autodeploy bin config deployments lib_modules <...> diagnostics lib jdbc jms security startup init-info lib pending security servers data store default ldap logs security tmp tmp It also has utility methods to get File and directory paths relative to the RootDirectory When in a client, the RootDirectory defaults to the current directory. This can leave temporary files laying around for the client if users of this class are not careful. Clients can set the weblogic.RootDirectory property explicitly to avoid this.

Excluded in public API Reference.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RuntimeDir.Current

Method Summary

Modifier and Type	Method and Description
java.lang.String	dumpDirectories()
java.lang.String	getAppPollerDir()
java.lang.String	getBinDir() Returns the String representation of the path of the bin directory i.e.
java.lang.String	getBinDirForServer(java.lang.String serverName) Returns the String representation of the path of the running server's bin directory i.e.
java.lang.String	getCacheDirForServer(java.lang.String serverName) Returns the String representation of the path of the running server's cache directory i.e.
java.lang.String	getCAMConfigDir() Returns the String representation of the path of the CAM config directory i.e.
java.lang.String	getCAMPendingDir() Returns the String representation of the path of the CAM pending directory i.e.
java.lang.String	getConfigDir() Returns the String representation of the path of the config directory i.e.
java.lang.String	getConfigSecurityDir() Returns the String representation of the path of the config security directory i.e.
java.lang.String	getConfigStartupDir() Returns the String representation of the path of the config startup directory i.e.
java.lang.String	getDataDirForServer(java.lang.String serverName) Returns the String representation of the path of the running server's data directory i.e.
java.lang.String	getDeploymentsDir() Returns the String representation of the path of the config deployments directory i.e.
java.lang.String	getDeploymentsDirNonCanonical() Returns the String representation of the path of the config deployment directory i.e.
java.lang.String	getDiagnosticsDir() Returns the String representation of the path of the config diagnostics directory i.e.
java.lang.String	getDirForServer(java.lang.String serverName) Returns the string representation of the path of the specified server directory
java.lang.String	getDirForServerNonCanonical(java.lang.String serverName) Returns the string representation of the path of the specified server directory
java.lang.String	getEditDir() Returns the String representation of the path of the edit Directory i.e.
java.lang.String	getFMWConfigDir() Returns the String representation of the path of the fmwconfig directory i.e.
java.lang.String	getFMWServerConfigDir(java.lang.String serverName) Returns the String representation of the path for the JMX Framework server scoped config directory that correspond to the server instance whose name is passed as parameter i.e.
java.lang.String	getFMWServersConfigDir() Returns the String representation of the path for the JMX Framework servers scoped config directory i.e.
java.lang.String	getInitInfoDir() Returns the String representation of the path of the init-info Directory i.e.
java.lang.String	getJDBCDir() Returns the String representation of the path of the config jdbc directory i.e.
java.lang.String	getJMSDir() Returns the String representation of the path of the config jms directory i.e.
java.lang.String	getLDAPDataDirForServer(java.lang.String serverName) Returns the String representation of the path of the running server's LDAP data directory i.e.
java.lang.String	getLibDir() Returns the String representation of the path of the lib Directory i.e.
java.lang.String	getLibModulesDir() Returns the String representation of the path of the config deployments library modules directory i.e.
java.util.Set<java.lang.String>	getLocalServers() Return the name of the WLS servers for which configuration is available locally
java.lang.String	getLogsDirForServer(java.lang.String serverName) Returns the String representation of the path of the running server's logs directory i.e.
java.lang.String	getOldAppPollerDir()
java.lang.String	getOrchestrationWorkflowDir() Returns the String representation of the path of the workflow (orchestration) directory i.e.
java.lang.String	getPathRelativeBinDir(java.lang.String path) Returns path relative to bin directory
java.lang.String	getPathRelativeConfigDir(java.lang.String path) Returns path relative to config directory
java.lang.String	getPathRelativeConfigSecurityDir(java.lang.String path) Returns path relative to config security directory
java.lang.String	getPathRelativeConfigStartupDir(java.lang.String path) Returns path relative to config startup directory
java.lang.String	getPathRelativeDeploymentsDir(java.lang.String path) Returns path relative to config deployments directory
java.lang.String	getPathRelativeDiagnosticsDir(java.lang.String path) Returns path relative to config diagnostics directory
java.lang.String	getPathRelativeInitInfoDir(java.lang.String path) Returns path relative to init-info directory.
java.lang.String	getPathRelativeJDBCDir(java.lang.String path) Returns path relative to config jdbc directory
java.lang.String	getPathRelativeJMSDir(java.lang.String path) Returns path relative to config jms directory
java.lang.String	getPathRelativeLibDir(java.lang.String path) Returns path relative to lib directory.
java.lang.String	getPathRelativeLibModulesDir(java.lang.String path) Returns path relative to config deployments library modules directory
java.lang.String	getPathRelativePendingDir(java.lang.String path) Returns path relative to pending directory.
java.lang.String	getPathRelativeRootDir(java.lang.String path) Returns path relative to RootDirectory.
java.lang.String	getPathRelativeSecurityDir(java.lang.String path) Returns path relative to security directory.
java.lang.String	getPathRelativeServerDir(java.lang.String serverName, java.lang.String path) Returns path relative to server's directory.
java.lang.String	getPathRelativeServerDirNonCanonical(java.lang.String serverName, java.lang.String path) Returns path relative to server's directory in non-canonical form.
java.lang.String	getPathRelativeServersBinDir(java.lang.String serverName, java.lang.String path) Returns path relative to server's cache directory.
java.lang.String	getPathRelativeServersCacheDir(java.lang.String serverName, java.lang.String path) Returns path relative to server's cache directory.
java.lang.String	getPathRelativeServersDataDir(java.lang.String serverName, java.lang.String path) Returns path relative to server's data directory.
java.lang.String	getPathRelativeServersDir(java.lang.String path) Returns path relative to servers directory.
java.lang.String	getPathRelativeServersLDAPDataDir(java.lang.String serverName, java.lang.String path) Returns path relative to server's LDAP data directory.
java.lang.String	getPathRelativeServersLogsDir(java.lang.String serverName, java.lang.String path) Returns path relative to server's logs directory.
java.lang.String	getPathRelativeServersSecurityDir(java.lang.String serverName, java.lang.String path) Returns path relative to server's security directory.
java.lang.String	getPathRelativeServersStoreDataDir(java.lang.String serverName, java.lang.String path) Returns path relative to server's Store data directory.
java.lang.String	getPathRelativeServersTempDir(java.lang.String serverName, java.lang.String path) Returns path relative to server's tmp directory.
java.lang.String	getPathRelativeTempDir(java.lang.String path) Returns path relative to domain tmp directory.
java.lang.String	getPathRelativeToCAMConfigDir(java.lang.String path) Returns path relative to the CAM config directory
java.lang.String	getPathRelativeToFMWConfigDir(java.lang.String path) Returns path relative to the fmwconfig directory
java.lang.String	getPathRelativeToFMWServersConfigDir(java.lang.String path) Returns path relative to the JMX Framework servers scoped config directory
java.lang.String	getPendingDeploymentsDir(java.lang.String appName) Returns the directory where changes to the deployment configuration for an application are stored in the pending directory
java.lang.String	getPendingDir() Returns the String representation of the path of the pending Directory i.e.
java.lang.String	getRootDir() Returns the String representation of the path of the Root Directory (-Dweblogic.RootDirectory=) or if not passed in, it defaults to canonical equivalent of "."
java.lang.String	getRootDirNonCanonical() Returns the String representation of the path of the Root Directory (-Dweblogic.RootDirectory=) or if not passed in, it defaults to "."
java.lang.String	getSecurityDir() Returns the String representation of the path of the security directory i.e.
java.lang.String	getSecurityDirForServer(java.lang.String serverName) Returns the String representation of the path of the running server's security directory i.e.
java.lang.String	getServersDir() Returns the String representation of the path of the servers directory i.e.
java.lang.String	getServersDirNonCanonical() Returns the String representation of the path of the servers directory i.e.
java.lang.String	getStoreDataDirForServer(java.lang.String serverName) Returns the String representation of the path of the running server's store data directory i.e.
java.lang.String	getTempDir() Returns the String representation of the path of the tmp directory i.e.
java.lang.String	getTempDirForServer(java.lang.String serverName) Returns the String representation of the path of the running server's tmp directory i.e.
boolean	isFileRelativeToCAMConfigDir(java.io.File file) Returns true is the file instance passed as parameter is relative to the CAM config directory
boolean	isFileRelativeToFMWConfigDir(java.io.File file) Returns true is the file instance passed as parameter is relative to the fmwconfig directory
boolean	isFileRelativeToFMWServerConfigDir(java.io.File file, java.lang.String serverName) Returns true is the file instance passed as parameter is relative to the JMX Framework server scoped config directory for the server instance whose name is passed as parameter
boolean	isFileRelativeToFMWServersConfigDir(java.io.File file) Returns true is the file instance passed as parameter is relative to the JMX Framework servers scoped config directory
java.lang.String	removeRootDirectoryFromPath(java.lang.String filePath) Remove root directory from directory file path.
void	resetRootDirForExplicitUpgrade(java.lang.String path) FIXME: mousseau@bea.com This is only here to allow the same set of DomainDir methods to be used in both explicit and implicit upgrade.

Method Detail

getRootDir

java.lang.String getRootDir()

Returns the String representation of the path of the Root Directory (-Dweblogic.RootDirectory=) or if not passed in, it defaults to canonical equivalent of "."

getRootDirNonCanonical

java.lang.String getRootDirNonCanonical()

Returns the String representation of the path of the Root Directory (-Dweblogic.RootDirectory=) or if not passed in, it defaults to "."

getPathRelativeRootDir

java.lang.String getPathRelativeRootDir(java.lang.String path)

Returns path relative to RootDirectory.

getBinDir

java.lang.String getBinDir()

Returns the String representation of the path of the bin directory i.e. /config.

getPathRelativeBinDir

java.lang.String getPathRelativeBinDir(java.lang.String path)

Returns path relative to bin directory

getConfigDir

java.lang.String getConfigDir()

Returns the String representation of the path of the config directory i.e. /config.

getPathRelativeConfigDir

java.lang.String getPathRelativeConfigDir(java.lang.String path)

Returns path relative to config directory

getFMWConfigDir

java.lang.String getFMWConfigDir()

Returns the String representation of the path of the fmwconfig directory i.e. /config/fmwconfig.

getPathRelativeToFMWConfigDir

java.lang.String getPathRelativeToFMWConfigDir(java.lang.String path)

Returns path relative to the fmwconfig directory

isFileRelativeToFMWConfigDir

boolean isFileRelativeToFMWConfigDir(java.io.File file)

Returns true is the file instance passed as parameter is relative to the fmwconfig directory

getFMWServersConfigDir

java.lang.String getFMWServersConfigDir()

Returns the String representation of the path for the JMX Framework servers scoped config directory i.e. /config/fmwconfig/servers.

getPathRelativeToFMWServersConfigDir

java.lang.String getPathRelativeToFMWServersConfigDir(java.lang.String path)

Returns path relative to the JMX Framework servers scoped config directory

isFileRelativeToFMWServersConfigDir

boolean isFileRelativeToFMWServersConfigDir(java.io.File file)

Returns true is the file instance passed as parameter is relative to the JMX Framework servers scoped config directory

getFMWServerConfigDir

java.lang.String getFMWServerConfigDir(java.lang.String serverName)

Returns the String representation of the path for the JMX Framework server scoped config directory that correspond to the server instance whose name is passed as parameter i.e. /config/fmwconfig/servers/.

isFileRelativeToFMWServerConfigDir

boolean isFileRelativeToFMWServerConfigDir(java.io.File file,
                                           java.lang.String serverName)

Returns true is the file instance passed as parameter is relative to the JMX Framework server scoped config directory for the server instance whose name is passed as parameter

getLocalServers

java.util.Set<java.lang.String> getLocalServers()

Return the name of the WLS servers for which configuration is available locally

getCAMConfigDir

java.lang.String getCAMConfigDir()

Returns the String representation of the path of the CAM config directory i.e. /config/fmwconfig/components.

getCAMPendingDir

java.lang.String getCAMPendingDir()

Returns the String representation of the path of the CAM pending directory i.e. pending/fmwconfig/components.

getPathRelativeToCAMConfigDir

java.lang.String getPathRelativeToCAMConfigDir(java.lang.String path)

Returns path relative to the CAM config directory

isFileRelativeToCAMConfigDir

boolean isFileRelativeToCAMConfigDir(java.io.File file)

Returns true is the file instance passed as parameter is relative to the CAM config directory

getDeploymentsDir

java.lang.String getDeploymentsDir()

Returns the String representation of the path of the config deployments directory i.e. /config/deployments.

getPathRelativeDeploymentsDir

java.lang.String getPathRelativeDeploymentsDir(java.lang.String path)

Returns path relative to config deployments directory

getDiagnosticsDir

java.lang.String getDiagnosticsDir()

Returns the String representation of the path of the config diagnostics directory i.e. /config/diagnostics.

getPathRelativeDiagnosticsDir

java.lang.String getPathRelativeDiagnosticsDir(java.lang.String path)

Returns path relative to config diagnostics directory

getJDBCDir

java.lang.String getJDBCDir()

Returns the String representation of the path of the config jdbc directory i.e. /config/jdbc.

getPathRelativeJDBCDir

java.lang.String getPathRelativeJDBCDir(java.lang.String path)

Returns path relative to config jdbc directory

getJMSDir

java.lang.String getJMSDir()

Returns the String representation of the path of the config jms directory i.e. /config/jms.

getPathRelativeJMSDir

java.lang.String getPathRelativeJMSDir(java.lang.String path)

Returns path relative to config jms directory

getConfigSecurityDir

java.lang.String getConfigSecurityDir()

Returns the String representation of the path of the config security directory i.e. /config/security.

getPathRelativeConfigSecurityDir

java.lang.String getPathRelativeConfigSecurityDir(java.lang.String path)

Returns path relative to config security directory

getConfigStartupDir

java.lang.String getConfigStartupDir()

Returns the String representation of the path of the config startup directory i.e. /config/startup.

getPathRelativeConfigStartupDir

java.lang.String getPathRelativeConfigStartupDir(java.lang.String path)

Returns path relative to config startup directory

getLibModulesDir

java.lang.String getLibModulesDir()

Returns the String representation of the path of the config deployments library modules directory i.e. /config/deployments/lib_modules.

getPathRelativeLibModulesDir

java.lang.String getPathRelativeLibModulesDir(java.lang.String path)

Returns path relative to config deployments library modules directory

getInitInfoDir

java.lang.String getInitInfoDir()

Returns the String representation of the path of the init-info Directory i.e. /init-info.

getPathRelativeInitInfoDir

java.lang.String getPathRelativeInitInfoDir(java.lang.String path)

Returns path relative to init-info directory.

getLibDir

java.lang.String getLibDir()

Returns the String representation of the path of the lib Directory i.e. /lib.

getEditDir

java.lang.String getEditDir()

Returns the String representation of the path of the edit Directory i.e. /edit.

getPathRelativeLibDir

java.lang.String getPathRelativeLibDir(java.lang.String path)

Returns path relative to lib directory.

getPendingDir

java.lang.String getPendingDir()

Returns the String representation of the path of the pending Directory i.e. /pending.

getPathRelativePendingDir

java.lang.String getPathRelativePendingDir(java.lang.String path)

Returns path relative to pending directory.

getSecurityDir

java.lang.String getSecurityDir()

Returns the String representation of the path of the security directory i.e. /security.

getPathRelativeSecurityDir

java.lang.String getPathRelativeSecurityDir(java.lang.String path)

Returns path relative to security directory.

getServersDir

java.lang.String getServersDir()

Returns the String representation of the path of the servers directory i.e. /servers.

getServersDirNonCanonical

java.lang.String getServersDirNonCanonical()

Returns the String representation of the path of the servers directory i.e. /servers in non-canonical form.

getDeploymentsDirNonCanonical

java.lang.String getDeploymentsDirNonCanonical()

Returns the String representation of the path of the config deployment directory i.e. /config/deployments in non-canonical form.

getPathRelativeServersDir

java.lang.String getPathRelativeServersDir(java.lang.String path)

Returns path relative to servers directory.

getDirForServer

java.lang.String getDirForServer(java.lang.String serverName)

Returns the string representation of the path of the specified server directory

getDirForServerNonCanonical

java.lang.String getDirForServerNonCanonical(java.lang.String serverName)

Returns the string representation of the path of the specified server directory

getPathRelativeServerDir

java.lang.String getPathRelativeServerDir(java.lang.String serverName,
                                          java.lang.String path)

Returns path relative to server's directory.

getPathRelativeServerDirNonCanonical

java.lang.String getPathRelativeServerDirNonCanonical(java.lang.String serverName,
                                                      java.lang.String path)

Returns path relative to server's directory in non-canonical form.

getBinDirForServer

java.lang.String getBinDirForServer(java.lang.String serverName)

Returns the String representation of the path of the running server's bin directory i.e. /servers//bin

getPathRelativeServersBinDir

java.lang.String getPathRelativeServersBinDir(java.lang.String serverName,
                                              java.lang.String path)

Returns path relative to server's cache directory.

getCacheDirForServer

java.lang.String getCacheDirForServer(java.lang.String serverName)

Returns the String representation of the path of the running server's cache directory i.e. /servers//cache

getPathRelativeServersCacheDir

java.lang.String getPathRelativeServersCacheDir(java.lang.String serverName,
                                                java.lang.String path)

Returns path relative to server's cache directory.

getDataDirForServer

java.lang.String getDataDirForServer(java.lang.String serverName)

Returns the String representation of the path of the running server's data directory i.e. /servers//data

getPathRelativeServersDataDir

java.lang.String getPathRelativeServersDataDir(java.lang.String serverName,
                                               java.lang.String path)

Returns path relative to server's data directory.

getLDAPDataDirForServer

java.lang.String getLDAPDataDirForServer(java.lang.String serverName)

Returns the String representation of the path of the running server's LDAP data directory i.e. /servers//data/ldap

getPathRelativeServersLDAPDataDir

java.lang.String getPathRelativeServersLDAPDataDir(java.lang.String serverName,
                                                   java.lang.String path)

Returns path relative to server's LDAP data directory.

getStoreDataDirForServer

java.lang.String getStoreDataDirForServer(java.lang.String serverName)

Returns the String representation of the path of the running server's store data directory i.e. /servers//data/store

getPathRelativeServersStoreDataDir

java.lang.String getPathRelativeServersStoreDataDir(java.lang.String serverName,
                                                    java.lang.String path)

Returns path relative to server's Store data directory.

getLogsDirForServer

java.lang.String getLogsDirForServer(java.lang.String serverName)

Returns the String representation of the path of the running server's logs directory i.e. /servers//logs

getPathRelativeServersLogsDir

java.lang.String getPathRelativeServersLogsDir(java.lang.String serverName,
                                               java.lang.String path)

Returns path relative to server's logs directory.

getSecurityDirForServer

java.lang.String getSecurityDirForServer(java.lang.String serverName)

Returns the String representation of the path of the running server's security directory i.e. /servers//data

getPathRelativeServersSecurityDir

java.lang.String getPathRelativeServersSecurityDir(java.lang.String serverName,
                                                   java.lang.String path)

Returns path relative to server's security directory.

getTempDirForServer

java.lang.String getTempDirForServer(java.lang.String serverName)

Returns the String representation of the path of the running server's tmp directory i.e. /servers//tmp

getPathRelativeServersTempDir

java.lang.String getPathRelativeServersTempDir(java.lang.String serverName,
                                               java.lang.String path)

Returns path relative to server's tmp directory.

getTempDir

java.lang.String getTempDir()

Returns the String representation of the path of the tmp directory i.e. /tmp.

getPathRelativeTempDir

java.lang.String getPathRelativeTempDir(java.lang.String path)

Returns path relative to domain tmp directory.

getPendingDeploymentsDir

java.lang.String getPendingDeploymentsDir(java.lang.String appName)

Returns the directory where changes to the deployment configuration for an application are stored in the pending directory

resetRootDirForExplicitUpgrade

void resetRootDirForExplicitUpgrade(java.lang.String path)

FIXME: mousseau@bea.com This is only here to allow the same set of DomainDir methods to be used in both explicit and implicit upgrade. In the explicit upgrade scenario, rootDir defaults to '.' and results in incorrect path creation.

Parameters:

path - representing the config directory that is being explicitly upgraded

removeRootDirectoryFromPath

java.lang.String removeRootDirectoryFromPath(java.lang.String filePath)

Remove root directory from directory file path.

Returns:

String filepath without root directory

dumpDirectories

java.lang.String dumpDirectories()

getAppPollerDir

java.lang.String getAppPollerDir()

getOldAppPollerDir

java.lang.String getOldAppPollerDir()

getOrchestrationWorkflowDir

java.lang.String getOrchestrationWorkflowDir()

Returns the String representation of the path of the workflow (orchestration) directory i.e. /orchestration/workflow.