<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Read-only Mode — Metacat 2.19.0 documentation</title>
<link rel="stylesheet" href="_static/bootstrap.min.css" type="text/css" />
<link rel="stylesheet" href="_static/font-awesome/css/font-awesome.min.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/metacatui.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '2.19.0',
COLLAPSE_MODINDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="top" title="Metacat 2.19.0 documentation" href="index.html" />
</head>
<body>
<div id="metacatDocs">
<div class="banner">
<a href="index.html"><img class="logo" src="_static/metacat-logo-white.png" /></a>
<a href="index.html"><h1 class="title">Metacat: Metadata and Data Management Server</h1></a>
<img class="logo-right" src="_static/nceas-logo-white.png" />
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right">
<span id="searchbox" style="display: none;">
<form class="search" action="search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" class="icon-search"/>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</span>
</li>
<script type="text/javascript">$('#searchbox').show(0);</script>
<li class="right">
<a href="genindex.html" title="General Index"
accesskey="I">index</a>
</li>
<li class="breadcrumb first"><a href="index.html">Metacat 2.19.0 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="read-only-mode">
<h1>Read-only Mode<a class="headerlink" href="#read-only-mode" title="Permalink to this headline">¶</a></h1>
<p>Metacat has a feature to place itself in a read-only mode - its content can NOT be
modified, however, can be read and searched. The default setting of Metacat is the
not-read-only mode. You may make Metacat read-only by setting the value of a property to “trueâ€
on the metacat.properties file, then restart Tomcat.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">application</span><span class="o">.</span><span class="n">readOnlyMode</span><span class="o">=</span><span class="n">true</span>
</pre></div>
</div>
<p>To cancel the read-only mode, set the property back to “falseâ€, then restart Tomcat.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">application</span><span class="o">.</span><span class="n">readOnlyMode</span><span class="o">=</span><span class="n">false</span>
</pre></div>
</div>
<p>When Metacat is in the read-only mode, the following Metacat and DataONE API
methods are disabled.</p>
<p><strong>Metacat API</strong>:</p>
<ul class="simple">
<li>upload</li>
<li>insert</li>
<li>update</li>
<li>delete</li>
<li>setaccess</li>
<li>buildindex</li>
<li>reindex</li>
<li>reindexall</li>
<li>scheduleWorkflow</li>
<li>unscheduleWorkflow</li>
<li>rescheduleWorkflow</li>
<li>deleteScheduledWorkflow</li>
<li>forcereplicatedatafile</li>
<li>forcereplicate</li>
<li>forcereplicatesystemmetadata</li>
<li>forcereplicatedelete</li>
<li>forcereplicatedeleteall</li>
<li>replicate.update</li>
<li>replicate.start</li>
</ul>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p><strong>DataONE Member Node API</strong>:</p>
<ul class="simple">
<li>MN.create</li>
<li>MN.update</li>
<li>MN.archive</li>
<li>MN.delete</li>
<li>MN.replicate</li>
<li>MN.systemMetadataChanged</li>
<li>MN.updateSystemMetadata</li>
</ul>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p>Mehtods on the DataONE Coordinating Node API are not disabled because the Coordinating Nodes currently have a different read-only mechanism.</p>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
<div class="footerNav">
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right">
<span id="searchbox" style="display: none;">
<form class="search" action="search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" class="icon-search"/>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</span>
</li>
<script type="text/javascript">$('#searchbox').show(0);</script>
<li class="right">
<a href="genindex.html" title="General Index"
>index</a>
</li>
<li class="breadcrumb first"><a href="index.html">Metacat 2.19.0 documentation</a> »</li>
</ul>
</div>
</div>
<div class="small-print">
© Copyright 2012, Regents of the University of California.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.6.7.
</div>
</div>
</div>
</body>
</html>