DefaultNIWSServerListFilter.html 13.8 KB
Newer Older
A
Allen Wang 已提交
1 2 3 4
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
A
Allen Wang 已提交
5
<!-- Generated by javadoc (build 1.6.0_35) on Mon Jan 28 09:08:06 PST 2013 -->
A
Allen Wang 已提交
6
<TITLE>
A
Allen Wang 已提交
7
DefaultNIWSServerListFilter (ribbon-eureka 0.1.1-SNAPSHOT API)
A
Allen Wang 已提交
8 9
</TITLE>

A
Allen Wang 已提交
10
<META NAME="date" CONTENT="2013-01-28">
A
Allen Wang 已提交
11 12 13 14 15 16 17

<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) {
A
Allen Wang 已提交
18
        parent.document.title="DefaultNIWSServerListFilter (ribbon-eureka 0.1.1-SNAPSHOT API)";
A
Allen Wang 已提交
19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39
    }
}
</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">
A
Allen Wang 已提交
40
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../com/netflix/niws/loadbalancer/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
A
Allen Wang 已提交
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&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;PREV CLASS&nbsp;
A
Allen Wang 已提交
57
&nbsp;<A HREF="../../../../com/netflix/niws/loadbalancer/DiscoveryEnabledNIWSServerList.html" title="class in com.netflix.niws.loadbalancer"><B>NEXT CLASS</B></A></FONT></TD>
A
Allen Wang 已提交
58
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
A
Allen Wang 已提交
59
  <A HREF="../../../../index.html?com/netflix/niws/loadbalancer/DefaultNIWSServerListFilter.html" target="_top"><B>FRAMES</B></A>  &nbsp;
A
Allen Wang 已提交
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88
&nbsp;<A HREF="DefaultNIWSServerListFilter.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;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&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">
A
Allen Wang 已提交
89
com.netflix.niws.loadbalancer</FONT>
A
Allen Wang 已提交
90 91 92 93
<BR>
Class DefaultNIWSServerListFilter</H2>
<PRE>
java.lang.Object
A
Allen Wang 已提交
94 95
  <IMG SRC="../../../../resources/inherit.gif" ALT="extended by ">com.netflix.loadbalancer.AbstractServerListFilter&lt;<A HREF="../../../../com/netflix/niws/loadbalancer/DiscoveryEnabledServer.html" title="class in com.netflix.niws.loadbalancer">DiscoveryEnabledServer</A>&gt;
      <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>com.netflix.niws.loadbalancer.DefaultNIWSServerListFilter</B>
A
Allen Wang 已提交
96 97
</PRE>
<DL>
A
Allen Wang 已提交
98
<DT><B>All Implemented Interfaces:</B> <DD>com.netflix.client.IClientConfigAware, com.netflix.loadbalancer.ServerListFilter&lt;<A HREF="../../../../com/netflix/niws/loadbalancer/DiscoveryEnabledServer.html" title="class in com.netflix.niws.loadbalancer">DiscoveryEnabledServer</A>&gt;</DD>
A
Allen Wang 已提交
99 100 101
</DL>
<HR>
<DL>
A
Allen Wang 已提交
102
<DT><PRE>public class <B>DefaultNIWSServerListFilter</B><DT>extends com.netflix.loadbalancer.AbstractServerListFilter&lt;<A HREF="../../../../com/netflix/niws/loadbalancer/DiscoveryEnabledServer.html" title="class in com.netflix.niws.loadbalancer">DiscoveryEnabledServer</A>&gt;<DT>implements com.netflix.client.IClientConfigAware</DL>
A
Allen Wang 已提交
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122
</PRE>

<P>
The Default NIWS Filter - deals with filtering out servers based on the Zone affinity and other related properties
<P>

<P>
<HR>

<P>

<!-- ======== 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">
A
Allen Wang 已提交
123
<TD><CODE><B><A HREF="../../../../com/netflix/niws/loadbalancer/DefaultNIWSServerListFilter.html#DefaultNIWSServerListFilter()">DefaultNIWSServerListFilter</A></B>()</CODE>
A
Allen Wang 已提交
124 125 126 127 128

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
A
Allen Wang 已提交
129
<TD><CODE><B><A HREF="../../../../com/netflix/niws/loadbalancer/DefaultNIWSServerListFilter.html#DefaultNIWSServerListFilter(com.netflix.client.config.IClientConfig)">DefaultNIWSServerListFilter</A></B>(com.netflix.client.config.IClientConfig&nbsp;niwsClientConfig)</CODE>
A
Allen Wang 已提交
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</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">
A
Allen Wang 已提交
146 147
<CODE>&nbsp;java.util.List&lt;<A HREF="../../../../com/netflix/niws/loadbalancer/DiscoveryEnabledServer.html" title="class in com.netflix.niws.loadbalancer">DiscoveryEnabledServer</A>&gt;</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/netflix/niws/loadbalancer/DefaultNIWSServerListFilter.html#getFilteredListOfServers(java.util.List)">getFilteredListOfServers</A></B>(java.util.List&lt;<A HREF="../../../../com/netflix/niws/loadbalancer/DiscoveryEnabledServer.html" title="class in com.netflix.niws.loadbalancer">DiscoveryEnabledServer</A>&gt;&nbsp;servers)</CODE>
A
Allen Wang 已提交
148 149 150 151 152 153 154

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
A
Allen Wang 已提交
155
<TD><CODE><B><A HREF="../../../../com/netflix/niws/loadbalancer/DefaultNIWSServerListFilter.html#initWithNiwsConfig(com.netflix.client.config.IClientConfig)">initWithNiwsConfig</A></B>(com.netflix.client.config.IClientConfig&nbsp;niwsClientConfig)</CODE>
A
Allen Wang 已提交
156 157 158 159 160 161 162

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
A
Allen Wang 已提交
163
<TD><CODE><B><A HREF="../../../../com/netflix/niws/loadbalancer/DefaultNIWSServerListFilter.html#toString()">toString</A></B>()</CODE>
A
Allen Wang 已提交
164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_com.netflix.loadbalancer.AbstractServerListFilter"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class com.netflix.loadbalancer.AbstractServerListFilter</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>getLoadBalancerStats, setLoadBalancerStats</CODE></TD>
</TR>
</TABLE>
&nbsp;<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, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>

<!-- ========= 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="DefaultNIWSServerListFilter()"><!-- --></A><H3>
DefaultNIWSServerListFilter</H3>
<PRE>
public <B>DefaultNIWSServerListFilter</B>()</PRE>
<DL>
</DL>
<HR>

<A NAME="DefaultNIWSServerListFilter(com.netflix.client.config.IClientConfig)"><!-- --></A><H3>
DefaultNIWSServerListFilter</H3>
<PRE>
public <B>DefaultNIWSServerListFilter</B>(com.netflix.client.config.IClientConfig&nbsp;niwsClientConfig)</PRE>
<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="initWithNiwsConfig(com.netflix.client.config.IClientConfig)"><!-- --></A><H3>
initWithNiwsConfig</H3>
<PRE>
public void <B>initWithNiwsConfig</B>(com.netflix.client.config.IClientConfig&nbsp;niwsClientConfig)</PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>initWithNiwsConfig</CODE> in interface <CODE>com.netflix.client.IClientConfigAware</CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getFilteredListOfServers(java.util.List)"><!-- --></A><H3>
getFilteredListOfServers</H3>
<PRE>
A
Allen Wang 已提交
242
public java.util.List&lt;<A HREF="../../../../com/netflix/niws/loadbalancer/DiscoveryEnabledServer.html" title="class in com.netflix.niws.loadbalancer">DiscoveryEnabledServer</A>&gt; <B>getFilteredListOfServers</B>(java.util.List&lt;<A HREF="../../../../com/netflix/niws/loadbalancer/DiscoveryEnabledServer.html" title="class in com.netflix.niws.loadbalancer">DiscoveryEnabledServer</A>&gt;&nbsp;servers)</PRE>
A
Allen Wang 已提交
243 244
<DL>
<DD><DL>
A
Allen Wang 已提交
245
<DT><B>Specified by:</B><DD><CODE>getFilteredListOfServers</CODE> in interface <CODE>com.netflix.loadbalancer.ServerListFilter&lt;<A HREF="../../../../com/netflix/niws/loadbalancer/DiscoveryEnabledServer.html" title="class in com.netflix.niws.loadbalancer">DiscoveryEnabledServer</A>&gt;</CODE></DL>
A
Allen Wang 已提交
246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="toString()"><!-- --></A><H3>
toString</H3>
<PRE>
public java.lang.String <B>toString</B>()</PRE>
<DL>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL>
</DD>
<DD><DL>
</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">
A
Allen Wang 已提交
278
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../com/netflix/niws/loadbalancer/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
A
Allen Wang 已提交
279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&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;PREV CLASS&nbsp;
A
Allen Wang 已提交
295
&nbsp;<A HREF="../../../../com/netflix/niws/loadbalancer/DiscoveryEnabledNIWSServerList.html" title="class in com.netflix.niws.loadbalancer"><B>NEXT CLASS</B></A></FONT></TD>
A
Allen Wang 已提交
296
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
A
Allen Wang 已提交
297
  <A HREF="../../../../index.html?com/netflix/niws/loadbalancer/DefaultNIWSServerListFilter.html" target="_top"><B>FRAMES</B></A>  &nbsp;
A
Allen Wang 已提交
298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326
&nbsp;<A HREF="DefaultNIWSServerListFilter.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;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>

</BODY>
</HTML>