blob: 29c000afbd70a00791878cfce463bae174f21118 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Index (Fulcrum Crypto 1.0.9-SNAPSHOT API)</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Index (Fulcrum Crypto 1.0.9-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="overview-summary.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li>Use</li>
<li><a href="overview-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</li>
<li><a href="help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?index-all.html" target="_top">Frames</a></li>
<li><a href="index-all.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="contentContainer"><a href="#I:C">C</a>&nbsp;<a href="#I:D">D</a>&nbsp;<a href="#I:E">E</a>&nbsp;<a href="#I:G">G</a>&nbsp;<a href="#I:I">I</a>&nbsp;<a href="#I:J">J</a>&nbsp;<a href="#I:O">O</a>&nbsp;<a href="#I:R">R</a>&nbsp;<a href="#I:S">S</a>&nbsp;<a href="#I:U">U</a>&nbsp;<a name="I:C">
<!-- -->
</a>
<h2 class="title">C</h2>
<dl>
<dt><a href="org/apache/fulcrum/crypto/provider/ClearCrypt.html" title="class in org.apache.fulcrum.crypto.provider"><span class="typeNameLink">ClearCrypt</span></a> - Class in <a href="org/apache/fulcrum/crypto/provider/package-summary.html">org.apache.fulcrum.crypto.provider</a></dt>
<dd>
<div class="block">This is a dummy for "cleartext" encryption.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/fulcrum/crypto/provider/ClearCrypt.html#ClearCrypt--">ClearCrypt()</a></span> - Constructor for class org.apache.fulcrum.crypto.provider.<a href="org/apache/fulcrum/crypto/provider/ClearCrypt.html" title="class in org.apache.fulcrum.crypto.provider">ClearCrypt</a></dt>
<dd>
<div class="block">Constructor</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/fulcrum/crypto/DefaultCryptoService.html#configure-org.apache.avalon.framework.configuration.Configuration-">configure(Configuration)</a></span> - Method in class org.apache.fulcrum.crypto.<a href="org/apache/fulcrum/crypto/DefaultCryptoService.html" title="class in org.apache.fulcrum.crypto">DefaultCryptoService</a></dt>
<dd>
<div class="block">Avalon component lifecycle method</div>
</dd>
<dt><a href="org/apache/fulcrum/crypto/CryptoAlgorithm.html" title="interface in org.apache.fulcrum.crypto"><span class="typeNameLink">CryptoAlgorithm</span></a> - Interface in <a href="org/apache/fulcrum/crypto/package-summary.html">org.apache.fulcrum.crypto</a></dt>
<dd>
<div class="block">This interface describes the various Crypto Algorithms that are
handed out by the Crypto Service.</div>
</dd>
<dt><a href="org/apache/fulcrum/crypto/CryptoService.html" title="interface in org.apache.fulcrum.crypto"><span class="typeNameLink">CryptoService</span></a> - Interface in <a href="org/apache/fulcrum/crypto/package-summary.html">org.apache.fulcrum.crypto</a></dt>
<dd>
<div class="block">An implementation of CryptoService that uses either supplied crypto
Algorithms (provided in Fulcrum.properties) or tries to get them via
the normal java mechanisms if this fails.</div>
</dd>
</dl>
<a name="I:D">
<!-- -->
</a>
<h2 class="title">D</h2>
<dl>
<dt><span class="memberNameLink"><a href="org/apache/fulcrum/crypto/provider/JavaCrypt.html#DEFAULT_CIPHER">DEFAULT_CIPHER</a></span> - Static variable in class org.apache.fulcrum.crypto.provider.<a href="org/apache/fulcrum/crypto/provider/JavaCrypt.html" title="class in org.apache.fulcrum.crypto.provider">JavaCrypt</a></dt>
<dd>
<div class="block">The default cipher</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/fulcrum/crypto/provider/OldJavaCrypt.html#DEFAULT_CIPHER">DEFAULT_CIPHER</a></span> - Static variable in class org.apache.fulcrum.crypto.provider.<a href="org/apache/fulcrum/crypto/provider/OldJavaCrypt.html" title="class in org.apache.fulcrum.crypto.provider">OldJavaCrypt</a></dt>
<dd>
<div class="block">The default cipher</div>
</dd>
<dt><a href="org/apache/fulcrum/crypto/DefaultCryptoService.html" title="class in org.apache.fulcrum.crypto"><span class="typeNameLink">DefaultCryptoService</span></a> - Class in <a href="org/apache/fulcrum/crypto/package-summary.html">org.apache.fulcrum.crypto</a></dt>
<dd>
<div class="block">An implementation of CryptoService that uses either supplied crypto
Algorithms (provided in the component config xml file) or tries to get them
via the normal java mechanisms if this fails.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/fulcrum/crypto/DefaultCryptoService.html#DefaultCryptoService--">DefaultCryptoService()</a></span> - Constructor for class org.apache.fulcrum.crypto.<a href="org/apache/fulcrum/crypto/DefaultCryptoService.html" title="class in org.apache.fulcrum.crypto">DefaultCryptoService</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="org/apache/fulcrum/crypto/DefaultCryptoService.html#dispose--">dispose()</a></span> - Method in class org.apache.fulcrum.crypto.<a href="org/apache/fulcrum/crypto/DefaultCryptoService.html" title="class in org.apache.fulcrum.crypto">DefaultCryptoService</a></dt>
<dd>
<div class="block">Avalon component lifecycle method</div>
</dd>
</dl>
<a name="I:E">
<!-- -->
</a>
<h2 class="title">E</h2>
<dl>
<dt><span class="memberNameLink"><a href="org/apache/fulcrum/crypto/CryptoAlgorithm.html#encrypt-java.lang.String-">encrypt(String)</a></span> - Method in interface org.apache.fulcrum.crypto.<a href="org/apache/fulcrum/crypto/CryptoAlgorithm.html" title="interface in org.apache.fulcrum.crypto">CryptoAlgorithm</a></dt>
<dd>
<div class="block">Performs the actual encryption.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/fulcrum/crypto/provider/ClearCrypt.html#encrypt-java.lang.String-">encrypt(String)</a></span> - Method in class org.apache.fulcrum.crypto.provider.<a href="org/apache/fulcrum/crypto/provider/ClearCrypt.html" title="class in org.apache.fulcrum.crypto.provider">ClearCrypt</a></dt>
<dd>
<div class="block">This method performs no encryption and will simply
return the value passed</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/fulcrum/crypto/provider/JavaCrypt.html#encrypt-java.lang.String-">encrypt(String)</a></span> - Method in class org.apache.fulcrum.crypto.provider.<a href="org/apache/fulcrum/crypto/provider/JavaCrypt.html" title="class in org.apache.fulcrum.crypto.provider">JavaCrypt</a></dt>
<dd>
<div class="block">Encrypt the supplied string with the requested cipher</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/fulcrum/crypto/provider/OldJavaCrypt.html#encrypt-java.lang.String-">encrypt(String)</a></span> - Method in class org.apache.fulcrum.crypto.provider.<a href="org/apache/fulcrum/crypto/provider/OldJavaCrypt.html" title="class in org.apache.fulcrum.crypto.provider">OldJavaCrypt</a></dt>
<dd>
<div class="block">Encrypt the supplied string with the requested cipher</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/fulcrum/crypto/provider/UnixCrypt.html#encrypt-java.lang.String-">encrypt(String)</a></span> - Method in class org.apache.fulcrum.crypto.provider.<a href="org/apache/fulcrum/crypto/provider/UnixCrypt.html" title="class in org.apache.fulcrum.crypto.provider">UnixCrypt</a></dt>
<dd>
<div class="block">Encrypt the supplied string with the requested cipher</div>
</dd>
</dl>
<a name="I:G">
<!-- -->
</a>
<h2 class="title">G</h2>
<dl>
<dt><span class="memberNameLink"><a href="org/apache/fulcrum/crypto/CryptoService.html#getCryptoAlgorithm-java.lang.String-">getCryptoAlgorithm(String)</a></span> - Method in interface org.apache.fulcrum.crypto.<a href="org/apache/fulcrum/crypto/CryptoService.html" title="interface in org.apache.fulcrum.crypto">CryptoService</a></dt>
<dd>
<div class="block">Returns a CryptoAlgorithm Object which represents the requested
crypto algorithm.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/fulcrum/crypto/DefaultCryptoService.html#getCryptoAlgorithm-java.lang.String-">getCryptoAlgorithm(String)</a></span> - Method in class org.apache.fulcrum.crypto.<a href="org/apache/fulcrum/crypto/DefaultCryptoService.html" title="class in org.apache.fulcrum.crypto">DefaultCryptoService</a></dt>
<dd>
<div class="block">Returns a CryptoAlgorithm Object which represents the requested crypto
algorithm.</div>
</dd>
</dl>
<a name="I:I">
<!-- -->
</a>
<h2 class="title">I</h2>
<dl>
<dt><span class="memberNameLink"><a href="org/apache/fulcrum/crypto/DefaultCryptoService.html#initialize--">initialize()</a></span> - Method in class org.apache.fulcrum.crypto.<a href="org/apache/fulcrum/crypto/DefaultCryptoService.html" title="class in org.apache.fulcrum.crypto">DefaultCryptoService</a></dt>
<dd>
<div class="block">Initialize the service</div>
</dd>
</dl>
<a name="I:J">
<!-- -->
</a>
<h2 class="title">J</h2>
<dl>
<dt><a href="org/apache/fulcrum/crypto/provider/JavaCrypt.html" title="class in org.apache.fulcrum.crypto.provider"><span class="typeNameLink">JavaCrypt</span></a> - Class in <a href="org/apache/fulcrum/crypto/provider/package-summary.html">org.apache.fulcrum.crypto.provider</a></dt>
<dd>
<div class="block">Implements the normal java.security.MessageDigest stream cipers.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/fulcrum/crypto/provider/JavaCrypt.html#JavaCrypt--">JavaCrypt()</a></span> - Constructor for class org.apache.fulcrum.crypto.provider.<a href="org/apache/fulcrum/crypto/provider/JavaCrypt.html" title="class in org.apache.fulcrum.crypto.provider">JavaCrypt</a></dt>
<dd>
<div class="block">Constructor</div>
</dd>
</dl>
<a name="I:O">
<!-- -->
</a>
<h2 class="title">O</h2>
<dl>
<dt><a href="org/apache/fulcrum/crypto/provider/OldJavaCrypt.html" title="class in org.apache.fulcrum.crypto.provider"><span class="typeNameLink">OldJavaCrypt</span></a> - Class in <a href="org/apache/fulcrum/crypto/provider/package-summary.html">org.apache.fulcrum.crypto.provider</a></dt>
<dd>
<div class="block">This is the Message Digest Implementation of Turbine 2.1.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/fulcrum/crypto/provider/OldJavaCrypt.html#OldJavaCrypt--">OldJavaCrypt()</a></span> - Constructor for class org.apache.fulcrum.crypto.provider.<a href="org/apache/fulcrum/crypto/provider/OldJavaCrypt.html" title="class in org.apache.fulcrum.crypto.provider">OldJavaCrypt</a></dt>
<dd>
<div class="block">Constructor</div>
</dd>
<dt><a href="org/apache/fulcrum/crypto/package-summary.html">org.apache.fulcrum.crypto</a> - package org.apache.fulcrum.crypto</dt>
<dd>
<div class="block">Contains the Crypto Service providing you with a variety of Crypto algorithms.</div>
</dd>
<dt><a href="org/apache/fulcrum/crypto/provider/package-summary.html">org.apache.fulcrum.crypto.provider</a> - package org.apache.fulcrum.crypto.provider</dt>
<dd>
<div class="block">Algorithm providers for the Crypto Service.</div>
</dd>
</dl>
<a name="I:R">
<!-- -->
</a>
<h2 class="title">R</h2>
<dl>
<dt><span class="memberNameLink"><a href="org/apache/fulcrum/crypto/CryptoService.html#ROLE">ROLE</a></span> - Static variable in interface org.apache.fulcrum.crypto.<a href="org/apache/fulcrum/crypto/CryptoService.html" title="interface in org.apache.fulcrum.crypto">CryptoService</a></dt>
<dd>&nbsp;</dd>
</dl>
<a name="I:S">
<!-- -->
</a>
<h2 class="title">S</h2>
<dl>
<dt><span class="memberNameLink"><a href="org/apache/fulcrum/crypto/CryptoAlgorithm.html#setCipher-java.lang.String-">setCipher(String)</a></span> - Method in interface org.apache.fulcrum.crypto.<a href="org/apache/fulcrum/crypto/CryptoAlgorithm.html" title="interface in org.apache.fulcrum.crypto">CryptoAlgorithm</a></dt>
<dd>
<div class="block">Algorithms that perform multiple ciphers get told
with setCipher, which cipher to use.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/fulcrum/crypto/provider/ClearCrypt.html#setCipher-java.lang.String-">setCipher(String)</a></span> - Method in class org.apache.fulcrum.crypto.provider.<a href="org/apache/fulcrum/crypto/provider/ClearCrypt.html" title="class in org.apache.fulcrum.crypto.provider">ClearCrypt</a></dt>
<dd>
<div class="block">This class never uses an algorithm, so this is just a dummy.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/fulcrum/crypto/provider/JavaCrypt.html#setCipher-java.lang.String-">setCipher(String)</a></span> - Method in class org.apache.fulcrum.crypto.provider.<a href="org/apache/fulcrum/crypto/provider/JavaCrypt.html" title="class in org.apache.fulcrum.crypto.provider">JavaCrypt</a></dt>
<dd>
<div class="block">Setting the actual cipher requested.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/fulcrum/crypto/provider/OldJavaCrypt.html#setCipher-java.lang.String-">setCipher(String)</a></span> - Method in class org.apache.fulcrum.crypto.provider.<a href="org/apache/fulcrum/crypto/provider/OldJavaCrypt.html" title="class in org.apache.fulcrum.crypto.provider">OldJavaCrypt</a></dt>
<dd>
<div class="block">Setting the actual cipher requested.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/fulcrum/crypto/provider/UnixCrypt.html#setCipher-java.lang.String-">setCipher(String)</a></span> - Method in class org.apache.fulcrum.crypto.provider.<a href="org/apache/fulcrum/crypto/provider/UnixCrypt.html" title="class in org.apache.fulcrum.crypto.provider">UnixCrypt</a></dt>
<dd>
<div class="block">This class never uses anything but UnixCrypt, so it is just a dummy (Fixme:
Should we throw an exception if something is requested that we don't support?</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/fulcrum/crypto/CryptoAlgorithm.html#setSeed-java.lang.String-">setSeed(String)</a></span> - Method in interface org.apache.fulcrum.crypto.<a href="org/apache/fulcrum/crypto/CryptoAlgorithm.html" title="interface in org.apache.fulcrum.crypto">CryptoAlgorithm</a></dt>
<dd>
<div class="block">Allows the user to set a salt value whenever the
algorithm is used.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/fulcrum/crypto/provider/ClearCrypt.html#setSeed-java.lang.String-">setSeed(String)</a></span> - Method in class org.apache.fulcrum.crypto.provider.<a href="org/apache/fulcrum/crypto/provider/ClearCrypt.html" title="class in org.apache.fulcrum.crypto.provider">ClearCrypt</a></dt>
<dd>
<div class="block">This class never uses a seed, so this is just a dummy.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/fulcrum/crypto/provider/JavaCrypt.html#setSeed-java.lang.String-">setSeed(String)</a></span> - Method in class org.apache.fulcrum.crypto.provider.<a href="org/apache/fulcrum/crypto/provider/JavaCrypt.html" title="class in org.apache.fulcrum.crypto.provider">JavaCrypt</a></dt>
<dd>
<div class="block">This class never uses a seed, so this is just a dummy.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/fulcrum/crypto/provider/OldJavaCrypt.html#setSeed-java.lang.String-">setSeed(String)</a></span> - Method in class org.apache.fulcrum.crypto.provider.<a href="org/apache/fulcrum/crypto/provider/OldJavaCrypt.html" title="class in org.apache.fulcrum.crypto.provider">OldJavaCrypt</a></dt>
<dd>
<div class="block">This class never uses a seed, so this is just a dummy.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/fulcrum/crypto/provider/UnixCrypt.html#setSeed-java.lang.String-">setSeed(String)</a></span> - Method in class org.apache.fulcrum.crypto.provider.<a href="org/apache/fulcrum/crypto/provider/UnixCrypt.html" title="class in org.apache.fulcrum.crypto.provider">UnixCrypt</a></dt>
<dd>
<div class="block">Setting the seed for the UnixCrypt algorithm.</div>
</dd>
</dl>
<a name="I:U">
<!-- -->
</a>
<h2 class="title">U</h2>
<dl>
<dt><a href="org/apache/fulcrum/crypto/provider/UnixCrypt.html" title="class in org.apache.fulcrum.crypto.provider"><span class="typeNameLink">UnixCrypt</span></a> - Class in <a href="org/apache/fulcrum/crypto/provider/package-summary.html">org.apache.fulcrum.crypto.provider</a></dt>
<dd>
<div class="block">Implements Standard Unix crypt(3) for use with the Crypto Service.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/fulcrum/crypto/provider/UnixCrypt.html#UnixCrypt--">UnixCrypt()</a></span> - Constructor for class org.apache.fulcrum.crypto.provider.<a href="org/apache/fulcrum/crypto/provider/UnixCrypt.html" title="class in org.apache.fulcrum.crypto.provider">UnixCrypt</a></dt>
<dd>
<div class="block">Constructor</div>
</dd>
</dl>
<a href="#I:C">C</a>&nbsp;<a href="#I:D">D</a>&nbsp;<a href="#I:E">E</a>&nbsp;<a href="#I:G">G</a>&nbsp;<a href="#I:I">I</a>&nbsp;<a href="#I:J">J</a>&nbsp;<a href="#I:O">O</a>&nbsp;<a href="#I:R">R</a>&nbsp;<a href="#I:S">S</a>&nbsp;<a href="#I:U">U</a>&nbsp;</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="overview-summary.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li>Use</li>
<li><a href="overview-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</li>
<li><a href="help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?index-all.html" target="_top">Frames</a></li>
<li><a href="index-all.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2005&#x2013;1970 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>