Code/Projects/PacketLevelSignatureExtractor/javadoc/edu/uci/iotproject/FlowPattern.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <!-- NewPage -->
   3 <html lang="en">
   4 <head>
   5 <!-- Generated by javadoc (1.8.0_191) on Thu Mar 28 11:26:59 PDT 2019 -->
   6 <title>FlowPattern</title>
   7 <meta name="date" content="2019-03-28">
   8 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
   9 <script type="text/javascript" src="../../../script.js"></script>
  10 </head>
  11 <body>
  12 <script type="text/javascript"><!--
  13     try {
  14         if (location.href.indexOf('is-external=true') == -1) {
  15             parent.document.title="FlowPattern";
  16         }
  17     }
  18     catch(err) {
  19     }
  20 //-->
  21 var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10};
  22 var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
  23 var altColor = "altColor";
  24 var rowColor = "rowColor";
  25 var tableTab = "tableTab";
  26 var activeTableTab = "activeTableTab";
  27 </script>
  28 <noscript>
  29 <div>JavaScript is disabled on your browser.</div>
  30 </noscript>
  31 <!-- ========= START OF TOP NAVBAR ======= -->
  32 <div class="topNav"><a name="navbar.top">
  33 <!--   -->
  34 </a>
  35 <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
  36 <a name="navbar.top.firstrow">
  37 <!--   -->
  38 </a>
  39 <ul class="navList" title="Navigation">
  40 <li><a href="../../../overview-summary.html">Overview</a></li>
  41 <li><a href="package-summary.html">Package</a></li>
  42 <li class="navBarCell1Rev">Class</li>
  43 <li><a href="package-tree.html">Tree</a></li>
  44 <li><a href="../../../deprecated-list.html">Deprecated</a></li>
  45 <li><a href="../../../index-files/index-1.html">Index</a></li>
  46 <li><a href="../../../help-doc.html">Help</a></li>
  47 </ul>
  48 </div>
  49 <div class="subNav">
  50 <ul class="navList">
  51 <li><a href="../../../edu/uci/iotproject/DnsMap.html" title="class in edu.uci.iotproject"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  52 <li><a href="../../../edu/uci/iotproject/SignatureGenerator.html" title="class in edu.uci.iotproject"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  53 </ul>
  54 <ul class="navList">
  55 <li><a href="../../../index.html?edu/uci/iotproject/FlowPattern.html" target="_top">Frames</a></li>
  56 <li><a href="FlowPattern.html" target="_top">No&nbsp;Frames</a></li>
  57 </ul>
  58 <ul class="navList" id="allclasses_navbar_top">
  59 <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  60 </ul>
  61 <div>
  62 <script type="text/javascript"><!--
  63   allClassesLink = document.getElementById("allclasses_navbar_top");
  64   if(window==top) {
  65     allClassesLink.style.display = "block";
  66   }
  67   else {
  68     allClassesLink.style.display = "none";
  69   }
  70   //-->
  71 </script>
  72 </div>
  73 <div>
  74 <ul class="subNavList">
  75 <li>Summary:&nbsp;</li>
  76 <li>Nested&nbsp;|&nbsp;</li>
  77 <li>Field&nbsp;|&nbsp;</li>
  78 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  79 <li><a href="#method.summary">Method</a></li>
  80 </ul>
  81 <ul class="subNavList">
  82 <li>Detail:&nbsp;</li>
  83 <li>Field&nbsp;|&nbsp;</li>
  84 <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  85 <li><a href="#method.detail">Method</a></li>
  86 </ul>
  87 </div>
  88 <a name="skip.navbar.top">
  89 <!--   -->
  90 </a></div>
  91 <!-- ========= END OF TOP NAVBAR ========= -->
  92 <!-- ======== START OF CLASS DATA ======== -->
  93 <div class="header">
  94 <div class="subTitle">edu.uci.iotproject</div>
  95 <h2 title="Class FlowPattern" class="title">Class FlowPattern</h2>
  96 </div>
  97 <div class="contentContainer">
  98 <ul class="inheritance">
  99 <li>java.lang.Object</li>
 100 <li>
 101 <ul class="inheritance">
 102 <li>edu.uci.iotproject.FlowPattern</li>
 103 </ul>
 104 </li>
 105 </ul>
 106 <div class="description">
 107 <ul class="blockList">
 108 <li class="blockList">
 109 <hr>
 110 <br>
 111 <pre>public class <span class="typeNameLabel">FlowPattern</span>
 112 extends java.lang.Object</pre>
 113 <div class="block">TODO add class documentation.
 114  TODO: At this point, this class is still in transition to having multiple hostnames and lists of packets</div>
 115 </li>
 116 </ul>
 117 </div>
 118 <div class="summary">
 119 <ul class="blockList">
 120 <li class="blockList">
 121 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 122 <ul class="blockList">
 123 <li class="blockList"><a name="constructor.summary">
 124 <!--   -->
 125 </a>
 126 <h3>Constructor Summary</h3>
 127 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
 128 <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
 129 <tr>
 130 <th class="colOne" scope="col">Constructor and Description</th>
 131 </tr>
 132 <tr class="altColor">
 133 <td class="colOne"><code><span class="memberNameLink"><a href="../../../edu/uci/iotproject/FlowPattern.html#FlowPattern-java.lang.String-java.util.List-org.pcap4j.core.PcapHandle-">FlowPattern</a></span>(java.lang.String&nbsp;mPatternId,
 134            java.util.List&lt;java.lang.String&gt;&nbsp;mHostnameList,
 135            org.pcap4j.core.PcapHandle&nbsp;mPcap)</code>
 136 <div class="block">Constructor #2</div>
 137 </td>
 138 </tr>
 139 <tr class="rowColor">
 140 <td class="colOne"><code><span class="memberNameLink"><a href="../../../edu/uci/iotproject/FlowPattern.html#FlowPattern-java.lang.String-java.lang.String-org.pcap4j.core.PcapHandle-">FlowPattern</a></span>(java.lang.String&nbsp;mPatternId,
 141            java.lang.String&nbsp;hostname,
 142            org.pcap4j.core.PcapHandle&nbsp;mPcap)</code>
 143 <div class="block">Constructor #1</div>
 144 </td>
 145 </tr>
 146 </table>
 147 </li>
 148 </ul>
 149 <!-- ========== METHOD SUMMARY =========== -->
 150 <ul class="blockList">
 151 <li class="blockList"><a name="method.summary">
 152 <!--   -->
 153 </a>
 154 <h3>Method Summary</h3>
 155 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
 156 <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
 157 <tr>
 158 <th class="colFirst" scope="col">Modifier and Type</th>
 159 <th class="colLast" scope="col">Method and Description</th>
 160 </tr>
 161 <tr id="i0" class="altColor">
 162 <td class="colFirst"><code>java.lang.String</code></td>
 163 <td class="colLast"><code><span class="memberNameLink"><a href="../../../edu/uci/iotproject/FlowPattern.html#getHostname--">getHostname</a></span>()</code>&nbsp;</td>
 164 </tr>
 165 <tr id="i1" class="rowColor">
 166 <td class="colFirst"><code>java.util.List&lt;java.lang.String&gt;</code></td>
 167 <td class="colLast"><code><span class="memberNameLink"><a href="../../../edu/uci/iotproject/FlowPattern.html#getHostnameList--">getHostnameList</a></span>()</code>
 168 <div class="block">Get the list of associated hostnames.</div>
 169 </td>
 170 </tr>
 171 <tr id="i2" class="altColor">
 172 <td class="colFirst"><code>int</code></td>
 173 <td class="colLast"><code><span class="memberNameLink"><a href="../../../edu/uci/iotproject/FlowPattern.html#getLength--">getLength</a></span>()</code>
 174 <div class="block">Get the length of the List of <code>FlowPattern</code>.</div>
 175 </td>
 176 </tr>
 177 <tr id="i3" class="rowColor">
 178 <td class="colFirst"><code>int</code></td>
 179 <td class="colLast"><code><span class="memberNameLink"><a href="../../../edu/uci/iotproject/FlowPattern.html#getLength-java.lang.String-">getLength</a></span>(java.lang.String&nbsp;hostname)</code>
 180 <div class="block">Get the length of the List of <code>FlowPattern</code>.</div>
 181 </td>
 182 </tr>
 183 <tr id="i4" class="altColor">
 184 <td class="colFirst"><code>java.util.List&lt;java.lang.Integer&gt;</code></td>
 185 <td class="colLast"><code><span class="memberNameLink"><a href="../../../edu/uci/iotproject/FlowPattern.html#getPacketOrder--">getPacketOrder</a></span>()</code>
 186 <div class="block">Get the sequence of packet lengths that defines this <code>FlowPattern</code>.</div>
 187 </td>
 188 </tr>
 189 <tr id="i5" class="rowColor">
 190 <td class="colFirst"><code>java.util.List&lt;java.lang.Integer&gt;</code></td>
 191 <td class="colLast"><code><span class="memberNameLink"><a href="../../../edu/uci/iotproject/FlowPattern.html#getPacketOrder-java.lang.String-">getPacketOrder</a></span>(java.lang.String&nbsp;hostname)</code>
 192 <div class="block">Get the sequence of packet lengths based on input hostname.</div>
 193 </td>
 194 </tr>
 195 <tr id="i6" class="altColor">
 196 <td class="colFirst"><code>java.lang.String</code></td>
 197 <td class="colLast"><code><span class="memberNameLink"><a href="../../../edu/uci/iotproject/FlowPattern.html#getPatternId--">getPatternId</a></span>()</code>&nbsp;</td>
 198 </tr>
 199 </table>
 200 <ul class="blockList">
 201 <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
 202 <!--   -->
 203 </a>
 204 <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
 205 <code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
 206 </ul>
 207 </li>
 208 </ul>
 209 </li>
 210 </ul>
 211 </div>
 212 <div class="details">
 213 <ul class="blockList">
 214 <li class="blockList">
 215 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 216 <ul class="blockList">
 217 <li class="blockList"><a name="constructor.detail">
 218 <!--   -->
 219 </a>
 220 <h3>Constructor Detail</h3>
 221 <a name="FlowPattern-java.lang.String-java.lang.String-org.pcap4j.core.PcapHandle-">
 222 <!--   -->
 223 </a>
 224 <ul class="blockList">
 225 <li class="blockList">
 226 <h4>FlowPattern</h4>
 227 <pre>public&nbsp;FlowPattern(java.lang.String&nbsp;mPatternId,
 228                    java.lang.String&nbsp;hostname,
 229                    org.pcap4j.core.PcapHandle&nbsp;mPcap)</pre>
 230 <div class="block">Constructor #1</div>
 231 </li>
 232 </ul>
 233 <a name="FlowPattern-java.lang.String-java.util.List-org.pcap4j.core.PcapHandle-">
 234 <!--   -->
 235 </a>
 236 <ul class="blockListLast">
 237 <li class="blockList">
 238 <h4>FlowPattern</h4>
 239 <pre>public&nbsp;FlowPattern(java.lang.String&nbsp;mPatternId,
 240                    java.util.List&lt;java.lang.String&gt;&nbsp;mHostnameList,
 241                    org.pcap4j.core.PcapHandle&nbsp;mPcap)</pre>
 242 <div class="block">Constructor #2</div>
 243 </li>
 244 </ul>
 245 </li>
 246 </ul>
 247 <!-- ============ METHOD DETAIL ========== -->
 248 <ul class="blockList">
 249 <li class="blockList"><a name="method.detail">
 250 <!--   -->
 251 </a>
 252 <h3>Method Detail</h3>
 253 <a name="getPatternId--">
 254 <!--   -->
 255 </a>
 256 <ul class="blockList">
 257 <li class="blockList">
 258 <h4>getPatternId</h4>
 259 <pre>public&nbsp;java.lang.String&nbsp;getPatternId()</pre>
 260 </li>
 261 </ul>
 262 <a name="getHostname--">
 263 <!--   -->
 264 </a>
 265 <ul class="blockList">
 266 <li class="blockList">
 267 <h4>getHostname</h4>
 268 <pre>public&nbsp;java.lang.String&nbsp;getHostname()</pre>
 269 </li>
 270 </ul>
 271 <a name="getPacketOrder--">
 272 <!--   -->
 273 </a>
 274 <ul class="blockList">
 275 <li class="blockList">
 276 <h4>getPacketOrder</h4>
 277 <pre>public&nbsp;java.util.List&lt;java.lang.Integer&gt;&nbsp;getPacketOrder()</pre>
 278 <div class="block">Get the sequence of packet lengths that defines this <code>FlowPattern</code>.</div>
 279 <dl>
 280 <dt><span class="returnLabel">Returns:</span></dt>
 281 <dd>the sequence of packet lengths that defines this <code>FlowPattern</code>.</dd>
 282 </dl>
 283 </li>
 284 </ul>
 285 <a name="getPacketOrder-java.lang.String-">
 286 <!--   -->
 287 </a>
 288 <ul class="blockList">
 289 <li class="blockList">
 290 <h4>getPacketOrder</h4>
 291 <pre>public&nbsp;java.util.List&lt;java.lang.Integer&gt;&nbsp;getPacketOrder(java.lang.String&nbsp;hostname)</pre>
 292 <div class="block">Get the sequence of packet lengths based on input hostname.</div>
 293 <dl>
 294 <dt><span class="returnLabel">Returns:</span></dt>
 295 <dd>the sequence of packet lengths that defines this <code>FlowPattern</code>.</dd>
 296 </dl>
 297 </li>
 298 </ul>
 299 <a name="getHostnameList--">
 300 <!--   -->
 301 </a>
 302 <ul class="blockList">
 303 <li class="blockList">
 304 <h4>getHostnameList</h4>
 305 <pre>public&nbsp;java.util.List&lt;java.lang.String&gt;&nbsp;getHostnameList()</pre>
 306 <div class="block">Get the list of associated hostnames.</div>
 307 <dl>
 308 <dt><span class="returnLabel">Returns:</span></dt>
 309 <dd>the associated hostnames that define this <code>FlowPattern</code>.</dd>
 310 </dl>
 311 </li>
 312 </ul>
 313 <a name="getLength--">
 314 <!--   -->
 315 </a>
 316 <ul class="blockList">
 317 <li class="blockList">
 318 <h4>getLength</h4>
 319 <pre>public&nbsp;int&nbsp;getLength()</pre>
 320 <div class="block">Get the length of the List of <code>FlowPattern</code>.</div>
 321 <dl>
 322 <dt><span class="returnLabel">Returns:</span></dt>
 323 <dd>the length of the List of <code>FlowPattern</code>.</dd>
 324 </dl>
 325 </li>
 326 </ul>
 327 <a name="getLength-java.lang.String-">
 328 <!--   -->
 329 </a>
 330 <ul class="blockListLast">
 331 <li class="blockList">
 332 <h4>getLength</h4>
 333 <pre>public&nbsp;int&nbsp;getLength(java.lang.String&nbsp;hostname)</pre>
 334 <div class="block">Get the length of the List of <code>FlowPattern</code>.</div>
 335 <dl>
 336 <dt><span class="returnLabel">Returns:</span></dt>
 337 <dd>the length of the List of <code>FlowPattern</code>.</dd>
 338 </dl>
 339 </li>
 340 </ul>
 341 </li>
 342 </ul>
 343 </li>
 344 </ul>
 345 </div>
 346 </div>
 347 <!-- ========= END OF CLASS DATA ========= -->
 348 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 349 <div class="bottomNav"><a name="navbar.bottom">
 350 <!--   -->
 351 </a>
 352 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
 353 <a name="navbar.bottom.firstrow">
 354 <!--   -->
 355 </a>
 356 <ul class="navList" title="Navigation">
 357 <li><a href="../../../overview-summary.html">Overview</a></li>
 358 <li><a href="package-summary.html">Package</a></li>
 359 <li class="navBarCell1Rev">Class</li>
 360 <li><a href="package-tree.html">Tree</a></li>
 361 <li><a href="../../../deprecated-list.html">Deprecated</a></li>
 362 <li><a href="../../../index-files/index-1.html">Index</a></li>
 363 <li><a href="../../../help-doc.html">Help</a></li>
 364 </ul>
 365 </div>
 366 <div class="subNav">
 367 <ul class="navList">
 368 <li><a href="../../../edu/uci/iotproject/DnsMap.html" title="class in edu.uci.iotproject"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 369 <li><a href="../../../edu/uci/iotproject/SignatureGenerator.html" title="class in edu.uci.iotproject"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 370 </ul>
 371 <ul class="navList">
 372 <li><a href="../../../index.html?edu/uci/iotproject/FlowPattern.html" target="_top">Frames</a></li>
 373 <li><a href="FlowPattern.html" target="_top">No&nbsp;Frames</a></li>
 374 </ul>
 375 <ul class="navList" id="allclasses_navbar_bottom">
 376 <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
 377 </ul>
 378 <div>
 379 <script type="text/javascript"><!--
 380   allClassesLink = document.getElementById("allclasses_navbar_bottom");
 381   if(window==top) {
 382     allClassesLink.style.display = "block";
 383   }
 384   else {
 385     allClassesLink.style.display = "none";
 386   }
 387   //-->
 388 </script>
 389 </div>
 390 <div>
 391 <ul class="subNavList">
 392 <li>Summary:&nbsp;</li>
 393 <li>Nested&nbsp;|&nbsp;</li>
 394 <li>Field&nbsp;|&nbsp;</li>
 395 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
 396 <li><a href="#method.summary">Method</a></li>
 397 </ul>
 398 <ul class="subNavList">
 399 <li>Detail:&nbsp;</li>
 400 <li>Field&nbsp;|&nbsp;</li>
 401 <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
 402 <li><a href="#method.detail">Method</a></li>
 403 </ul>
 404 </div>
 405 <a name="skip.navbar.bottom">
 406 <!--   -->
 407 </a></div>
 408 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 409 </body>
 410 </html>