1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
-
- This file is part of the OpenLink Software Virtuoso Open-Source (VOS)
- project.
-
- Copyright (C) 1998-2018 OpenLink Software
-
- This project is free software; you can redistribute it and/or modify it
- under the terms of the GNU General Public License as published by the
- Free Software Foundation; only version 2 of the License, dated June 1991.
-
- This program 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
- General Public License for more details.
-
- You should have received a copy of the GNU General Public License along
- with this program; if not, write to the Free Software Foundation, Inc.,
- 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-
-
-->
<refentry id="fn_http_lock">
<refmeta>
<refentrytitle>http_lock</refentrytitle>
<refmiscinfo>ws</refmiscinfo>
</refmeta>
<refnamediv>
<refname>http_lock</refname>
<refpurpose>Locks the HTTP Web Server port</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_http_lock">
<funcprototype id="fproto_http_lock">
<funcdef>any <function>http_lock</function></funcdef>
<paramdef>in <parameter>pwd</parameter> varchar</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_http_lock"><title>Description</title>
<para>This function takes as parameter the password of the dba user, locks the HTTP Web Server port
and on any http access attempt shows the content of the html file given as value for the
<emphasis>MaintenancePage</emphasis> parameter in the Virtuoso ini [HTTPServer] section:</para>
<programlisting><![CDATA[
-- Virtuoso ini
...
[HTTPServer]
...
MaintenancePage = atomic.html
..
]]></programlisting>
<para>Note: the html file should be placed in the HTTP root.</para>
</refsect1>
<refsect1 id="params_http_lock"><title>Parameters</title>
<refsect2><title>pwd</title><para>The password of the dba user.</para></refsect2>
</refsect1>
<refsect1 id="examples_http_lock"><title>Examples</title>
<example id="ex_http_lock"><title>Simple Use</title>
<screen><![CDATA[
SQL> http_lock('password');
Done. -- 0 msec.
SQL>
]]></screen>
</example>
</refsect1>
<refsect1 id="seealso_http_lock">
<title>See Also</title>
<para><link linkend="fn_http_unlock"><function>http_unlock()</function></link></para>
</refsect1>
</refentry>
|
