Adding Javadoc documentation.
[pingpong.git] / Code / Projects / PacketLevelSignatureExtractor / javadoc / edu / uci / iotproject / DnsMap.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:58 PDT 2019 -->
6 <title>DnsMap</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="DnsMap";
16         }
17     }
18     catch(err) {
19     }
20 //-->
21 var methods = {"i0":10,"i1":10,"i2":10,"i3":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>Prev&nbsp;Class</li>
52 <li><a href="../../../edu/uci/iotproject/FlowPattern.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/DnsMap.html" target="_top">Frames</a></li>
56 <li><a href="DnsMap.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 DnsMap" class="title">Class DnsMap</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.DnsMap</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>org.pcap4j.core.PacketListener</dd>
112 </dl>
113 <hr>
114 <br>
115 <pre>public class <span class="typeNameLabel">DnsMap</span>
116 extends java.lang.Object
117 implements org.pcap4j.core.PacketListener</pre>
118 <div class="block">This is a class that does DNS mapping.
119  Basically an IP address is mapped to its
120  respective DNS hostnames.</div>
121 </li>
122 </ul>
123 </div>
124 <div class="summary">
125 <ul class="blockList">
126 <li class="blockList">
127 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
128 <ul class="blockList">
129 <li class="blockList"><a name="constructor.summary">
130 <!--   -->
131 </a>
132 <h3>Constructor Summary</h3>
133 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
134 <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
135 <tr>
136 <th class="colOne" scope="col">Constructor and Description</th>
137 </tr>
138 <tr class="altColor">
139 <td class="colOne"><code><span class="memberNameLink"><a href="../../../edu/uci/iotproject/DnsMap.html#DnsMap--">DnsMap</a></span>()</code>&nbsp;</td>
140 </tr>
141 </table>
142 </li>
143 </ul>
144 <!-- ========== METHOD SUMMARY =========== -->
145 <ul class="blockList">
146 <li class="blockList"><a name="method.summary">
147 <!--   -->
148 </a>
149 <h3>Method Summary</h3>
150 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
151 <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>
152 <tr>
153 <th class="colFirst" scope="col">Modifier and Type</th>
154 <th class="colLast" scope="col">Method and Description</th>
155 </tr>
156 <tr id="i0" class="altColor">
157 <td class="colFirst"><code>java.util.Set&lt;java.lang.String&gt;</code></td>
158 <td class="colLast"><code><span class="memberNameLink"><a href="../../../edu/uci/iotproject/DnsMap.html#getHostnamesForIp-java.lang.String-">getHostnamesForIp</a></span>(java.lang.String&nbsp;ip)</code>&nbsp;</td>
159 </tr>
160 <tr id="i1" class="rowColor">
161 <td class="colFirst"><code>void</code></td>
162 <td class="colLast"><code><span class="memberNameLink"><a href="../../../edu/uci/iotproject/DnsMap.html#gotPacket-org.pcap4j.core.PcapPacket-">gotPacket</a></span>(org.pcap4j.core.PcapPacket&nbsp;packet)</code>&nbsp;</td>
163 </tr>
164 <tr id="i2" class="altColor">
165 <td class="colFirst"><code>boolean</code></td>
166 <td class="colLast"><code><span class="memberNameLink"><a href="../../../edu/uci/iotproject/DnsMap.html#isRelatedToCloudServer-java.lang.String-java.lang.String-">isRelatedToCloudServer</a></span>(java.lang.String&nbsp;address,
167                       java.lang.String&nbsp;hostname)</code>
168 <div class="block">Checks DNS packet and build the map data structure that
169  maps IP addresses to DNS hostnames</div>
170 </td>
171 </tr>
172 <tr id="i3" class="rowColor">
173 <td class="colFirst"><code>void</code></td>
174 <td class="colLast"><code><span class="memberNameLink"><a href="../../../edu/uci/iotproject/DnsMap.html#validateAndAddNewEntry-org.pcap4j.core.PcapPacket-">validateAndAddNewEntry</a></span>(org.pcap4j.core.PcapPacket&nbsp;packet)</code>
175 <div class="block">Checks DNS packet and build the map data structure that
176  maps IP addresses to DNS hostnames</div>
177 </td>
178 </tr>
179 </table>
180 <ul class="blockList">
181 <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
182 <!--   -->
183 </a>
184 <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
185 <code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
186 </ul>
187 </li>
188 </ul>
189 </li>
190 </ul>
191 </div>
192 <div class="details">
193 <ul class="blockList">
194 <li class="blockList">
195 <!-- ========= CONSTRUCTOR DETAIL ======== -->
196 <ul class="blockList">
197 <li class="blockList"><a name="constructor.detail">
198 <!--   -->
199 </a>
200 <h3>Constructor Detail</h3>
201 <a name="DnsMap--">
202 <!--   -->
203 </a>
204 <ul class="blockListLast">
205 <li class="blockList">
206 <h4>DnsMap</h4>
207 <pre>public&nbsp;DnsMap()</pre>
208 </li>
209 </ul>
210 </li>
211 </ul>
212 <!-- ============ METHOD DETAIL ========== -->
213 <ul class="blockList">
214 <li class="blockList"><a name="method.detail">
215 <!--   -->
216 </a>
217 <h3>Method Detail</h3>
218 <a name="gotPacket-org.pcap4j.core.PcapPacket-">
219 <!--   -->
220 </a>
221 <ul class="blockList">
222 <li class="blockList">
223 <h4>gotPacket</h4>
224 <pre>public&nbsp;void&nbsp;gotPacket(org.pcap4j.core.PcapPacket&nbsp;packet)</pre>
225 <dl>
226 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
227 <dd><code>gotPacket</code>&nbsp;in interface&nbsp;<code>org.pcap4j.core.PacketListener</code></dd>
228 </dl>
229 </li>
230 </ul>
231 <a name="validateAndAddNewEntry-org.pcap4j.core.PcapPacket-">
232 <!--   -->
233 </a>
234 <ul class="blockList">
235 <li class="blockList">
236 <h4>validateAndAddNewEntry</h4>
237 <pre>public&nbsp;void&nbsp;validateAndAddNewEntry(org.pcap4j.core.PcapPacket&nbsp;packet)
238                             throws java.net.UnknownHostException</pre>
239 <div class="block">Checks DNS packet and build the map data structure that
240  maps IP addresses to DNS hostnames</div>
241 <dl>
242 <dt><span class="paramLabel">Parameters:</span></dt>
243 <dd><code>packet</code> - PcapPacket object</dd>
244 <dt><span class="throwsLabel">Throws:</span></dt>
245 <dd><code>java.net.UnknownHostException</code></dd>
246 </dl>
247 </li>
248 </ul>
249 <a name="isRelatedToCloudServer-java.lang.String-java.lang.String-">
250 <!--   -->
251 </a>
252 <ul class="blockList">
253 <li class="blockList">
254 <h4>isRelatedToCloudServer</h4>
255 <pre>public&nbsp;boolean&nbsp;isRelatedToCloudServer(java.lang.String&nbsp;address,
256                                       java.lang.String&nbsp;hostname)</pre>
257 <div class="block">Checks DNS packet and build the map data structure that
258  maps IP addresses to DNS hostnames</div>
259 <dl>
260 <dt><span class="paramLabel">Parameters:</span></dt>
261 <dd><code>address</code> - Address to check</dd>
262 <dd><code>hostname</code> - Hostname to check</dd>
263 </dl>
264 </li>
265 </ul>
266 <a name="getHostnamesForIp-java.lang.String-">
267 <!--   -->
268 </a>
269 <ul class="blockListLast">
270 <li class="blockList">
271 <h4>getHostnamesForIp</h4>
272 <pre>public&nbsp;java.util.Set&lt;java.lang.String&gt;&nbsp;getHostnamesForIp(java.lang.String&nbsp;ip)</pre>
273 </li>
274 </ul>
275 </li>
276 </ul>
277 </li>
278 </ul>
279 </div>
280 </div>
281 <!-- ========= END OF CLASS DATA ========= -->
282 <!-- ======= START OF BOTTOM NAVBAR ====== -->
283 <div class="bottomNav"><a name="navbar.bottom">
284 <!--   -->
285 </a>
286 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
287 <a name="navbar.bottom.firstrow">
288 <!--   -->
289 </a>
290 <ul class="navList" title="Navigation">
291 <li><a href="../../../overview-summary.html">Overview</a></li>
292 <li><a href="package-summary.html">Package</a></li>
293 <li class="navBarCell1Rev">Class</li>
294 <li><a href="package-tree.html">Tree</a></li>
295 <li><a href="../../../deprecated-list.html">Deprecated</a></li>
296 <li><a href="../../../index-files/index-1.html">Index</a></li>
297 <li><a href="../../../help-doc.html">Help</a></li>
298 </ul>
299 </div>
300 <div class="subNav">
301 <ul class="navList">
302 <li>Prev&nbsp;Class</li>
303 <li><a href="../../../edu/uci/iotproject/FlowPattern.html" title="class in edu.uci.iotproject"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
304 </ul>
305 <ul class="navList">
306 <li><a href="../../../index.html?edu/uci/iotproject/DnsMap.html" target="_top">Frames</a></li>
307 <li><a href="DnsMap.html" target="_top">No&nbsp;Frames</a></li>
308 </ul>
309 <ul class="navList" id="allclasses_navbar_bottom">
310 <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
311 </ul>
312 <div>
313 <script type="text/javascript"><!--
314   allClassesLink = document.getElementById("allclasses_navbar_bottom");
315   if(window==top) {
316     allClassesLink.style.display = "block";
317   }
318   else {
319     allClassesLink.style.display = "none";
320   }
321   //-->
322 </script>
323 </div>
324 <div>
325 <ul class="subNavList">
326 <li>Summary:&nbsp;</li>
327 <li>Nested&nbsp;|&nbsp;</li>
328 <li>Field&nbsp;|&nbsp;</li>
329 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
330 <li><a href="#method.summary">Method</a></li>
331 </ul>
332 <ul class="subNavList">
333 <li>Detail:&nbsp;</li>
334 <li>Field&nbsp;|&nbsp;</li>
335 <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
336 <li><a href="#method.detail">Method</a></li>
337 </ul>
338 </div>
339 <a name="skip.navbar.bottom">
340 <!--   -->
341 </a></div>
342 <!-- ======== END OF BOTTOM NAVBAR ======= -->
343 </body>
344 </html>