Code/Projects/PacketLevelSignatureExtractor/javadoc/edu/uci/iotproject/detection/layer2/Layer2SignatureDetector.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>Layer2SignatureDetector</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="Layer2SignatureDetector";
  16         }
  17     }
  18     catch(err) {
  19     }
  20 //-->
  21 var methods = {"i0":10,"i1":10,"i2":9,"i3":10,"i4":10};
  22 var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/detection/layer2/Layer2SequenceMatcher.html" title="class in edu.uci.iotproject.detection.layer2"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  52 <li>Next&nbsp;Class</li>
  53 </ul>
  54 <ul class="navList">
  55 <li><a href="../../../../../index.html?edu/uci/iotproject/detection/layer2/Layer2SignatureDetector.html" target="_top">Frames</a></li>
  56 <li><a href="Layer2SignatureDetector.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.detection.layer2</div>
  95 <h2 title="Class Layer2SignatureDetector" class="title">Class Layer2SignatureDetector</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.detection.layer2.Layer2SignatureDetector</li>
 103 </ul>
 104 </li>
 105 </ul>
 106 <div class="description">
 107 <ul class="blockList">
 108 <li class="blockList">
 109 <dl>
 110 <dt>All Implemented Interfaces:</dt>
 111 <dd><a href="../../../../../edu/uci/iotproject/detection/ClusterMatcherObserver.html" title="interface in edu.uci.iotproject.detection">ClusterMatcherObserver</a>, org.pcap4j.core.PacketListener</dd>
 112 </dl>
 113 <hr>
 114 <br>
 115 <pre>public class <span class="typeNameLabel">Layer2SignatureDetector</span>
 116 extends java.lang.Object
 117 implements org.pcap4j.core.PacketListener, <a href="../../../../../edu/uci/iotproject/detection/ClusterMatcherObserver.html" title="interface in edu.uci.iotproject.detection">ClusterMatcherObserver</a></pre>
 118 <div class="block">Performs layer 2 signature detection.</div>
 119 </li>
 120 </ul>
 121 </div>
 122 <div class="summary">
 123 <ul class="blockList">
 124 <li class="blockList">
 125 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 126 <ul class="blockList">
 127 <li class="blockList"><a name="constructor.summary">
 128 <!--   -->
 129 </a>
 130 <h3>Constructor Summary</h3>
 131 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
 132 <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
 133 <tr>
 134 <th class="colOne" scope="col">Constructor and Description</th>
 135 </tr>
 136 <tr class="altColor">
 137 <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../edu/uci/iotproject/detection/layer2/Layer2SignatureDetector.html#Layer2SignatureDetector-java.util.List-int-boolean-double-">Layer2SignatureDetector</a></span>(java.util.List&lt;java.util.List&lt;java.util.List&lt;org.pcap4j.core.PcapPacket&gt;&gt;&gt;&nbsp;searchedSignature,
 138                        int&nbsp;signatureDuration,
 139                        boolean&nbsp;isRangeBased,
 140                        double&nbsp;eps)</code>&nbsp;</td>
 141 </tr>
 142 <tr class="rowColor">
 143 <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../edu/uci/iotproject/detection/layer2/Layer2SignatureDetector.html#Layer2SignatureDetector-java.util.List-java.util.List-int-boolean-double-">Layer2SignatureDetector</a></span>(java.util.List&lt;java.util.List&lt;java.util.List&lt;org.pcap4j.core.PcapPacket&gt;&gt;&gt;&nbsp;searchedSignature,
 144                        java.util.List&lt;java.util.function.Function&lt;<a href="../../../../../edu/uci/iotproject/trafficreassembly/layer2/Layer2Flow.html" title="class in edu.uci.iotproject.trafficreassembly.layer2">Layer2Flow</a>,java.lang.Boolean&gt;&gt;&nbsp;flowFilters,
 145                        int&nbsp;inclusionTimeMillis,
 146                        boolean&nbsp;isRangeBased,
 147                        double&nbsp;eps)</code>&nbsp;</td>
 148 </tr>
 149 </table>
 150 </li>
 151 </ul>
 152 <!-- ========== METHOD SUMMARY =========== -->
 153 <ul class="blockList">
 154 <li class="blockList"><a name="method.summary">
 155 <!--   -->
 156 </a>
 157 <h3>Method Summary</h3>
 158 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
 159 <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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>
 160 <tr>
 161 <th class="colFirst" scope="col">Modifier and Type</th>
 162 <th class="colLast" scope="col">Method and Description</th>
 163 </tr>
 164 <tr id="i0" class="altColor">
 165 <td class="colFirst"><code>void</code></td>
 166 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/uci/iotproject/detection/layer2/Layer2SignatureDetector.html#addObserver-edu.uci.iotproject.detection.SignatureDetectorObserver-">addObserver</a></span>(<a href="../../../../../edu/uci/iotproject/detection/SignatureDetectorObserver.html" title="interface in edu.uci.iotproject.detection">SignatureDetectorObserver</a>&nbsp;observer)</code>&nbsp;</td>
 167 </tr>
 168 <tr id="i1" class="rowColor">
 169 <td class="colFirst"><code>void</code></td>
 170 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/uci/iotproject/detection/layer2/Layer2SignatureDetector.html#gotPacket-org.pcap4j.core.PcapPacket-">gotPacket</a></span>(org.pcap4j.core.PcapPacket&nbsp;packet)</code>&nbsp;</td>
 171 </tr>
 172 <tr id="i2" class="altColor">
 173 <td class="colFirst"><code>static void</code></td>
 174 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/uci/iotproject/detection/layer2/Layer2SignatureDetector.html#main-java.lang.String:A-">main</a></span>(java.lang.String[]&nbsp;args)</code>&nbsp;</td>
 175 </tr>
 176 <tr id="i3" class="rowColor">
 177 <td class="colFirst"><code>void</code></td>
 178 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/uci/iotproject/detection/layer2/Layer2SignatureDetector.html#onMatch-edu.uci.iotproject.detection.AbstractClusterMatcher-java.util.List-">onMatch</a></span>(<a href="../../../../../edu/uci/iotproject/detection/AbstractClusterMatcher.html" title="class in edu.uci.iotproject.detection">AbstractClusterMatcher</a>&nbsp;clusterMatcher,
 179        java.util.List&lt;org.pcap4j.core.PcapPacket&gt;&nbsp;match)</code>
 180 <div class="block">Callback that is invoked by an <a href="../../../../../edu/uci/iotproject/detection/AbstractClusterMatcher.html" title="class in edu.uci.iotproject.detection"><code>AbstractClusterMatcher</code></a> whenever it detects traffic that matches an element
 181  of its associated cluster.</div>
 182 </td>
 183 </tr>
 184 <tr id="i4" class="altColor">
 185 <td class="colFirst"><code>boolean</code></td>
 186 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/uci/iotproject/detection/layer2/Layer2SignatureDetector.html#removeObserver-edu.uci.iotproject.detection.SignatureDetectorObserver-">removeObserver</a></span>(<a href="../../../../../edu/uci/iotproject/detection/SignatureDetectorObserver.html" title="interface in edu.uci.iotproject.detection">SignatureDetectorObserver</a>&nbsp;observer)</code>&nbsp;</td>
 187 </tr>
 188 </table>
 189 <ul class="blockList">
 190 <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
 191 <!--   -->
 192 </a>
 193 <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
 194 <code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
 195 </ul>
 196 </li>
 197 </ul>
 198 </li>
 199 </ul>
 200 </div>
 201 <div class="details">
 202 <ul class="blockList">
 203 <li class="blockList">
 204 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 205 <ul class="blockList">
 206 <li class="blockList"><a name="constructor.detail">
 207 <!--   -->
 208 </a>
 209 <h3>Constructor Detail</h3>
 210 <a name="Layer2SignatureDetector-java.util.List-int-boolean-double-">
 211 <!--   -->
 212 </a>
 213 <ul class="blockList">
 214 <li class="blockList">
 215 <h4>Layer2SignatureDetector</h4>
 216 <pre>public&nbsp;Layer2SignatureDetector(java.util.List&lt;java.util.List&lt;java.util.List&lt;org.pcap4j.core.PcapPacket&gt;&gt;&gt;&nbsp;searchedSignature,
 217                                int&nbsp;signatureDuration,
 218                                boolean&nbsp;isRangeBased,
 219                                double&nbsp;eps)</pre>
 220 </li>
 221 </ul>
 222 <a name="Layer2SignatureDetector-java.util.List-java.util.List-int-boolean-double-">
 223 <!--   -->
 224 </a>
 225 <ul class="blockListLast">
 226 <li class="blockList">
 227 <h4>Layer2SignatureDetector</h4>
 228 <pre>public&nbsp;Layer2SignatureDetector(java.util.List&lt;java.util.List&lt;java.util.List&lt;org.pcap4j.core.PcapPacket&gt;&gt;&gt;&nbsp;searchedSignature,
 229                                java.util.List&lt;java.util.function.Function&lt;<a href="../../../../../edu/uci/iotproject/trafficreassembly/layer2/Layer2Flow.html" title="class in edu.uci.iotproject.trafficreassembly.layer2">Layer2Flow</a>,java.lang.Boolean&gt;&gt;&nbsp;flowFilters,
 230                                int&nbsp;inclusionTimeMillis,
 231                                boolean&nbsp;isRangeBased,
 232                                double&nbsp;eps)</pre>
 233 </li>
 234 </ul>
 235 </li>
 236 </ul>
 237 <!-- ============ METHOD DETAIL ========== -->
 238 <ul class="blockList">
 239 <li class="blockList"><a name="method.detail">
 240 <!--   -->
 241 </a>
 242 <h3>Method Detail</h3>
 243 <a name="main-java.lang.String:A-">
 244 <!--   -->
 245 </a>
 246 <ul class="blockList">
 247 <li class="blockList">
 248 <h4>main</h4>
 249 <pre>public static&nbsp;void&nbsp;main(java.lang.String[]&nbsp;args)
 250                  throws org.pcap4j.core.PcapNativeException,
 251                         org.pcap4j.core.NotOpenException,
 252                         java.io.IOException</pre>
 253 <dl>
 254 <dt><span class="throwsLabel">Throws:</span></dt>
 255 <dd><code>org.pcap4j.core.PcapNativeException</code></dd>
 256 <dd><code>org.pcap4j.core.NotOpenException</code></dd>
 257 <dd><code>java.io.IOException</code></dd>
 258 </dl>
 259 </li>
 260 </ul>
 261 <a name="gotPacket-org.pcap4j.core.PcapPacket-">
 262 <!--   -->
 263 </a>
 264 <ul class="blockList">
 265 <li class="blockList">
 266 <h4>gotPacket</h4>
 267 <pre>public&nbsp;void&nbsp;gotPacket(org.pcap4j.core.PcapPacket&nbsp;packet)</pre>
 268 <dl>
 269 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 270 <dd><code>gotPacket</code>&nbsp;in interface&nbsp;<code>org.pcap4j.core.PacketListener</code></dd>
 271 </dl>
 272 </li>
 273 </ul>
 274 <a name="onMatch-edu.uci.iotproject.detection.AbstractClusterMatcher-java.util.List-">
 275 <!--   -->
 276 </a>
 277 <ul class="blockList">
 278 <li class="blockList">
 279 <h4>onMatch</h4>
 280 <pre>public&nbsp;void&nbsp;onMatch(<a href="../../../../../edu/uci/iotproject/detection/AbstractClusterMatcher.html" title="class in edu.uci.iotproject.detection">AbstractClusterMatcher</a>&nbsp;clusterMatcher,
 281                     java.util.List&lt;org.pcap4j.core.PcapPacket&gt;&nbsp;match)</pre>
 282 <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../edu/uci/iotproject/detection/ClusterMatcherObserver.html#onMatch-edu.uci.iotproject.detection.AbstractClusterMatcher-java.util.List-">ClusterMatcherObserver</a></code></span></div>
 283 <div class="block">Callback that is invoked by an <a href="../../../../../edu/uci/iotproject/detection/AbstractClusterMatcher.html" title="class in edu.uci.iotproject.detection"><code>AbstractClusterMatcher</code></a> whenever it detects traffic that matches an element
 284  of its associated cluster.</div>
 285 <dl>
 286 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 287 <dd><code><a href="../../../../../edu/uci/iotproject/detection/ClusterMatcherObserver.html#onMatch-edu.uci.iotproject.detection.AbstractClusterMatcher-java.util.List-">onMatch</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../edu/uci/iotproject/detection/ClusterMatcherObserver.html" title="interface in edu.uci.iotproject.detection">ClusterMatcherObserver</a></code></dd>
 288 <dt><span class="paramLabel">Parameters:</span></dt>
 289 <dd><code>clusterMatcher</code> - The <a href="../../../../../edu/uci/iotproject/detection/AbstractClusterMatcher.html" title="class in edu.uci.iotproject.detection"><code>AbstractClusterMatcher</code></a> that detected a match (i.e., classified traffic as
 290                        pertaining to its associated cluster).</dd>
 291 <dd><code>match</code> - The traffic that was deemed to match the cluster associated with <code>clusterMatcher</code>.</dd>
 292 </dl>
 293 </li>
 294 </ul>
 295 <a name="addObserver-edu.uci.iotproject.detection.SignatureDetectorObserver-">
 296 <!--   -->
 297 </a>
 298 <ul class="blockList">
 299 <li class="blockList">
 300 <h4>addObserver</h4>
 301 <pre>public&nbsp;void&nbsp;addObserver(<a href="../../../../../edu/uci/iotproject/detection/SignatureDetectorObserver.html" title="interface in edu.uci.iotproject.detection">SignatureDetectorObserver</a>&nbsp;observer)</pre>
 302 </li>
 303 </ul>
 304 <a name="removeObserver-edu.uci.iotproject.detection.SignatureDetectorObserver-">
 305 <!--   -->
 306 </a>
 307 <ul class="blockListLast">
 308 <li class="blockList">
 309 <h4>removeObserver</h4>
 310 <pre>public&nbsp;boolean&nbsp;removeObserver(<a href="../../../../../edu/uci/iotproject/detection/SignatureDetectorObserver.html" title="interface in edu.uci.iotproject.detection">SignatureDetectorObserver</a>&nbsp;observer)</pre>
 311 </li>
 312 </ul>
 313 </li>
 314 </ul>
 315 </li>
 316 </ul>
 317 </div>
 318 </div>
 319 <!-- ========= END OF CLASS DATA ========= -->
 320 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 321 <div class="bottomNav"><a name="navbar.bottom">
 322 <!--   -->
 323 </a>
 324 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
 325 <a name="navbar.bottom.firstrow">
 326 <!--   -->
 327 </a>
 328 <ul class="navList" title="Navigation">
 329 <li><a href="../../../../../overview-summary.html">Overview</a></li>
 330 <li><a href="package-summary.html">Package</a></li>
 331 <li class="navBarCell1Rev">Class</li>
 332 <li><a href="package-tree.html">Tree</a></li>
 333 <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
 334 <li><a href="../../../../../index-files/index-1.html">Index</a></li>
 335 <li><a href="../../../../../help-doc.html">Help</a></li>
 336 </ul>
 337 </div>
 338 <div class="subNav">
 339 <ul class="navList">
 340 <li><a href="../../../../../edu/uci/iotproject/detection/layer2/Layer2SequenceMatcher.html" title="class in edu.uci.iotproject.detection.layer2"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 341 <li>Next&nbsp;Class</li>
 342 </ul>
 343 <ul class="navList">
 344 <li><a href="../../../../../index.html?edu/uci/iotproject/detection/layer2/Layer2SignatureDetector.html" target="_top">Frames</a></li>
 345 <li><a href="Layer2SignatureDetector.html" target="_top">No&nbsp;Frames</a></li>
 346 </ul>
 347 <ul class="navList" id="allclasses_navbar_bottom">
 348 <li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
 349 </ul>
 350 <div>
 351 <script type="text/javascript"><!--
 352   allClassesLink = document.getElementById("allclasses_navbar_bottom");
 353   if(window==top) {
 354     allClassesLink.style.display = "block";
 355   }
 356   else {
 357     allClassesLink.style.display = "none";
 358   }
 359   //-->
 360 </script>
 361 </div>
 362 <div>
 363 <ul class="subNavList">
 364 <li>Summary:&nbsp;</li>
 365 <li>Nested&nbsp;|&nbsp;</li>
 366 <li>Field&nbsp;|&nbsp;</li>
 367 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
 368 <li><a href="#method.summary">Method</a></li>
 369 </ul>
 370 <ul class="subNavList">
 371 <li>Detail:&nbsp;</li>
 372 <li>Field&nbsp;|&nbsp;</li>
 373 <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
 374 <li><a href="#method.detail">Method</a></li>
 375 </ul>
 376 </div>
 377 <a name="skip.navbar.bottom">
 378 <!--   -->
 379 </a></div>
 380 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 381 </body>
 382 </html>