| <!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.4.2_12) on Wed Feb 14 17:36:39 GMT 2007 --> |
| <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> |
| <TITLE> |
| Subscriber (Apache Savan 1.2-SNAPSHOT API) |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.apache.savan.subscribers.Subscriber interface"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="Subscriber (Apache Savan 1.2-SNAPSHOT API)"; |
| } |
| </SCRIPT> |
| |
| </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=3 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/Subscriber.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/savan/subscribers/LeafSubscriber.html" title="class in org.apache.savan.subscribers"><B>PREV CLASS</B></A> |
| NEXT CLASS</FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="Subscriber.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.savan.subscribers</FONT> |
| <BR> |
| Interface Subscriber</H2> |
| <DL> |
| <DT><B>All Known Subinterfaces:</B> <DD><A HREF="../../../../org/apache/savan/eventing/subscribers/EventingSubscriber.html" title="interface in org.apache.savan.eventing.subscribers">EventingSubscriber</A></DD> |
| </DL> |
| <DL> |
| <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/apache/savan/subscribers/AbstractSubscriber.html" title="class in org.apache.savan.subscribers">AbstractSubscriber</A>, <A HREF="../../../../org/apache/savan/eventing/subscribers/EventingLeafSubscriber.html" title="class in org.apache.savan.eventing.subscribers">EventingLeafSubscriber</A>, <A HREF="../../../../org/apache/savan/eventing/subscribers/EventingTopicSubscriber.html" title="class in org.apache.savan.eventing.subscribers">EventingTopicSubscriber</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT>public interface <B>Subscriber</B></DL> |
| |
| <P> |
| Defines methods common to all subscribers. |
| <P> |
| |
| <P> |
| <HR> |
| |
| <P> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| |
| |
| <!-- =========== FIELD SUMMARY =========== --> |
| |
| |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=2><FONT SIZE="+2"> |
| <B>Method Summary</B></FONT></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/savan/subscribers/Subscriber.html#addProperty(java.lang.String, java.lang.Object)">addProperty</A></B>(java.lang.String key, |
| java.lang.Object value)</CODE> |
| |
| <BR> |
| To add a property to the subscriber.</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/savan/subscribers/Subscriber.html#doesMessageBelongToTheFilter(org.apache.savan.SavanMessageContext)">doesMessageBelongToTheFilter</A></B>(<A HREF="../../../../org/apache/savan/SavanMessageContext.html" title="class in org.apache.savan">SavanMessageContext</A> smc)</CODE> |
| |
| <BR> |
| To check weather a certain message complies with the filter.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/savan/filters/Filter.html" title="class in org.apache.savan.filters">Filter</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/savan/subscribers/Subscriber.html#getFilter()">getFilter</A></B>()</CODE> |
| |
| <BR> |
| To get the Filter object</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/savan/subscribers/Subscriber.html#getId()">getId</A></B>()</CODE> |
| |
| <BR> |
| To get the subscriber Id.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.Object</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/savan/subscribers/Subscriber.html#getProperty(java.lang.String)">getProperty</A></B>(java.lang.String key)</CODE> |
| |
| <BR> |
| To get a property from the Subscriber.</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/savan/subscribers/Subscriber.html#processPublication(org.apache.savan.SavanMessageContext, org.apache.savan.publication.PublicationReport)">processPublication</A></B>(<A HREF="../../../../org/apache/savan/SavanMessageContext.html" title="class in org.apache.savan">SavanMessageContext</A> publication, |
| <A HREF="../../../../org/apache/savan/publication/PublicationReport.html" title="class in org.apache.savan.publication">PublicationReport</A> report)</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/savan/subscribers/Subscriber.html#renewSubscription(org.apache.savan.subscription.ExpirationBean)">renewSubscription</A></B>(<A HREF="../../../../org/apache/savan/subscription/ExpirationBean.html" title="class in org.apache.savan.subscription">ExpirationBean</A> bean)</CODE> |
| |
| <BR> |
| To renew a subscription.</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/savan/subscribers/Subscriber.html#setFilter(org.apache.savan.filters.Filter)">setFilter</A></B>(<A HREF="../../../../org/apache/savan/filters/Filter.html" title="class in org.apache.savan.filters">Filter</A> filter)</CODE> |
| |
| <BR> |
| To set the Filter object</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/savan/subscribers/Subscriber.html#setId(java.lang.String)">setId</A></B>(java.lang.String id)</CODE> |
| |
| <BR> |
| To set the subscriber Id</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/savan/subscribers/Subscriber.html#setSubscriptionEndingTime(java.util.Date)">setSubscriptionEndingTime</A></B>(java.util.Date subscriptionEndingTime)</CODE> |
| |
| <BR> |
| To set the Subscription expiration time.</TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ FIELD DETAIL =========== --> |
| |
| |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=1><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TD> |
| </TR> |
| </TABLE> |
| |
| <A NAME="getFilter()"><!-- --></A><H3> |
| getFilter</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/savan/filters/Filter.html" title="class in org.apache.savan.filters">Filter</A> <B>getFilter</B>()</PRE> |
| <DL> |
| <DD>To get the Filter object |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setFilter(org.apache.savan.filters.Filter)"><!-- --></A><H3> |
| setFilter</H3> |
| <PRE> |
| public void <B>setFilter</B>(<A HREF="../../../../org/apache/savan/filters/Filter.html" title="class in org.apache.savan.filters">Filter</A> filter)</PRE> |
| <DL> |
| <DD>To set the Filter object |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>filter</CODE> - </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getId()"><!-- --></A><H3> |
| getId</H3> |
| <PRE> |
| public java.lang.String <B>getId</B>()</PRE> |
| <DL> |
| <DD>To get the subscriber Id. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setId(java.lang.String)"><!-- --></A><H3> |
| setId</H3> |
| <PRE> |
| public void <B>setId</B>(java.lang.String id)</PRE> |
| <DL> |
| <DD>To set the subscriber Id |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>id</CODE> - </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addProperty(java.lang.String, java.lang.Object)"><!-- --></A><H3> |
| addProperty</H3> |
| <PRE> |
| public void <B>addProperty</B>(java.lang.String key, |
| java.lang.Object value)</PRE> |
| <DL> |
| <DD>To add a property to the subscriber. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - <DD><CODE>value</CODE> - </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getProperty(java.lang.String)"><!-- --></A><H3> |
| getProperty</H3> |
| <PRE> |
| public java.lang.Object <B>getProperty</B>(java.lang.String key)</PRE> |
| <DL> |
| <DD>To get a property from the Subscriber. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - |
| <DT><B>Returns:</B><DD></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="doesMessageBelongToTheFilter(org.apache.savan.SavanMessageContext)"><!-- --></A><H3> |
| doesMessageBelongToTheFilter</H3> |
| <PRE> |
| public boolean <B>doesMessageBelongToTheFilter</B>(<A HREF="../../../../org/apache/savan/SavanMessageContext.html" title="class in org.apache.savan">SavanMessageContext</A> smc) |
| throws <A HREF="../../../../org/apache/savan/SavanException.html" title="class in org.apache.savan">SavanException</A></PRE> |
| <DL> |
| <DD>To check weather a certain message complies with the filter. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>smc</CODE> - |
| <DT><B>Returns:</B><DD> |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../org/apache/savan/SavanException.html" title="class in org.apache.savan">SavanException</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="processPublication(org.apache.savan.SavanMessageContext, org.apache.savan.publication.PublicationReport)"><!-- --></A><H3> |
| processPublication</H3> |
| <PRE> |
| public void <B>processPublication</B>(<A HREF="../../../../org/apache/savan/SavanMessageContext.html" title="class in org.apache.savan">SavanMessageContext</A> publication, |
| <A HREF="../../../../org/apache/savan/publication/PublicationReport.html" title="class in org.apache.savan.publication">PublicationReport</A> report) |
| throws <A HREF="../../../../org/apache/savan/SavanException.html" title="class in org.apache.savan">SavanException</A></PRE> |
| <DL> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../org/apache/savan/SavanException.html" title="class in org.apache.savan">SavanException</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setSubscriptionEndingTime(java.util.Date)"><!-- --></A><H3> |
| setSubscriptionEndingTime</H3> |
| <PRE> |
| public void <B>setSubscriptionEndingTime</B>(java.util.Date subscriptionEndingTime)</PRE> |
| <DL> |
| <DD>To set the Subscription expiration time. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>subscriptionEndingTime</CODE> - </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="renewSubscription(org.apache.savan.subscription.ExpirationBean)"><!-- --></A><H3> |
| renewSubscription</H3> |
| <PRE> |
| public void <B>renewSubscription</B>(<A HREF="../../../../org/apache/savan/subscription/ExpirationBean.html" title="class in org.apache.savan.subscription">ExpirationBean</A> bean)</PRE> |
| <DL> |
| <DD>To renew a subscription. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>bean</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=3 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/Subscriber.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/savan/subscribers/LeafSubscriber.html" title="class in org.apache.savan.subscribers"><B>PREV CLASS</B></A> |
| NEXT CLASS</FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="Subscriber.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> |
| Copyright © 2007 null. All Rights Reserved. |
| </BODY> |
| </HTML> |
