| <!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_22) on Thu Apr 26 14:22:13 IST 2012 --> |
| <TITLE> |
| Token (Apache Rampart API) |
| </TITLE> |
| |
| <META NAME="date" CONTENT="2012-04-26"> |
| |
| <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="Token (Apache Rampart 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> </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/Token.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> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../org/apache/rahas/STSMessageReceiver.html" title="class in org.apache.rahas"><B>PREV CLASS</B></A> |
| <A HREF="../../../org/apache/rahas/TokenCanceler.html" title="interface in org.apache.rahas"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../index.html?org/apache/rahas/Token.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="Token.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 | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <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.rahas</FONT> |
| <BR> |
| Class Token</H2> |
| <PRE> |
| java.lang.Object |
| <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>org.apache.rahas.Token</B> |
| </PRE> |
| <DL> |
| <DT><B>All Implemented Interfaces:</B> <DD>java.io.Externalizable, java.io.Serializable</DD> |
| </DL> |
| <DL> |
| <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../org/apache/rahas/EncryptedKeyToken.html" title="class in org.apache.rahas">EncryptedKeyToken</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public class <B>Token</B><DT>extends java.lang.Object<DT>implements java.io.Externalizable</DL> |
| </PRE> |
| |
| <P> |
| This represents a security token which can have either one of 4 states. <ul> <li>ISSUED</li> <li>EXPIRED</li> |
| <li>CACELLED</li> <li>RENEWED</li> </ul> Also this holds the <code>OMElement</code>s representing the token in its |
| present state and the previous state. |
| <p/> |
| These tokens are stored using the storage mechanism provided via the <code>TokenStorage</code> interface. |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../org/apache/rahas/TokenStorage.html" title="interface in org.apache.rahas"><CODE>TokenStorage</CODE></A>, |
| <A HREF="../../../serialized-form.html#org.apache.rahas.Token">Serialized Form</A></DL> |
| <HR> |
| |
| <P> |
| <!-- =========== FIELD SUMMARY =========== --> |
| |
| <A NAME="field_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>Field Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/rahas/Token.html#CANCELLED">CANCELLED</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/rahas/Token.html#EXPIRED">EXPIRED</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/rahas/Token.html#ISSUED">ISSUED</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/rahas/Token.html#RENEWED">RENEWED</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| |
| <A NAME="constructor_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>Constructor Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../org/apache/rahas/Token.html#Token()">Token</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../org/apache/rahas/Token.html#Token(java.lang.String, java.util.Date, java.util.Date)">Token</A></B>(java.lang.String id, |
| java.util.Date created, |
| java.util.Date expires)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../org/apache/rahas/Token.html#Token(java.lang.String, org.apache.axiom.om.OMElement, java.util.Date, java.util.Date)">Token</A></B>(java.lang.String id, |
| org.apache.axiom.om.OMElement tokenElem, |
| java.util.Date created, |
| java.util.Date expires)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../org/apache/rahas/Token.html#Token(java.lang.String, org.apache.axiom.om.OMElement, org.apache.axiom.om.OMElement)">Token</A></B>(java.lang.String id, |
| org.apache.axiom.om.OMElement tokenElem, |
| org.apache.axiom.om.OMElement lifetimeElem)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ========== 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> org.apache.axiom.om.OMElement</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/rahas/Token.html#getAttachedReference()">getAttachedReference</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.util.Date</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/rahas/Token.html#getCreated()">getCreated</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.util.Date</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/rahas/Token.html#getExpires()">getExpires</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/rahas/Token.html#getId()">getId</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/rahas/Token.html#getIssuerAddress()">getIssuerAddress</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> org.apache.axiom.om.OMElement</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/rahas/Token.html#getPreviousToken()">getPreviousToken</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.util.Properties</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/rahas/Token.html#getProperties()">getProperties</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> byte[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/rahas/Token.html#getSecret()">getSecret</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/rahas/Token.html#getState()">getState</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> org.apache.axiom.om.OMElement</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/rahas/Token.html#getToken()">getToken</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> org.apache.axiom.om.OMElement</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/rahas/Token.html#getUnattachedReference()">getUnattachedReference</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/rahas/Token.html#isChanged()">isChanged</A></B>()</CODE> |
| |
| <BR> |
| </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/rahas/Token.html#readExternal(java.io.ObjectInput)">readExternal</A></B>(java.io.ObjectInput in)</CODE> |
| |
| <BR> |
| Implementing de-serialization logic in accordance with the serialization logic.</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/rahas/Token.html#setAttachedReference(org.apache.axiom.om.OMElement)">setAttachedReference</A></B>(org.apache.axiom.om.OMElement attachedReference)</CODE> |
| |
| <BR> |
| </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/rahas/Token.html#setChanged(boolean)">setChanged</A></B>(boolean chnaged)</CODE> |
| |
| <BR> |
| </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/rahas/Token.html#setExpires(java.util.Date)">setExpires</A></B>(java.util.Date expires)</CODE> |
| |
| <BR> |
| </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/rahas/Token.html#setIssuerAddress(java.lang.String)">setIssuerAddress</A></B>(java.lang.String issuerAddress)</CODE> |
| |
| <BR> |
| </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/rahas/Token.html#setPreviousToken(org.apache.axiom.om.OMElement)">setPreviousToken</A></B>(org.apache.axiom.om.OMElement presivousToken)</CODE> |
| |
| <BR> |
| </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/rahas/Token.html#setProperties(java.util.Properties)">setProperties</A></B>(java.util.Properties properties)</CODE> |
| |
| <BR> |
| </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/rahas/Token.html#setSecret(byte[])">setSecret</A></B>(byte[] secret)</CODE> |
| |
| <BR> |
| </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/rahas/Token.html#setState(int)">setState</A></B>(int state)</CODE> |
| |
| <BR> |
| </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/rahas/Token.html#setToken(org.apache.axiom.om.OMElement)">setToken</A></B>(org.apache.axiom.om.OMElement token)</CODE> |
| |
| <BR> |
| </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/rahas/Token.html#setUnattachedReference(org.apache.axiom.om.OMElement)">setUnattachedReference</A></B>(org.apache.axiom.om.OMElement unattachedReference)</CODE> |
| |
| <BR> |
| </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/rahas/Token.html#writeExternal(java.io.ObjectOutput)">writeExternal</A></B>(java.io.ObjectOutput out)</CODE> |
| |
| <BR> |
| Implementing serialize logic according to our own protocol.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ FIELD DETAIL =========== --> |
| |
| <A NAME="field_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>Field Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="ISSUED"><!-- --></A><H3> |
| ISSUED</H3> |
| <PRE> |
| public static final int <B>ISSUED</B></PRE> |
| <DL> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.rahas.Token.ISSUED">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="EXPIRED"><!-- --></A><H3> |
| EXPIRED</H3> |
| <PRE> |
| public static final int <B>EXPIRED</B></PRE> |
| <DL> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.rahas.Token.EXPIRED">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="CANCELLED"><!-- --></A><H3> |
| CANCELLED</H3> |
| <PRE> |
| public static final int <B>CANCELLED</B></PRE> |
| <DL> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.rahas.Token.CANCELLED">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="RENEWED"><!-- --></A><H3> |
| RENEWED</H3> |
| <PRE> |
| public static final int <B>RENEWED</B></PRE> |
| <DL> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.rahas.Token.RENEWED">Constant Field Values</A></DL> |
| </DL> |
| |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| |
| <A NAME="constructor_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>Constructor Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="Token()"><!-- --></A><H3> |
| Token</H3> |
| <PRE> |
| public <B>Token</B>()</PRE> |
| <DL> |
| </DL> |
| <HR> |
| |
| <A NAME="Token(java.lang.String, java.util.Date, java.util.Date)"><!-- --></A><H3> |
| Token</H3> |
| <PRE> |
| public <B>Token</B>(java.lang.String id, |
| java.util.Date created, |
| java.util.Date expires)</PRE> |
| <DL> |
| </DL> |
| <HR> |
| |
| <A NAME="Token(java.lang.String, org.apache.axiom.om.OMElement, java.util.Date, java.util.Date)"><!-- --></A><H3> |
| Token</H3> |
| <PRE> |
| public <B>Token</B>(java.lang.String id, |
| org.apache.axiom.om.OMElement tokenElem, |
| java.util.Date created, |
| java.util.Date expires) |
| throws <A HREF="../../../org/apache/rahas/TrustException.html" title="class in org.apache.rahas">TrustException</A></PRE> |
| <DL> |
| <DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../org/apache/rahas/TrustException.html" title="class in org.apache.rahas">TrustException</A></CODE></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="Token(java.lang.String, org.apache.axiom.om.OMElement, org.apache.axiom.om.OMElement)"><!-- --></A><H3> |
| Token</H3> |
| <PRE> |
| public <B>Token</B>(java.lang.String id, |
| org.apache.axiom.om.OMElement tokenElem, |
| org.apache.axiom.om.OMElement lifetimeElem) |
| throws <A HREF="../../../org/apache/rahas/TrustException.html" title="class in org.apache.rahas">TrustException</A></PRE> |
| <DL> |
| <DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../org/apache/rahas/TrustException.html" title="class in org.apache.rahas">TrustException</A></CODE></DL> |
| </DL> |
| |
| <!-- ============ 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="isChanged()"><!-- --></A><H3> |
| isChanged</H3> |
| <PRE> |
| public boolean <B>isChanged</B>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>Returns the changed.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setChanged(boolean)"><!-- --></A><H3> |
| setChanged</H3> |
| <PRE> |
| public void <B>setChanged</B>(boolean chnaged)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>chnaged</CODE> - The changed to set.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getProperties()"><!-- --></A><H3> |
| getProperties</H3> |
| <PRE> |
| public java.util.Properties <B>getProperties</B>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>Returns the properties.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setProperties(java.util.Properties)"><!-- --></A><H3> |
| setProperties</H3> |
| <PRE> |
| public void <B>setProperties</B>(java.util.Properties properties)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>properties</CODE> - The properties to set.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getState()"><!-- --></A><H3> |
| getState</H3> |
| <PRE> |
| public int <B>getState</B>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>Returns the state.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setState(int)"><!-- --></A><H3> |
| setState</H3> |
| <PRE> |
| public void <B>setState</B>(int state)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>state</CODE> - The state to set.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getToken()"><!-- --></A><H3> |
| getToken</H3> |
| <PRE> |
| public org.apache.axiom.om.OMElement <B>getToken</B>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>Returns the token.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setToken(org.apache.axiom.om.OMElement)"><!-- --></A><H3> |
| setToken</H3> |
| <PRE> |
| public void <B>setToken</B>(org.apache.axiom.om.OMElement token)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>token</CODE> - The token to set.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getId()"><!-- --></A><H3> |
| getId</H3> |
| <PRE> |
| public java.lang.String <B>getId</B>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>Returns the id.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getPreviousToken()"><!-- --></A><H3> |
| getPreviousToken</H3> |
| <PRE> |
| public org.apache.axiom.om.OMElement <B>getPreviousToken</B>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>Returns the presivousToken.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setPreviousToken(org.apache.axiom.om.OMElement)"><!-- --></A><H3> |
| setPreviousToken</H3> |
| <PRE> |
| public void <B>setPreviousToken</B>(org.apache.axiom.om.OMElement presivousToken)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>presivousToken</CODE> - The presivousToken to set.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getSecret()"><!-- --></A><H3> |
| getSecret</H3> |
| <PRE> |
| public byte[] <B>getSecret</B>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>Returns the secret.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setSecret(byte[])"><!-- --></A><H3> |
| setSecret</H3> |
| <PRE> |
| public void <B>setSecret</B>(byte[] secret)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>secret</CODE> - The secret to set.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getAttachedReference()"><!-- --></A><H3> |
| getAttachedReference</H3> |
| <PRE> |
| public org.apache.axiom.om.OMElement <B>getAttachedReference</B>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>Returns the attachedReference.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setAttachedReference(org.apache.axiom.om.OMElement)"><!-- --></A><H3> |
| setAttachedReference</H3> |
| <PRE> |
| public void <B>setAttachedReference</B>(org.apache.axiom.om.OMElement attachedReference)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>attachedReference</CODE> - The attachedReference to set.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getUnattachedReference()"><!-- --></A><H3> |
| getUnattachedReference</H3> |
| <PRE> |
| public org.apache.axiom.om.OMElement <B>getUnattachedReference</B>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>Returns the unattachedReference.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setUnattachedReference(org.apache.axiom.om.OMElement)"><!-- --></A><H3> |
| setUnattachedReference</H3> |
| <PRE> |
| public void <B>setUnattachedReference</B>(org.apache.axiom.om.OMElement unattachedReference)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>unattachedReference</CODE> - The unattachedReference to set.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getCreated()"><!-- --></A><H3> |
| getCreated</H3> |
| <PRE> |
| public java.util.Date <B>getCreated</B>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>Returns the created.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getExpires()"><!-- --></A><H3> |
| getExpires</H3> |
| <PRE> |
| public java.util.Date <B>getExpires</B>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>Returns the expires.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setExpires(java.util.Date)"><!-- --></A><H3> |
| setExpires</H3> |
| <PRE> |
| public void <B>setExpires</B>(java.util.Date expires)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>expires</CODE> - The expires to set.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getIssuerAddress()"><!-- --></A><H3> |
| getIssuerAddress</H3> |
| <PRE> |
| public java.lang.String <B>getIssuerAddress</B>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setIssuerAddress(java.lang.String)"><!-- --></A><H3> |
| setIssuerAddress</H3> |
| <PRE> |
| public void <B>setIssuerAddress</B>(java.lang.String issuerAddress)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="writeExternal(java.io.ObjectOutput)"><!-- --></A><H3> |
| writeExternal</H3> |
| <PRE> |
| public void <B>writeExternal</B>(java.io.ObjectOutput out) |
| throws java.io.IOException</PRE> |
| <DL> |
| <DD>Implementing serialize logic according to our own protocol. We had to follow this, because |
| OMElement class is not serializable. Making OMElement serializable will have an huge impact |
| on other components. Therefore implementing serialization logic according to a manual |
| protocol. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE>writeExternal</CODE> in interface <CODE>java.io.Externalizable</CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>out</CODE> - Stream which writes serialized bytes. |
| <DT><B>Throws:</B> |
| <DD><CODE>java.io.IOException</CODE> - If unable to serialize particular member.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="readExternal(java.io.ObjectInput)"><!-- --></A><H3> |
| readExternal</H3> |
| <PRE> |
| public void <B>readExternal</B>(java.io.ObjectInput in) |
| throws java.io.IOException, |
| java.lang.ClassNotFoundException</PRE> |
| <DL> |
| <DD>Implementing de-serialization logic in accordance with the serialization logic. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE>readExternal</CODE> in interface <CODE>java.io.Externalizable</CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>in</CODE> - Stream which used to read data. |
| <DT><B>Throws:</B> |
| <DD><CODE>java.io.IOException</CODE> - If unable to de-serialize particular data member. |
| <DD><CODE>java.lang.ClassNotFoundException</CODE></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/Token.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> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../org/apache/rahas/STSMessageReceiver.html" title="class in org.apache.rahas"><B>PREV CLASS</B></A> |
| <A HREF="../../../org/apache/rahas/TokenCanceler.html" title="interface in org.apache.rahas"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../index.html?org/apache/rahas/Token.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="Token.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 | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| |
| </BODY> |
| </HTML> |
