| <!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> |
| TokenStore (Apache CXF Bundle Jar 2.6.3 API) |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.apache.cxf.ws.security.tokenstore.TokenStore interface"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="TokenStore (Apache CXF Bundle Jar 2.6.3 API)"; |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| |
| |
| <!-- ========= 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> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/TokenStore.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </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"> |
| <A HREF="../../../../../../org/apache/cxf/ws/security/tokenstore/SecurityToken.html" title="class in org.apache.cxf.ws.security.tokenstore"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../../org/apache/cxf/ws/security/tokenstore/TokenStoreFactory.html" title="class in org.apache.cxf.ws.security.tokenstore"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../index.html?org/apache/cxf/ws/security/tokenstore/TokenStore.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="TokenStore.html" target="_top"><B>NO FRAMES</B></A> |
| <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: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <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.ws.security.tokenstore</FONT> |
| <BR> |
| Interface TokenStore</H2> |
| <DL> |
| <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../../org/apache/cxf/ws/security/tokenstore/EHCacheTokenStore.html" title="class in org.apache.cxf.ws.security.tokenstore">EHCacheTokenStore</A>, <A HREF="../../../../../../org/apache/cxf/ws/security/tokenstore/MemoryTokenStore.html" title="class in org.apache.cxf.ws.security.tokenstore">MemoryTokenStore</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public interface <B>TokenStore</B></DL> |
| </PRE> |
| |
| <P> |
| This interface defines a caching mechanism for security tokens. It is up to the underlying implementation |
| to handle token expiration (e.g. by querying the SecurityToken's expires date). |
| <P> |
| |
| <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> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/apache/cxf/ws/security/tokenstore/TokenStore.html#add(org.apache.cxf.ws.security.tokenstore.SecurityToken)">add</A></B>(<A HREF="../../../../../../org/apache/cxf/ws/security/tokenstore/SecurityToken.html" title="class in org.apache.cxf.ws.security.tokenstore">SecurityToken</A> token)</CODE> |
| |
| <BR> |
| Add the given token to the cache.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/apache/cxf/ws/security/tokenstore/TokenStore.html#add(java.lang.String, org.apache.cxf.ws.security.tokenstore.SecurityToken)">add</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> identifier, |
| <A HREF="../../../../../../org/apache/cxf/ws/security/tokenstore/SecurityToken.html" title="class in org.apache.cxf.ws.security.tokenstore">SecurityToken</A> token)</CODE> |
| |
| <BR> |
| Add the given token to the cache under the given identifier</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A><<A HREF="../../../../../../org/apache/cxf/ws/security/tokenstore/SecurityToken.html" title="class in org.apache.cxf.ws.security.tokenstore">SecurityToken</A>></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/apache/cxf/ws/security/tokenstore/TokenStore.html#getExpiredTokens()">getExpiredTokens</A></B>()</CODE> |
| |
| <BR> |
| Return the list of expired tokens.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../../org/apache/cxf/ws/security/tokenstore/SecurityToken.html" title="class in org.apache.cxf.ws.security.tokenstore">SecurityToken</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/apache/cxf/ws/security/tokenstore/TokenStore.html#getToken(java.lang.String)">getToken</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> identifier)</CODE> |
| |
| <BR> |
| Returns the <code>Token</code> of the given identifier</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A><<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/apache/cxf/ws/security/tokenstore/TokenStore.html#getTokenIdentifiers()">getTokenIdentifiers</A></B>()</CODE> |
| |
| <BR> |
| Return the list of all valid token identifiers.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/apache/cxf/ws/security/tokenstore/TokenStore.html#remove(java.lang.String)">remove</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> identifier)</CODE> |
| |
| <BR> |
| Remove an existing token by its identifier</TD> |
| </TR> |
| </TABLE> |
| |
| <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="add(org.apache.cxf.ws.security.tokenstore.SecurityToken)"><!-- --></A><H3> |
| add</H3> |
| <PRE> |
| void <B>add</B>(<A HREF="../../../../../../org/apache/cxf/ws/security/tokenstore/SecurityToken.html" title="class in org.apache.cxf.ws.security.tokenstore">SecurityToken</A> token)</PRE> |
| <DL> |
| <DD>Add the given token to the cache. The SecurityTokens getId() identifier will be used to |
| key it in the cache. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>token</CODE> - The token to be added</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="add(java.lang.String, org.apache.cxf.ws.security.tokenstore.SecurityToken)"><!-- --></A><H3> |
| add</H3> |
| <PRE> |
| void <B>add</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> identifier, |
| <A HREF="../../../../../../org/apache/cxf/ws/security/tokenstore/SecurityToken.html" title="class in org.apache.cxf.ws.security.tokenstore">SecurityToken</A> token)</PRE> |
| <DL> |
| <DD>Add the given token to the cache under the given identifier |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>identifier</CODE> - The identifier to use to key the SecurityToken in the cache<DD><CODE>token</CODE> - The token to be added</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="remove(java.lang.String)"><!-- --></A><H3> |
| remove</H3> |
| <PRE> |
| void <B>remove</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> identifier)</PRE> |
| <DL> |
| <DD>Remove an existing token by its identifier |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getTokenIdentifiers()"><!-- --></A><H3> |
| getTokenIdentifiers</H3> |
| <PRE> |
| <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A><<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>> <B>getTokenIdentifiers</B>()</PRE> |
| <DL> |
| <DD>Return the list of all valid token identifiers. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>As array of (valid) token identifiers</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getExpiredTokens()"><!-- --></A><H3> |
| getExpiredTokens</H3> |
| <PRE> |
| <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A><<A HREF="../../../../../../org/apache/cxf/ws/security/tokenstore/SecurityToken.html" title="class in org.apache.cxf.ws.security.tokenstore">SecurityToken</A>> <B>getExpiredTokens</B>()</PRE> |
| <DL> |
| <DD>Return the list of expired tokens. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>An array of expired <code>Tokens</code></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getToken(java.lang.String)"><!-- --></A><H3> |
| getToken</H3> |
| <PRE> |
| <A HREF="../../../../../../org/apache/cxf/ws/security/tokenstore/SecurityToken.html" title="class in org.apache.cxf.ws.security.tokenstore">SecurityToken</A> <B>getToken</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> identifier)</PRE> |
| <DL> |
| <DD>Returns the <code>Token</code> of the given identifier |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>identifier</CODE> - |
| <DT><B>Returns:</B><DD>The requested <code>Token</code> identified by the given identifier</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> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/TokenStore.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </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"> |
| <A HREF="../../../../../../org/apache/cxf/ws/security/tokenstore/SecurityToken.html" title="class in org.apache.cxf.ws.security.tokenstore"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../../org/apache/cxf/ws/security/tokenstore/TokenStoreFactory.html" title="class in org.apache.cxf.ws.security.tokenstore"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../index.html?org/apache/cxf/ws/security/tokenstore/TokenStore.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="TokenStore.html" target="_top"><B>NO FRAMES</B></A> |
| <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: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <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> |