<h2>org.autoplot.servlet.ServletUtil</h2><p>Utilities for the servlets</p>
<h2>ServletUtil( )</h2>
<p></p>

<hr>
<a name="checkSecurity"></a>
<h2>checkSecurity</h2>
checkSecurity( HttpServletResponse response, <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> id, <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> suri, <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> vap ) &rarr; <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/autoplot/servlet/ServletUtil/SecurityResponse.html'>org.autoplot.servlet.ServletUtil.SecurityResponse</a>

<p>This checks the whitelist for the URI, and also inserts headers into the response.</p>

<h3>Parameters</h3>
response - a HttpServletResponse
<br>
id - null or the id, which is mapped to a URI.
<br>
suri - null or the uri.
<br>
vap - null or the vap

<h3>Returns:</h3>
true if the URI is whitelisted
<br><br>
<a href="https://github.com/autoplot/dev/search?q=checkSecurity&unscoped_q=checkSecurity">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/autoplot/servlet/ServletUtil.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/autoplot/servlet/ServletUtil.html#checkSecurity">[view on old javadoc]</a>
<br>
<br>
<hr>
<a name="dumpWhitelistToLogger"></a>
<h2>dumpWhitelistToLogger</h2>
dumpWhitelistToLogger( <a href='https://docs.oracle.com/javase/8/docs/api/java/util/logging/Level.html'>java.util.logging.Level</a> level ) &rarr; void

<p>dump the whitelist to the logger at the given level.</p>

<h3>Parameters</h3>
level - the level to log at.

<h3>Returns:</h3>
void (returns nothing)

<br><br>
<a href="https://github.com/autoplot/dev/search?q=dumpWhitelistToLogger&unscoped_q=dumpWhitelistToLogger">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/autoplot/servlet/ServletUtil.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/autoplot/servlet/ServletUtil.html#dumpWhitelistToLogger">[view on old javadoc]</a>
<br>
<br>
<hr>
<a name="getBlackList"></a>
<h2>getBlackList</h2>
getBlackList(  ) &rarr; <a href='https://docs.oracle.com/javase/8/docs/api/java/util/List.html'>java.util.List</a>

<p>return the blacklist, checking no more than once per 5 seconds, and
 creating the default file if one is not found.  
 See HOME/autoplot_data/server/blacklist.txt</p>

<h3>Returns:</h3>
list of regular expressions to allow.
<br><br>
<a href="https://github.com/autoplot/dev/search?q=getBlackList&unscoped_q=getBlackList">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/autoplot/servlet/ServletUtil.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/autoplot/servlet/ServletUtil.html#getBlackList">[view on old javadoc]</a>
<br>
<br>
<hr>
<a name="getIdMap"></a>
<h2>getIdMap</h2>
getIdMap(  ) &rarr; <a href='https://docs.oracle.com/javase/8/docs/api/java/util/Map.html'>java.util.Map</a>

<p>return the id map, checking no more than once per 5 seconds, and
 creating an empty file if one is not found.  
 See HOME/autoplot_data/server/</p>

<h3>Returns:</h3>
map from one string to another.
<br><br>
<a href="https://github.com/autoplot/dev/search?q=getIdMap&unscoped_q=getIdMap">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/autoplot/servlet/ServletUtil.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/autoplot/servlet/ServletUtil.html#getIdMap">[view on old javadoc]</a>
<br>
<br>
<hr>
<a name="getIntParameter"></a>
<h2>getIntParameter</h2>
getIntParameter( HttpServletRequest request, <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> name, int dval ) &rarr; int

<p></p>

<h3>Parameters</h3>
request - a HttpServletRequest
<br>
name - a String
<br>
dval - an int

<h3>Returns:</h3>
int

<br><br>
<a href="https://github.com/autoplot/dev/search?q=getIntParameter&unscoped_q=getIntParameter">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/autoplot/servlet/ServletUtil.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/autoplot/servlet/ServletUtil.html#getIntParameter">[view on old javadoc]</a>
<br>
<br>
<hr>
<a name="getServletContact"></a>
<h2>getServletContact</h2>
getServletContact(  ) &rarr; <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a>

<p>return the contact info for the server</p>

<h3>Returns:</h3>
a String

<br><br>
<a href="https://github.com/autoplot/dev/search?q=getServletContact&unscoped_q=getServletContact">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/autoplot/servlet/ServletUtil.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/autoplot/servlet/ServletUtil.html#getServletContact">[view on old javadoc]</a>
<br>
<br>
<hr>
<a name="getServletHome"></a>
<h2>getServletHome</h2>
getServletHome(  ) &rarr; <a href='https://docs.oracle.com/javase/8/docs/api/java/io/File.html'>java.io.File</a>

<p></p>

<h3>Returns:</h3>
java.io.File

<br><br>
<a href="https://github.com/autoplot/dev/search?q=getServletHome&unscoped_q=getServletHome">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/autoplot/servlet/ServletUtil.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/autoplot/servlet/ServletUtil.html#getServletHome">[view on old javadoc]</a>
<br>
<br>
<hr>
<a name="getStringParameter"></a>
<h2>getStringParameter</h2>
getStringParameter( HttpServletRequest request, <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> name, <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> dval ) &rarr; <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a>

<p></p>

<h3>Parameters</h3>
request - a HttpServletRequest
<br>
name - a String
<br>
dval - a String

<h3>Returns:</h3>
java.lang.String

<br><br>
<a href="https://github.com/autoplot/dev/search?q=getStringParameter&unscoped_q=getStringParameter">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/autoplot/servlet/ServletUtil.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/autoplot/servlet/ServletUtil.html#getStringParameter">[view on old javadoc]</a>
<br>
<br>
<hr>
<a name="getWhiteList"></a>
<h2>getWhiteList</h2>
getWhiteList(  ) &rarr; <a href='https://docs.oracle.com/javase/8/docs/api/java/util/List.html'>java.util.List</a>

<p>return the whitelist, checking no more than once per 5 seconds, and
 creating the default file if one is not found.  
 See HOME/autoplot_data/server/whitelist.txt</p>

<h3>Returns:</h3>
list of regular expressions to allow.
<br><br>
<a href="https://github.com/autoplot/dev/search?q=getWhiteList&unscoped_q=getWhiteList">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/autoplot/servlet/ServletUtil.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/autoplot/servlet/ServletUtil.html#getWhiteList">[view on old javadoc]</a>
<br>
<br>
<hr>
<a name="isBlacklisted"></a>
<h2>isBlacklisted</h2>
isBlacklisted( <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> suri ) &rarr; boolean

<p>return true if the suri is blacklisted, meaning we do not trust that 
 scripts and other content from from this address could harm the server.</p>

<h3>Parameters</h3>
suri - the uri.

<h3>Returns:</h3>
true if the suri is blacklisted.
<br><br>
<a href="https://github.com/autoplot/dev/search?q=isBlacklisted&unscoped_q=isBlacklisted">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/autoplot/servlet/ServletUtil.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/autoplot/servlet/ServletUtil.html#isBlacklisted">[view on old javadoc]</a>
<br>
<br>
<hr>
<a name="isWhitelisted"></a>
<h2>isWhitelisted</h2>
isWhitelisted( <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> suri ) &rarr; boolean

<p>return true if the suri is whitelisted, meaning we trust that 
 scripts and other content from from this address will not harm the server.
 This also checks the blacklist, and if the item is in the blacklist, 
 then it will not be whitelisted.</p>

<h3>Parameters</h3>
suri - the uri.

<h3>Returns:</h3>
true if the suri is whitelisted.
<br><br>
<a href="https://github.com/autoplot/dev/search?q=isWhitelisted&unscoped_q=isWhitelisted">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/autoplot/servlet/ServletUtil.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/autoplot/servlet/ServletUtil.html#isWhitelisted">[view on old javadoc]</a>
<br>
<br>
<hr>
<a name="securityCheckPart2"></a>
<h2>securityCheckPart2</h2>
securityCheckPart2( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/autoplot/servlet/ServletUtil/SecurityResponse.html'>org.autoplot.servlet.ServletUtil.SecurityResponse</a> sr ) &rarr; void

<p>this is the part that throws the exception if security violation occurs.</p>

<h3>Parameters</h3>
sr - a ServletUtil.SecurityResponse

<h3>Returns:</h3>
void (returns nothing)

<br><br>
<a href="https://github.com/autoplot/dev/search?q=securityCheckPart2&unscoped_q=securityCheckPart2">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/autoplot/servlet/ServletUtil.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/autoplot/servlet/ServletUtil.html#securityCheckPart2">[view on old javadoc]</a>
<br>
<br>