jvmfwk/source/fwkbase.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #if !defined INCLUDED_JVMFWK_FWKBASE_HXX
  29 #define INCLUDED_JVMFWK_FWKBASE_HXX
  30 #include "rtl/ustring.hxx"
  31 #include "libxmlutil.hxx"
  32 namespace jfw
  33 {
  34
  35 class VendorSettings
  36 {
  37     ::rtl::OUString m_xmlDocVendorSettingsFileUrl;
  38     CXmlDocPtr m_xmlDocVendorSettings;
  39     CXPathContextPtr m_xmlPathContextVendorSettings;
  40
  41 public:
  42     VendorSettings();
  43
  44     /** Gets all plugin library URLs with the corresponding vendor name.
  45
  46     It uses the /javaSelection/plugins/library element from the javavendors.xml
  47     to locate the library.
  48     Is is verified that the plug-in exist. If a plug-in does not exist then an
  49     exception is thrown containing the error JFW_E_CONFIGURATION
  50     */
  51     ::std::vector<PluginLibrary> getPluginData();
  52
  53     /* returns the file URL to the plugin.
  54      */
  55     ::rtl::OUString getPluginLibrary(const ::rtl::OUString& sVendor);
  56
  57     VersionInfo getVersionInformation(const ::rtl::OUString & sVendor);
  58
  59     ::std::vector< ::rtl::OUString> getSupportedVendors();
  60 };
  61
  62 /* The class offers functions to retrieve verified bootstrap parameters.
  63  */
  64 namespace  BootParams
  65 {
  66
  67 /* Gets the file URL to the JRE which has been determined by the
  68    bootstrap parameter UNO_JAVA_JFW_JREHOME or UNO_JAVA_JFW_ENV_JREHOME.
  69
  70    In direct mode either of them must be set. If not an exception is thrown.
  71 */
  72 ::rtl::OUString getJREHome();
  73
  74 ::std::vector< ::rtl::OString> getVMParameters();
  75
  76 ::rtl::OUString getUserData();
  77
  78 ::rtl::OUString getSharedData();
  79
  80 ::rtl::OUString getInstallData();
  81 /* returns the file URL to the vendor settings xml file.
  82  */
  83 ::rtl::OUString getVendorSettings();
  84
  85 /* User the parameter UNO_JAVA_JFW_CLASSPATH and UNO_JAVA_JFW_ENV_CLASSPATH
  86    to compose a classpath
  87  */
  88 ::rtl::OString getClasspath();
  89
  90 ::rtl::OUString getClasspathUrls();
  91
  92 /** returns the content of UNO_JAVA_JFW_INSTALL_EXPIRE or a pretermined
  93     value. If the bootstrap variable contains a string that cannot be
  94     converted by OUString then it returns the predetermined value.
  95 */
  96 ::sal_uInt32 getInstallDataExpiration();
  97
  98 } //end namespace
  99
 100
 101
 102 enum JFW_MODE
 103 {
 104     JFW_MODE_APPLICATION,
 105
 106     JFW_MODE_DIRECT
 107 };
 108
 109 JFW_MODE getMode();
 110
 111 /** creates the -Djava.class.path option with the complete classpath, including
 112     the paths which are set by UNO_JAVA_JFW_CLASSPATH_URLS.
 113  */
 114 ::rtl::OString makeClassPathOption(::rtl::OUString const & sUserClassPath);
 115
 116 ::rtl::OString getSettingsPath( const ::rtl::OUString & sURL);
 117
 118 /** Get the system path to the javasettings.xml
 119     Converts the URL returned from getUserSettingsURL to a
 120     Systempath. An empty string is returned if the file
 121     does not exist.
 122    @throws FrameworkException
 123  */
 124 ::rtl::OString getUserSettingsPath();
 125
 126 ::rtl::OString getInstallSettingsPath();
 127
 128 /** Returns the system path of the share settings file.
 129     Returns a valid string or throws an exception.
 130    @throws FrameworkException
 131  */
 132 ::rtl::OString getSharedSettingsPath();
 133
 134 /* returns a valid string or throws an exception.
 135    @throws FrameworkException
 136  */
 137 ::rtl::OString getVendorSettingsPath();
 138
 139 ::rtl::OUString buildClassPathFromDirectory(const ::rtl::OUString & relPath);
 140
 141 /** Called from writeJavaInfoData. It sets the process identifier. When
 142 java is to be started, then the current id is compared to the one set by
 143 this function. If they are identical then the Java was selected in the
 144 same process. If that Java needs a prepared environment, such as a
 145 LD_LIBRARY_PATH, then it must not be started in this process.
 146 */
 147 void setJavaSelected();
 148
 149 /** Determines if the currently selected Java was set in this process.
 150
 151     @see setProcessId()
 152  */
 153 bool wasJavaSelectedInSameProcess();
 154 /* Only for application mode.
 155  */
 156 ::rtl::OUString getApplicationClassPath();
 157 }
 158
 159 #endif
 160
 161 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */