Files
sshj/javadoc/0.4.1/net/schmizz/sshj/common/Factory.Named.html
Shikhar Bhushan 343555a1f0 javadoc for 0.4.1
2011-06-19 18:43:26 +01:00

264 lines
15 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_24) on Sun Jun 19 18:32:27 BST 2011 -->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
Factory.Named (sshj 0.4.1 API)
</TITLE>
<META NAME="date" CONTENT="2011-06-19">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Factory.Named (sshj 0.4.1 API)";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Factory.Named.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../net/schmizz/sshj/common/Factory.html" title="interface in net.schmizz.sshj.common"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../net/schmizz/sshj/common/Factory.Named.Util.html" title="class in net.schmizz.sshj.common"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?net/schmizz/sshj/common/Factory.Named.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="Factory.Named.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
net.schmizz.sshj.common</FONT>
<BR>
Interface Factory.Named&lt;T&gt;</H2>
<DL>
<DT><DT><B>Type Parameters:</B><DD><CODE>T</CODE> - type of object created by this factory</DL>
<DL>
<DT><B>All Superinterfaces:</B> <DD><A HREF="../../../../net/schmizz/sshj/common/Factory.html" title="interface in net.schmizz.sshj.common">Factory</A>&lt;T&gt;</DD>
</DL>
<DL>
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../net/schmizz/sshj/transport/cipher/AES128CBC.Factory.html" title="class in net.schmizz.sshj.transport.cipher">AES128CBC.Factory</A>, <A HREF="../../../../net/schmizz/sshj/transport/cipher/AES128CTR.Factory.html" title="class in net.schmizz.sshj.transport.cipher">AES128CTR.Factory</A>, <A HREF="../../../../net/schmizz/sshj/transport/cipher/AES192CBC.Factory.html" title="class in net.schmizz.sshj.transport.cipher">AES192CBC.Factory</A>, <A HREF="../../../../net/schmizz/sshj/transport/cipher/AES192CTR.Factory.html" title="class in net.schmizz.sshj.transport.cipher">AES192CTR.Factory</A>, <A HREF="../../../../net/schmizz/sshj/transport/cipher/AES256CBC.Factory.html" title="class in net.schmizz.sshj.transport.cipher">AES256CBC.Factory</A>, <A HREF="../../../../net/schmizz/sshj/transport/cipher/AES256CTR.Factory.html" title="class in net.schmizz.sshj.transport.cipher">AES256CTR.Factory</A>, <A HREF="../../../../net/schmizz/sshj/transport/cipher/BlowfishCBC.Factory.html" title="class in net.schmizz.sshj.transport.cipher">BlowfishCBC.Factory</A>, <A HREF="../../../../net/schmizz/sshj/transport/compression/DelayedZlibCompression.Factory.html" title="class in net.schmizz.sshj.transport.compression">DelayedZlibCompression.Factory</A>, <A HREF="../../../../net/schmizz/sshj/transport/kex/DHG1.Factory.html" title="class in net.schmizz.sshj.transport.kex">DHG1.Factory</A>, <A HREF="../../../../net/schmizz/sshj/transport/kex/DHG14.Factory.html" title="class in net.schmizz.sshj.transport.kex">DHG14.Factory</A>, <A HREF="../../../../net/schmizz/sshj/transport/mac/HMACMD5.Factory.html" title="class in net.schmizz.sshj.transport.mac">HMACMD5.Factory</A>, <A HREF="../../../../net/schmizz/sshj/transport/mac/HMACMD596.Factory.html" title="class in net.schmizz.sshj.transport.mac">HMACMD596.Factory</A>, <A HREF="../../../../net/schmizz/sshj/transport/mac/HMACSHA1.Factory.html" title="class in net.schmizz.sshj.transport.mac">HMACSHA1.Factory</A>, <A HREF="../../../../net/schmizz/sshj/transport/mac/HMACSHA196.Factory.html" title="class in net.schmizz.sshj.transport.mac">HMACSHA196.Factory</A>, <A HREF="../../../../net/schmizz/sshj/transport/random/JCERandom.Factory.html" title="class in net.schmizz.sshj.transport.random">JCERandom.Factory</A>, <A HREF="../../../../net/schmizz/sshj/transport/digest/MD5.Factory.html" title="class in net.schmizz.sshj.transport.digest">MD5.Factory</A>, <A HREF="../../../../net/schmizz/sshj/transport/cipher/NoneCipher.Factory.html" title="class in net.schmizz.sshj.transport.cipher">NoneCipher.Factory</A>, <A HREF="../../../../net/schmizz/sshj/transport/compression/NoneCompression.Factory.html" title="class in net.schmizz.sshj.transport.compression">NoneCompression.Factory</A>, <A HREF="../../../../net/schmizz/sshj/userauth/keyprovider/OpenSSHKeyFile.Factory.html" title="class in net.schmizz.sshj.userauth.keyprovider">OpenSSHKeyFile.Factory</A>, <A HREF="../../../../net/schmizz/sshj/userauth/keyprovider/PKCS8KeyFile.Factory.html" title="class in net.schmizz.sshj.userauth.keyprovider">PKCS8KeyFile.Factory</A>, <A HREF="../../../../net/schmizz/sshj/transport/digest/SHA1.Factory.html" title="class in net.schmizz.sshj.transport.digest">SHA1.Factory</A>, <A HREF="../../../../net/schmizz/sshj/signature/SignatureDSA.Factory.html" title="class in net.schmizz.sshj.signature">SignatureDSA.Factory</A>, <A HREF="../../../../net/schmizz/sshj/signature/SignatureRSA.Factory.html" title="class in net.schmizz.sshj.signature">SignatureRSA.Factory</A>, <A HREF="../../../../net/schmizz/sshj/transport/cipher/TripleDESCBC.Factory.html" title="class in net.schmizz.sshj.transport.cipher">TripleDESCBC.Factory</A>, <A HREF="../../../../net/schmizz/sshj/transport/compression/ZlibCompression.Factory.html" title="class in net.schmizz.sshj.transport.compression">ZlibCompression.Factory</A></DD>
</DL>
<DL>
<DT><B>Enclosing interface:</B><DD><A HREF="../../../../net/schmizz/sshj/common/Factory.html" title="interface in net.schmizz.sshj.common">Factory</A>&lt;<A HREF="../../../../net/schmizz/sshj/common/Factory.html" title="type parameter in Factory">T</A>&gt;</DD>
</DL>
<HR>
<DL>
<DT><PRE>public static interface <B>Factory.Named&lt;T&gt;</B><DT>extends <A HREF="../../../../net/schmizz/sshj/common/Factory.html" title="interface in net.schmizz.sshj.common">Factory</A>&lt;T&gt;</DL>
</PRE>
<P>
Inteface for a named factory. Named factories are simply factories that are identified by a name. Such names are
used mainly in SSH algorithm negotiation.
<P>
<P>
<HR>
<P>
<!-- ======== NESTED CLASS SUMMARY ======== -->
<A NAME="nested_class_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Nested Class Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;class</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/schmizz/sshj/common/Factory.Named.Util.html" title="class in net.schmizz.sshj.common">Factory.Named.Util</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Utility functions</TD>
</TR>
</TABLE>
&nbsp;<A NAME="nested_classes_inherited_from_class_net.schmizz.sshj.common.Factory"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Nested classes/interfaces inherited from interface net.schmizz.sshj.common.<A HREF="../../../../net/schmizz/sshj/common/Factory.html" title="interface in net.schmizz.sshj.common">Factory</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../net/schmizz/sshj/common/Factory.Named.html" title="interface in net.schmizz.sshj.common">Factory.Named</A>&lt;<A HREF="../../../../net/schmizz/sshj/common/Factory.Named.html" title="type parameter in Factory.Named">T</A>&gt;</CODE></TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/schmizz/sshj/common/Factory.Named.html#getName()">getName</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_net.schmizz.sshj.common.Factory"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from interface net.schmizz.sshj.common.<A HREF="../../../../net/schmizz/sshj/common/Factory.html" title="interface in net.schmizz.sshj.common">Factory</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../net/schmizz/sshj/common/Factory.html#create()">create</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getName()"><!-- --></A><H3>
getName</H3>
<PRE>
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getName</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the name of this factory.</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Factory.Named.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../net/schmizz/sshj/common/Factory.html" title="interface in net.schmizz.sshj.common"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../net/schmizz/sshj/common/Factory.Named.Util.html" title="class in net.schmizz.sshj.common"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?net/schmizz/sshj/common/Factory.Named.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="Factory.Named.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright &#169; 2009-2011. All Rights Reserved.
</BODY>
</HTML>