blob: eb789f07e51775f580993652c77f90fc4419378b [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
CryptoProviderFactory (Apache CXF JavaDoc 3.0.0 API)
</TITLE>
<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="CryptoProviderFactory (Apache CXF JavaDoc 3.0.0 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/CryptoProviderFactory.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>
Apache CXF API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../org/apache/cxf/xkms/crypto/CryptoProviderException.html" title="class in org.apache.cxf.xkms.crypto"><B>PREV CLASS</B></A>&nbsp;
&nbsp;NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?org/apache/cxf/xkms/crypto/CryptoProviderFactory.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="CryptoProviderFactory.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;NESTED&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">
org.apache.cxf.xkms.crypto</FONT>
<BR>
Interface CryptoProviderFactory</H2>
<DL>
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../org/apache/cxf/xkms/crypto/provider/XkmsCryptoProviderFactory.html" title="class in org.apache.cxf.xkms.crypto.provider">XkmsCryptoProviderFactory</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>CryptoProviderFactory</B></DL>
</PRE>
<P>
<HR>
<P>
<!-- ========== 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;org.apache.wss4j.common.crypto.Crypto</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/cxf/xkms/crypto/CryptoProviderFactory.html#create()">create</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create without fallback crypto</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;org.apache.wss4j.common.crypto.Crypto</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/cxf/xkms/crypto/CryptoProviderFactory.html#create(org.apache.wss4j.common.crypto.Crypto)">create</A></B>(org.apache.wss4j.common.crypto.Crypto&nbsp;fallbackCrypto)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create with fallback crypto</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;org.apache.wss4j.common.crypto.Crypto</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/cxf/xkms/crypto/CryptoProviderFactory.html#create(org.apache.cxf.message.Message)">create</A></B>(<A HREF="../../../../../org/apache/cxf/message/Message.html" title="interface in org.apache.cxf.message">Message</A>&nbsp;message)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create with merlin fallback settings retrieved from cxf message</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;org.apache.wss4j.common.crypto.Crypto</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/cxf/xkms/crypto/CryptoProviderFactory.html#create(java.lang.String)">create</A></B>(<A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;keystoreProperties)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create with overridden keystoreProperties to create default Crypto</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;org.apache.wss4j.common.crypto.Crypto</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/cxf/xkms/crypto/CryptoProviderFactory.html#create(org.w3._2002._03.xkms_wsdl.XKMSPortType, org.apache.wss4j.common.crypto.Crypto)">create</A></B>(<A HREF="../../../../../org/w3/_2002/_03/xkms_wsdl/XKMSPortType.html" title="interface in org.w3._2002._03.xkms_wsdl">XKMSPortType</A>&nbsp;xkmsClient,
org.apache.wss4j.common.crypto.Crypto&nbsp;fallbackCrypto)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create with overridden XKMSPortType and fallbackCrypto</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;org.apache.wss4j.common.crypto.Crypto</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/cxf/xkms/crypto/CryptoProviderFactory.html#create(org.w3._2002._03.xkms_wsdl.XKMSPortType, org.apache.wss4j.common.crypto.Crypto, boolean)">create</A></B>(<A HREF="../../../../../org/w3/_2002/_03/xkms_wsdl/XKMSPortType.html" title="interface in org.w3._2002._03.xkms_wsdl">XKMSPortType</A>&nbsp;xkmsClient,
org.apache.wss4j.common.crypto.Crypto&nbsp;fallbackCrypto,
boolean&nbsp;allowX509FromJKS)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create with overridden XKMSPortType, fallbackCrypto and control of getting X509 from local keystore</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="create(org.apache.cxf.message.Message)"><!-- --></A><H3>
create</H3>
<PRE>
org.apache.wss4j.common.crypto.Crypto <B>create</B>(<A HREF="../../../../../org/apache/cxf/message/Message.html" title="interface in org.apache.cxf.message">Message</A>&nbsp;message)</PRE>
<DL>
<DD>Create with merlin fallback settings retrieved from cxf message
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>message</CODE> -
<DT><B>Returns:</B><DD></DL>
</DD>
</DL>
<HR>
<A NAME="create()"><!-- --></A><H3>
create</H3>
<PRE>
org.apache.wss4j.common.crypto.Crypto <B>create</B>()</PRE>
<DL>
<DD>Create without fallback crypto
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>cryptoProperties</CODE> -
<DT><B>Returns:</B><DD>xkms crypto</DL>
</DD>
</DL>
<HR>
<A NAME="create(org.apache.wss4j.common.crypto.Crypto)"><!-- --></A><H3>
create</H3>
<PRE>
org.apache.wss4j.common.crypto.Crypto <B>create</B>(org.apache.wss4j.common.crypto.Crypto&nbsp;fallbackCrypto)</PRE>
<DL>
<DD>Create with fallback crypto
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>fallbackCrypto</CODE> -
<DT><B>Returns:</B><DD></DL>
</DD>
</DL>
<HR>
<A NAME="create(java.lang.String)"><!-- --></A><H3>
create</H3>
<PRE>
org.apache.wss4j.common.crypto.Crypto <B>create</B>(<A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;keystoreProperties)</PRE>
<DL>
<DD>Create with overridden keystoreProperties to create default Crypto
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>xkmsClient</CODE> - <DD><CODE>keystoreProperties</CODE> -
<DT><B>Returns:</B><DD></DL>
</DD>
</DL>
<HR>
<A NAME="create(org.w3._2002._03.xkms_wsdl.XKMSPortType, org.apache.wss4j.common.crypto.Crypto)"><!-- --></A><H3>
create</H3>
<PRE>
org.apache.wss4j.common.crypto.Crypto <B>create</B>(<A HREF="../../../../../org/w3/_2002/_03/xkms_wsdl/XKMSPortType.html" title="interface in org.w3._2002._03.xkms_wsdl">XKMSPortType</A>&nbsp;xkmsClient,
org.apache.wss4j.common.crypto.Crypto&nbsp;fallbackCrypto)</PRE>
<DL>
<DD>Create with overridden XKMSPortType and fallbackCrypto
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>xkmsClient</CODE> - <DD><CODE>fallbackCrypto</CODE> -
<DT><B>Returns:</B><DD></DL>
</DD>
</DL>
<HR>
<A NAME="create(org.w3._2002._03.xkms_wsdl.XKMSPortType, org.apache.wss4j.common.crypto.Crypto, boolean)"><!-- --></A><H3>
create</H3>
<PRE>
org.apache.wss4j.common.crypto.Crypto <B>create</B>(<A HREF="../../../../../org/w3/_2002/_03/xkms_wsdl/XKMSPortType.html" title="interface in org.w3._2002._03.xkms_wsdl">XKMSPortType</A>&nbsp;xkmsClient,
org.apache.wss4j.common.crypto.Crypto&nbsp;fallbackCrypto,
boolean&nbsp;allowX509FromJKS)</PRE>
<DL>
<DD>Create with overridden XKMSPortType, fallbackCrypto and control of getting X509 from local keystore
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>xkmsClient</CODE> - <DD><CODE>fallbackCrypto</CODE> - <DD><CODE>allowX509FromJKS</CODE> -
<DT><B>Returns:</B><DD></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/CryptoProviderFactory.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>
Apache CXF API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../org/apache/cxf/xkms/crypto/CryptoProviderException.html" title="class in org.apache.cxf.xkms.crypto"><B>PREV CLASS</B></A>&nbsp;
&nbsp;NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?org/apache/cxf/xkms/crypto/CryptoProviderFactory.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="CryptoProviderFactory.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;NESTED&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>
Apache CXF
</BODY>
</HTML>