INTEGRATION: CWS jl13 (1.1.2); FILE ADDED

2004/10/20 15:50:24 jl 1.1.2.7: #29390#
2004/10/20 14:22:15 jl 1.1.2.6: #i29390#
2004/10/20 13:30:38 jl 1.1.2.5: #i29390#
2004/10/08 17:31:03 jl 1.1.2.4: #29930#
2004/10/05 15:22:11 jl 1.1.2.3: #i29390#
2004/10/05 10:45:37 jl 1.1.2.2: #i29390#
2004/09/29 13:41:25 jl 1.1.2.1: #i29390#

jvmfwk/source/fwkbase.hxx

+/*************************************************************************
+ *
+ *  $RCSfile: fwkbase.hxx,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: hr $ $Date: 2004-11-09 14:00:47 $
+ *
+ *  The Contents of this file are made available subject to the terms of
+ *  either of the following licenses
+ *
+ *         - GNU Lesser General Public License Version 2.1
+ *         - Sun Industry Standards Source License Version 1.1
+ *
+ *  Sun Microsystems Inc., October, 2000
+ *
+ *  GNU Lesser General Public License Version 2.1
+ *  =============================================
+ *  Copyright 2000 by Sun Microsystems, Inc.
+ *  901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ *  This library is free software; you can redistribute it and/or
+ *  modify it under the terms of the GNU Lesser General Public
+ *  License version 2.1, as published by the Free Software Foundation.
+ *
+ *  This library is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ *  Lesser General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Lesser General Public
+ *  License along with this library; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ *  MA  02111-1307  USA
+ *
+ *
+ *  Sun Industry Standards Source License Version 1.1
+ *  =================================================
+ *  The contents of this file are subject to the Sun Industry Standards
+ *  Source License Version 1.1 (the "License"); You may not use this file
+ *  except in compliance with the License. You may obtain a copy of the
+ *  License at http://www.openoffice.org/license.html.
+ *
+ *  Software provided under this License is provided on an "AS IS" basis,
+ *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
+ *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
+ *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
+ *  See the License for the specific provisions governing your rights and
+ *  obligations concerning the Software.
+ *
+ *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
+ *
+ *  Copyright: 2000 by Sun Microsystems, Inc.
+ *
+ *  All Rights Reserved.
+ *
+ *  Contributor(s): _______________________________________
+ *
+ *
+ ************************************************************************/
+#if !defined INCLUDED_JVMFWK_FWKBASE_HXX
+#define INCLUDED_JVMFWK_FWKBASE_HXX
+#include "rtl/ustring.hxx"
+#include "libxmlutil.hxx"
+namespace jfw
+{
+
+class VendorSettings
+{
+    CXmlDocPtr m_xmlDocVendorSettings;
+    CXPathContextPtr m_xmlPathContextVendorSettings;
+
+public:
+    VendorSettings();
+
+    /** Gets all plugin library URLs with the corresponding vendor name.
+
+    It uses the /javaSelection/plugins/library element from the javavendors.xml
+    to locate the library.
+    Is is verified that the plug-in exist. If a plug-in does not exist then an
+    exception is thrown containing the error JFW_E_CONFIGURATION
+    */
+    std::vector<PluginLibrary> getPluginData();
+
+    /* returns the file URL to the plugin.
+
+       If the param is empty, then the library is returned provided
+       by the bootstrap variable UNO_JAVA_JFW_PLUGIN. If the variable is
+       not set then an exception is thrown.
+
+     */
+    rtl::OUString getPluginLibrary(const rtl::OUString& sVendor);
+
+    VersionInfo getVersionInformation(const rtl::OUString & sVendor);
+
+    std::vector<rtl::OUString> getSupportedVendors();
+};
+
+/* The class offers functions to retrieve verified bootstrap parameters.
+ */
+namespace  BootParams
+{
+/* Gets the bootstrap variable UNO_JAVA_JFW_PLUGIN and verifies
+   if the file exist.
+   If it does not exist or it it no valid URL or the URL point not
+   to a file then an exception is thrown. The URL can also point to
+   a link to a file.
+
+   Setting this bootstrap parameter one does not need to specify a
+   javavendors.xml (UNO_JAVA_JFW_VENDOR_SETTINGS). If it is also set
+   then an exception is thrown.
+*/
+rtl::OUString getPlugin();
+
+/* Gets the bootstrap variable UNO_JAVA_JFW_DISABLE.
+   If false is returned, then UNO_JAVA_JFW_DISABLE was not set.
+   That is Java can be used.
+ */
+bool getDisable();
+
+/* Gets the file URL to the JRE which has been determined by the
+   bootstrap parameter UNO_JAVA_JFW_JREHOME or UNO_JAVA_JFW_ENV_JREHOME.
+
+   In direct mode either of them must be set. If not an exception is thrown.
+*/
+rtl::OUString getJREHome();
+
+::std::vector<rtl::OString> getVMParameters();
+
+rtl::OUString getUserData();
+
+rtl::OUString getSharedData();
+
+
+/* returns the file URL to the vendor settings xml file.
+
+   This file is not needed when UNO_JAVA_JFW_PLUGIN is set.
+   If it is also set then an exception is thrown.
+ */
+rtl::OUString getVendorSettings();
+
+/* User the parameter UNO_JAVA_JFW_CLASSPATH and UNO_JAVA_JFW_ENV_CLASSPATH
+   to compose a classpath
+ */
+rtl::OString getClasspath();
+
+rtl::OUString getClasspathUrls();
+
+} //end namespace
+
+
+/** Get the file URL to the javasettings.xml
+        If the file does not exist yet, then an
+        empty string is returned.
+
+        @throws FrameworkException
+    */
+//rtl::OUString getUserSettingsURL();
+
+
+
+
+enum JFW_MODE
+{
+    JFW_MODE_APPLICATION,
+
+    JFW_MODE_DIRECT
+};
+
+JFW_MODE getMode();
+
+/** creates the -Djava.class.path option with the complete classpath.
+    If param mode is JFW_MODE_ENV_SIMPLE then the param javaSettings is ignored.
+ */
+rtl::OString makeClassPathOption(CNodeJava & javaSettings);
+
+/** Get the system path to the javasettings.xml
+    Converts the URL returned from getUserSettingsURL to a
+    Systempath. An empty string is returned if the file
+    does not exist.
+   @throws FrameworkException
+ */
+rtl::OString getUserSettingsPath();
+
+/* returns the system path to the file where the
+   user data is to be stored.
+*/
+rtl::OString getUserSettingsStoreLocation();
+
+/** Returns the system path of the share settings file.
+    Returns a valid string or throws an exception.
+   @throws FrameworkException
+ */
+rtl::OString getSharedSettingsPath();
+
+/* Determines the application base which is either the BaseInstallation
+   (see getBaseInstallation) or the directory where the executable is resides.
+
+   This function always returns a URL or throws an exception.
+*/
+rtl::OUString getApplicationBase();
+
+
+/* returns a valid string or throws an exception.
+   @throws FrameworkException
+ */
+rtl::OString getVendorSettingsPath();
+
+rtl::OUString buildClassPathFromDirectory(const rtl::OUString & relPath);
+
+/** Called from writeJavaInfoData. It sets the process identifier. When
+java is to be started, then the current id is compared to the one set by
+this function. If they are identical then the Java was selected in the
+same process. If that Java needs a prepared environment, such as a
+LD_LIBRARY_PATH, then it must not be started in this process.
+*/
+void setJavaSelected();
+
+/** Determines if the currently selected Java was set in this process.
+
+    @see setProcessId()
+ */
+bool wasJavaSelectedInSameProcess();
+/* Only for application mode.
+ */
+rtl::OUString getApplicationClassPath();
+}
+
+#endif