Total Complexity | 72 |
Total Lines | 1126 |
Duplicated Lines | 0 % |
Changes | 0 |
Complex classes like SaveScanProfileApiModel often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use SaveScanProfileApiModel, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
13 | class SaveScanProfileApiModel |
||
14 | { |
||
15 | /** |
||
16 | * Gets or sets the agent group identifier. |
||
17 | * |
||
18 | * @var string |
||
19 | */ |
||
20 | protected $agentGroupId; |
||
21 | /** |
||
22 | * Gets or sets the agent identifier. |
||
23 | * |
||
24 | * @var string |
||
25 | */ |
||
26 | protected $agentId; |
||
27 | /** |
||
28 | * Gets or sets the type of the create. |
||
29 | * |
||
30 | * @var string |
||
31 | */ |
||
32 | protected $createType; |
||
33 | /** |
||
34 | * Gets or sets a value indicating whether this instance is primary. |
||
35 | * |
||
36 | * @var bool |
||
37 | */ |
||
38 | protected $isPrimary; |
||
39 | /** |
||
40 | * Gets or sets a value indicating whether this instance is shared. |
||
41 | * |
||
42 | * @var bool |
||
43 | */ |
||
44 | protected $isShared; |
||
45 | /** |
||
46 | * Gets or sets a value indicating whether timewindow is enabled or not. |
||
47 | * |
||
48 | * @var bool |
||
49 | */ |
||
50 | protected $isTimeWindowEnabled; |
||
51 | /** |
||
52 | * Gets or sets the scan policy identifier. |
||
53 | Default: Default Security Checks |
||
54 | * |
||
55 | * @var string |
||
56 | */ |
||
57 | protected $policyId; |
||
58 | /** |
||
59 | * Gets or sets the profile identifier. |
||
60 | * |
||
61 | * @var string |
||
62 | */ |
||
63 | protected $profileId; |
||
64 | /** |
||
65 | * Gets or sets a name for this instance. |
||
66 | * |
||
67 | * @var string |
||
68 | */ |
||
69 | protected $profileName; |
||
70 | /** |
||
71 | * Gets or sets the report policy identifier. |
||
72 | Default: Default Report Policy |
||
73 | * |
||
74 | * @var string |
||
75 | */ |
||
76 | protected $reportPolicyId; |
||
77 | /** |
||
78 | * Gets or sets the target website URL. |
||
79 | * |
||
80 | * @var string |
||
81 | */ |
||
82 | protected $targetUri; |
||
83 | /** |
||
84 | * Gets or sets the user identifier. |
||
85 | * |
||
86 | * @var string |
||
87 | */ |
||
88 | protected $userId; |
||
89 | /** |
||
90 | * Gets or sets the additional websites to scan. |
||
91 | * |
||
92 | * @var AdditionalWebsiteModel[] |
||
93 | */ |
||
94 | protected $additionalWebsites; |
||
95 | /** |
||
96 | * Represents a model for carrying out basic authentication settings. |
||
97 | * |
||
98 | * @var BasicAuthenticationSettingModel |
||
99 | */ |
||
100 | protected $basicAuthenticationApiModel; |
||
101 | /** |
||
102 | * Represents a model for carrying out client certificate authentication settings. |
||
103 | * |
||
104 | * @var ClientCertificateAuthenticationApiModel |
||
105 | */ |
||
106 | protected $clientCertificateAuthenticationSetting; |
||
107 | /** |
||
108 | * Gets or sets the cookies. Separate multiple cookies with semicolon. Cookie values must be URL encoded. You can use the. |
||
109 | following format: Cookiename=Value |
||
110 | * |
||
111 | * @var string |
||
112 | */ |
||
113 | protected $cookies; |
||
114 | /** |
||
115 | * Gets or sets a value indicating whether parallel attacker is enabled. |
||
116 | Default: true |
||
117 | * |
||
118 | * @var bool |
||
119 | */ |
||
120 | protected $crawlAndAttack; |
||
121 | /** |
||
122 | * Gets or sets a value indicating whether Heuristic URL Rewrite support is enabled together with custom URL Rewrite. |
||
123 | support. |
||
124 | * |
||
125 | * @var bool |
||
126 | */ |
||
127 | protected $enableHeuristicChecksInCustomUrlRewrite; |
||
128 | /** |
||
129 | * Gets or sets the excluded links. |
||
130 | Default: "(log|sign)\\-?(out|off)", "exit", "endsession", "gtm\\.js" |
||
131 | * |
||
132 | * @var ExcludedLinkModel[] |
||
133 | */ |
||
134 | protected $excludedLinks; |
||
135 | /** |
||
136 | * Gets or sets the disallowed http methods. |
||
137 | * |
||
138 | * @var string[] |
||
139 | */ |
||
140 | protected $disallowedHttpMethods; |
||
141 | /** |
||
142 | * Gets or sets a value indicating whether links should be excluded/included. |
||
143 | Default: <see ref="bool.True" /> |
||
144 | * |
||
145 | * @var bool |
||
146 | */ |
||
147 | protected $excludeLinks; |
||
148 | /** |
||
149 | * Gets or sets a value indicating whether automatic crawling is enabled. |
||
150 | * |
||
151 | * @var bool |
||
152 | */ |
||
153 | protected $findAndFollowNewLinks; |
||
154 | /** |
||
155 | * Represents a model for carrying out form authentication settings. |
||
156 | * |
||
157 | * @var FormAuthenticationSettingModel |
||
158 | */ |
||
159 | protected $formAuthenticationSettingModel; |
||
160 | /** |
||
161 | * Represents a model for carrying out header authentication setttings. |
||
162 | * |
||
163 | * @var HeaderAuthenticationModel |
||
164 | */ |
||
165 | protected $headerAuthentication; |
||
166 | /** |
||
167 | * Gets or sets the imported links. |
||
168 | * |
||
169 | * @var string[] |
||
170 | */ |
||
171 | protected $importedLinks; |
||
172 | /** |
||
173 | * Gets or sets the imported files. |
||
174 | * |
||
175 | * @var ApiFileModel[] |
||
176 | */ |
||
177 | protected $importedFiles; |
||
178 | /** |
||
179 | * Gets or sets a value indicating whether max scan duration is enabled. |
||
180 | This is only used for scheduled group scan and regular group scan. |
||
181 | * |
||
182 | * @var bool |
||
183 | */ |
||
184 | protected $isMaxScanDurationEnabled; |
||
185 | /** |
||
186 | * Gets or sets the root path maximum dynamic signatures for heuristic URL Rewrite detection. |
||
187 | Default: 60 |
||
188 | * |
||
189 | * @var int |
||
190 | */ |
||
191 | protected $maxDynamicSignatures; |
||
192 | /** |
||
193 | * Gets or sets the maximum duration of the scan in hours. |
||
194 | Default: 48 hours |
||
195 | * |
||
196 | * @var int |
||
197 | */ |
||
198 | protected $maxScanDuration; |
||
199 | /** |
||
200 | * Gets or sets the scan scope. |
||
201 | Default: {Netsparker.Cloud.Core.Models.ScanTaskScope.EnteredPathAndBelow} |
||
202 | * |
||
203 | * @var string |
||
204 | */ |
||
205 | protected $scope; |
||
206 | /** |
||
207 | * Gets or sets the sub path maximum dynamic signatures for heuristic URL Rewrite detection. |
||
208 | Default: 30 |
||
209 | * |
||
210 | * @var int |
||
211 | */ |
||
212 | protected $subPathMaxDynamicSignatures; |
||
213 | /** |
||
214 | * Represents a model for carrying out scan time window settings. |
||
215 | * |
||
216 | * @var ScanTimeWindowModel |
||
217 | */ |
||
218 | protected $timeWindow; |
||
219 | /** |
||
220 | * Gets or sets the extensions that will be analyzed for heuristic URL Rewrite detection. |
||
221 | Default: htm,html |
||
222 | * |
||
223 | * @var string |
||
224 | */ |
||
225 | protected $urlRewriteAnalyzableExtensions; |
||
226 | /** |
||
227 | * Gets or sets the block separators for heuristic URL Rewrite detection. |
||
228 | Default: /_ $.,;|: |
||
229 | * |
||
230 | * @var string |
||
231 | */ |
||
232 | protected $urlRewriteBlockSeparators; |
||
233 | /** |
||
234 | * Gets or sets the URL Rewrite mode. |
||
235 | Default: Heuristic |
||
236 | * |
||
237 | * @var string |
||
238 | */ |
||
239 | protected $urlRewriteMode; |
||
240 | /** |
||
241 | * Gets or sets the URL Rewrite rules. |
||
242 | * |
||
243 | * @var UrlRewriteRuleModel[] |
||
244 | */ |
||
245 | protected $urlRewriteRules; |
||
246 | |||
247 | /** |
||
248 | * Gets or sets the agent group identifier. |
||
249 | * |
||
250 | * @return string |
||
251 | */ |
||
252 | public function getAgentGroupId(): ?string |
||
253 | { |
||
254 | return $this->agentGroupId; |
||
255 | } |
||
256 | |||
257 | /** |
||
258 | * Gets or sets the agent group identifier. |
||
259 | * |
||
260 | * @param string $agentGroupId |
||
261 | * |
||
262 | * @return self |
||
263 | */ |
||
264 | public function setAgentGroupId(?string $agentGroupId): self |
||
265 | { |
||
266 | $this->agentGroupId = $agentGroupId; |
||
267 | |||
268 | return $this; |
||
269 | } |
||
270 | |||
271 | /** |
||
272 | * Gets or sets the agent identifier. |
||
273 | * |
||
274 | * @return string |
||
275 | */ |
||
276 | public function getAgentId(): ?string |
||
277 | { |
||
278 | return $this->agentId; |
||
279 | } |
||
280 | |||
281 | /** |
||
282 | * Gets or sets the agent identifier. |
||
283 | * |
||
284 | * @param string $agentId |
||
285 | * |
||
286 | * @return self |
||
287 | */ |
||
288 | public function setAgentId(?string $agentId): self |
||
289 | { |
||
290 | $this->agentId = $agentId; |
||
291 | |||
292 | return $this; |
||
293 | } |
||
294 | |||
295 | /** |
||
296 | * Gets or sets the type of the create. |
||
297 | * |
||
298 | * @return string |
||
299 | */ |
||
300 | public function getCreateType(): ?string |
||
301 | { |
||
302 | return $this->createType; |
||
303 | } |
||
304 | |||
305 | /** |
||
306 | * Gets or sets the type of the create. |
||
307 | * |
||
308 | * @param string $createType |
||
309 | * |
||
310 | * @return self |
||
311 | */ |
||
312 | public function setCreateType(?string $createType): self |
||
313 | { |
||
314 | $this->createType = $createType; |
||
315 | |||
316 | return $this; |
||
317 | } |
||
318 | |||
319 | /** |
||
320 | * Gets or sets a value indicating whether this instance is primary. |
||
321 | * |
||
322 | * @return bool |
||
323 | */ |
||
324 | public function getIsPrimary(): ?bool |
||
325 | { |
||
326 | return $this->isPrimary; |
||
327 | } |
||
328 | |||
329 | /** |
||
330 | * Gets or sets a value indicating whether this instance is primary. |
||
331 | * |
||
332 | * @param bool $isPrimary |
||
333 | * |
||
334 | * @return self |
||
335 | */ |
||
336 | public function setIsPrimary(?bool $isPrimary): self |
||
337 | { |
||
338 | $this->isPrimary = $isPrimary; |
||
339 | |||
340 | return $this; |
||
341 | } |
||
342 | |||
343 | /** |
||
344 | * Gets or sets a value indicating whether this instance is shared. |
||
345 | * |
||
346 | * @return bool |
||
347 | */ |
||
348 | public function getIsShared(): ?bool |
||
349 | { |
||
350 | return $this->isShared; |
||
351 | } |
||
352 | |||
353 | /** |
||
354 | * Gets or sets a value indicating whether this instance is shared. |
||
355 | * |
||
356 | * @param bool $isShared |
||
357 | * |
||
358 | * @return self |
||
359 | */ |
||
360 | public function setIsShared(?bool $isShared): self |
||
361 | { |
||
362 | $this->isShared = $isShared; |
||
363 | |||
364 | return $this; |
||
365 | } |
||
366 | |||
367 | /** |
||
368 | * Gets or sets a value indicating whether timewindow is enabled or not. |
||
369 | * |
||
370 | * @return bool |
||
371 | */ |
||
372 | public function getIsTimeWindowEnabled(): ?bool |
||
373 | { |
||
374 | return $this->isTimeWindowEnabled; |
||
375 | } |
||
376 | |||
377 | /** |
||
378 | * Gets or sets a value indicating whether timewindow is enabled or not. |
||
379 | * |
||
380 | * @param bool $isTimeWindowEnabled |
||
381 | * |
||
382 | * @return self |
||
383 | */ |
||
384 | public function setIsTimeWindowEnabled(?bool $isTimeWindowEnabled): self |
||
385 | { |
||
386 | $this->isTimeWindowEnabled = $isTimeWindowEnabled; |
||
387 | |||
388 | return $this; |
||
389 | } |
||
390 | |||
391 | /** |
||
392 | * Gets or sets the scan policy identifier. |
||
393 | Default: Default Security Checks |
||
394 | * |
||
395 | * @return string |
||
396 | */ |
||
397 | public function getPolicyId(): ?string |
||
398 | { |
||
399 | return $this->policyId; |
||
400 | } |
||
401 | |||
402 | /** |
||
403 | * Gets or sets the scan policy identifier. |
||
404 | Default: Default Security Checks |
||
405 | * |
||
406 | * @param string $policyId |
||
407 | * |
||
408 | * @return self |
||
409 | */ |
||
410 | public function setPolicyId(?string $policyId): self |
||
411 | { |
||
412 | $this->policyId = $policyId; |
||
413 | |||
414 | return $this; |
||
415 | } |
||
416 | |||
417 | /** |
||
418 | * Gets or sets the profile identifier. |
||
419 | * |
||
420 | * @return string |
||
421 | */ |
||
422 | public function getProfileId(): ?string |
||
423 | { |
||
424 | return $this->profileId; |
||
425 | } |
||
426 | |||
427 | /** |
||
428 | * Gets or sets the profile identifier. |
||
429 | * |
||
430 | * @param string $profileId |
||
431 | * |
||
432 | * @return self |
||
433 | */ |
||
434 | public function setProfileId(?string $profileId): self |
||
435 | { |
||
436 | $this->profileId = $profileId; |
||
437 | |||
438 | return $this; |
||
439 | } |
||
440 | |||
441 | /** |
||
442 | * Gets or sets a name for this instance. |
||
443 | * |
||
444 | * @return string |
||
445 | */ |
||
446 | public function getProfileName(): ?string |
||
447 | { |
||
448 | return $this->profileName; |
||
449 | } |
||
450 | |||
451 | /** |
||
452 | * Gets or sets a name for this instance. |
||
453 | * |
||
454 | * @param string $profileName |
||
455 | * |
||
456 | * @return self |
||
457 | */ |
||
458 | public function setProfileName(?string $profileName): self |
||
459 | { |
||
460 | $this->profileName = $profileName; |
||
461 | |||
462 | return $this; |
||
463 | } |
||
464 | |||
465 | /** |
||
466 | * Gets or sets the report policy identifier. |
||
467 | Default: Default Report Policy |
||
468 | * |
||
469 | * @return string |
||
470 | */ |
||
471 | public function getReportPolicyId(): ?string |
||
472 | { |
||
473 | return $this->reportPolicyId; |
||
474 | } |
||
475 | |||
476 | /** |
||
477 | * Gets or sets the report policy identifier. |
||
478 | Default: Default Report Policy |
||
479 | * |
||
480 | * @param string $reportPolicyId |
||
481 | * |
||
482 | * @return self |
||
483 | */ |
||
484 | public function setReportPolicyId(?string $reportPolicyId): self |
||
485 | { |
||
486 | $this->reportPolicyId = $reportPolicyId; |
||
487 | |||
488 | return $this; |
||
489 | } |
||
490 | |||
491 | /** |
||
492 | * Gets or sets the target website URL. |
||
493 | * |
||
494 | * @return string |
||
495 | */ |
||
496 | public function getTargetUri(): ?string |
||
497 | { |
||
498 | return $this->targetUri; |
||
499 | } |
||
500 | |||
501 | /** |
||
502 | * Gets or sets the target website URL. |
||
503 | * |
||
504 | * @param string $targetUri |
||
505 | * |
||
506 | * @return self |
||
507 | */ |
||
508 | public function setTargetUri(?string $targetUri): self |
||
509 | { |
||
510 | $this->targetUri = $targetUri; |
||
511 | |||
512 | return $this; |
||
513 | } |
||
514 | |||
515 | /** |
||
516 | * Gets or sets the user identifier. |
||
517 | * |
||
518 | * @return string |
||
519 | */ |
||
520 | public function getUserId(): ?string |
||
521 | { |
||
522 | return $this->userId; |
||
523 | } |
||
524 | |||
525 | /** |
||
526 | * Gets or sets the user identifier. |
||
527 | * |
||
528 | * @param string $userId |
||
529 | * |
||
530 | * @return self |
||
531 | */ |
||
532 | public function setUserId(?string $userId): self |
||
533 | { |
||
534 | $this->userId = $userId; |
||
535 | |||
536 | return $this; |
||
537 | } |
||
538 | |||
539 | /** |
||
540 | * Gets or sets the additional websites to scan. |
||
541 | * |
||
542 | * @return AdditionalWebsiteModel[] |
||
543 | */ |
||
544 | public function getAdditionalWebsites(): ?array |
||
545 | { |
||
546 | return $this->additionalWebsites; |
||
547 | } |
||
548 | |||
549 | /** |
||
550 | * Gets or sets the additional websites to scan. |
||
551 | * |
||
552 | * @param AdditionalWebsiteModel[] $additionalWebsites |
||
553 | * |
||
554 | * @return self |
||
555 | */ |
||
556 | public function setAdditionalWebsites(?array $additionalWebsites): self |
||
557 | { |
||
558 | $this->additionalWebsites = $additionalWebsites; |
||
559 | |||
560 | return $this; |
||
561 | } |
||
562 | |||
563 | /** |
||
564 | * Represents a model for carrying out basic authentication settings. |
||
565 | * |
||
566 | * @return BasicAuthenticationSettingModel |
||
567 | */ |
||
568 | public function getBasicAuthenticationApiModel(): ?BasicAuthenticationSettingModel |
||
569 | { |
||
570 | return $this->basicAuthenticationApiModel; |
||
571 | } |
||
572 | |||
573 | /** |
||
574 | * Represents a model for carrying out basic authentication settings. |
||
575 | * |
||
576 | * @param BasicAuthenticationSettingModel $basicAuthenticationApiModel |
||
577 | * |
||
578 | * @return self |
||
579 | */ |
||
580 | public function setBasicAuthenticationApiModel(?BasicAuthenticationSettingModel $basicAuthenticationApiModel): self |
||
581 | { |
||
582 | $this->basicAuthenticationApiModel = $basicAuthenticationApiModel; |
||
583 | |||
584 | return $this; |
||
585 | } |
||
586 | |||
587 | /** |
||
588 | * Represents a model for carrying out client certificate authentication settings. |
||
589 | * |
||
590 | * @return ClientCertificateAuthenticationApiModel |
||
591 | */ |
||
592 | public function getClientCertificateAuthenticationSetting(): ?ClientCertificateAuthenticationApiModel |
||
593 | { |
||
594 | return $this->clientCertificateAuthenticationSetting; |
||
595 | } |
||
596 | |||
597 | /** |
||
598 | * Represents a model for carrying out client certificate authentication settings. |
||
599 | * |
||
600 | * @param ClientCertificateAuthenticationApiModel $clientCertificateAuthenticationSetting |
||
601 | * |
||
602 | * @return self |
||
603 | */ |
||
604 | public function setClientCertificateAuthenticationSetting(?ClientCertificateAuthenticationApiModel $clientCertificateAuthenticationSetting): self |
||
605 | { |
||
606 | $this->clientCertificateAuthenticationSetting = $clientCertificateAuthenticationSetting; |
||
607 | |||
608 | return $this; |
||
609 | } |
||
610 | |||
611 | /** |
||
612 | * Gets or sets the cookies. Separate multiple cookies with semicolon. Cookie values must be URL encoded. You can use the. |
||
613 | following format: Cookiename=Value |
||
614 | * |
||
615 | * @return string |
||
616 | */ |
||
617 | public function getCookies(): ?string |
||
618 | { |
||
619 | return $this->cookies; |
||
620 | } |
||
621 | |||
622 | /** |
||
623 | * Gets or sets the cookies. Separate multiple cookies with semicolon. Cookie values must be URL encoded. You can use the. |
||
624 | following format: Cookiename=Value |
||
625 | * |
||
626 | * @param string $cookies |
||
627 | * |
||
628 | * @return self |
||
629 | */ |
||
630 | public function setCookies(?string $cookies): self |
||
631 | { |
||
632 | $this->cookies = $cookies; |
||
633 | |||
634 | return $this; |
||
635 | } |
||
636 | |||
637 | /** |
||
638 | * Gets or sets a value indicating whether parallel attacker is enabled. |
||
639 | Default: true |
||
640 | * |
||
641 | * @return bool |
||
642 | */ |
||
643 | public function getCrawlAndAttack(): ?bool |
||
644 | { |
||
645 | return $this->crawlAndAttack; |
||
646 | } |
||
647 | |||
648 | /** |
||
649 | * Gets or sets a value indicating whether parallel attacker is enabled. |
||
650 | Default: true |
||
651 | * |
||
652 | * @param bool $crawlAndAttack |
||
653 | * |
||
654 | * @return self |
||
655 | */ |
||
656 | public function setCrawlAndAttack(?bool $crawlAndAttack): self |
||
657 | { |
||
658 | $this->crawlAndAttack = $crawlAndAttack; |
||
659 | |||
660 | return $this; |
||
661 | } |
||
662 | |||
663 | /** |
||
664 | * Gets or sets a value indicating whether Heuristic URL Rewrite support is enabled together with custom URL Rewrite. |
||
665 | support. |
||
666 | * |
||
667 | * @return bool |
||
668 | */ |
||
669 | public function getEnableHeuristicChecksInCustomUrlRewrite(): ?bool |
||
670 | { |
||
671 | return $this->enableHeuristicChecksInCustomUrlRewrite; |
||
672 | } |
||
673 | |||
674 | /** |
||
675 | * Gets or sets a value indicating whether Heuristic URL Rewrite support is enabled together with custom URL Rewrite. |
||
676 | support. |
||
677 | * |
||
678 | * @param bool $enableHeuristicChecksInCustomUrlRewrite |
||
679 | * |
||
680 | * @return self |
||
681 | */ |
||
682 | public function setEnableHeuristicChecksInCustomUrlRewrite(?bool $enableHeuristicChecksInCustomUrlRewrite): self |
||
683 | { |
||
684 | $this->enableHeuristicChecksInCustomUrlRewrite = $enableHeuristicChecksInCustomUrlRewrite; |
||
685 | |||
686 | return $this; |
||
687 | } |
||
688 | |||
689 | /** |
||
690 | * Gets or sets the excluded links. |
||
691 | Default: "(log|sign)\\-?(out|off)", "exit", "endsession", "gtm\\.js" |
||
692 | * |
||
693 | * @return ExcludedLinkModel[] |
||
694 | */ |
||
695 | public function getExcludedLinks(): ?array |
||
696 | { |
||
697 | return $this->excludedLinks; |
||
698 | } |
||
699 | |||
700 | /** |
||
701 | * Gets or sets the excluded links. |
||
702 | Default: "(log|sign)\\-?(out|off)", "exit", "endsession", "gtm\\.js" |
||
703 | * |
||
704 | * @param ExcludedLinkModel[] $excludedLinks |
||
705 | * |
||
706 | * @return self |
||
707 | */ |
||
708 | public function setExcludedLinks(?array $excludedLinks): self |
||
709 | { |
||
710 | $this->excludedLinks = $excludedLinks; |
||
711 | |||
712 | return $this; |
||
713 | } |
||
714 | |||
715 | /** |
||
716 | * Gets or sets the disallowed http methods. |
||
717 | * |
||
718 | * @return string[] |
||
719 | */ |
||
720 | public function getDisallowedHttpMethods(): ?array |
||
721 | { |
||
722 | return $this->disallowedHttpMethods; |
||
723 | } |
||
724 | |||
725 | /** |
||
726 | * Gets or sets the disallowed http methods. |
||
727 | * |
||
728 | * @param string[] $disallowedHttpMethods |
||
729 | * |
||
730 | * @return self |
||
731 | */ |
||
732 | public function setDisallowedHttpMethods(?array $disallowedHttpMethods): self |
||
733 | { |
||
734 | $this->disallowedHttpMethods = $disallowedHttpMethods; |
||
735 | |||
736 | return $this; |
||
737 | } |
||
738 | |||
739 | /** |
||
740 | * Gets or sets a value indicating whether links should be excluded/included. |
||
741 | Default: <see ref="bool.True" /> |
||
742 | * |
||
743 | * @return bool |
||
744 | */ |
||
745 | public function getExcludeLinks(): ?bool |
||
746 | { |
||
747 | return $this->excludeLinks; |
||
748 | } |
||
749 | |||
750 | /** |
||
751 | * Gets or sets a value indicating whether links should be excluded/included. |
||
752 | Default: <see ref="bool.True" /> |
||
753 | * |
||
754 | * @param bool $excludeLinks |
||
755 | * |
||
756 | * @return self |
||
757 | */ |
||
758 | public function setExcludeLinks(?bool $excludeLinks): self |
||
759 | { |
||
760 | $this->excludeLinks = $excludeLinks; |
||
761 | |||
762 | return $this; |
||
763 | } |
||
764 | |||
765 | /** |
||
766 | * Gets or sets a value indicating whether automatic crawling is enabled. |
||
767 | * |
||
768 | * @return bool |
||
769 | */ |
||
770 | public function getFindAndFollowNewLinks(): ?bool |
||
771 | { |
||
772 | return $this->findAndFollowNewLinks; |
||
773 | } |
||
774 | |||
775 | /** |
||
776 | * Gets or sets a value indicating whether automatic crawling is enabled. |
||
777 | * |
||
778 | * @param bool $findAndFollowNewLinks |
||
779 | * |
||
780 | * @return self |
||
781 | */ |
||
782 | public function setFindAndFollowNewLinks(?bool $findAndFollowNewLinks): self |
||
783 | { |
||
784 | $this->findAndFollowNewLinks = $findAndFollowNewLinks; |
||
785 | |||
786 | return $this; |
||
787 | } |
||
788 | |||
789 | /** |
||
790 | * Represents a model for carrying out form authentication settings. |
||
791 | * |
||
792 | * @return FormAuthenticationSettingModel |
||
793 | */ |
||
794 | public function getFormAuthenticationSettingModel(): ?FormAuthenticationSettingModel |
||
795 | { |
||
796 | return $this->formAuthenticationSettingModel; |
||
797 | } |
||
798 | |||
799 | /** |
||
800 | * Represents a model for carrying out form authentication settings. |
||
801 | * |
||
802 | * @param FormAuthenticationSettingModel $formAuthenticationSettingModel |
||
803 | * |
||
804 | * @return self |
||
805 | */ |
||
806 | public function setFormAuthenticationSettingModel(?FormAuthenticationSettingModel $formAuthenticationSettingModel): self |
||
807 | { |
||
808 | $this->formAuthenticationSettingModel = $formAuthenticationSettingModel; |
||
809 | |||
810 | return $this; |
||
811 | } |
||
812 | |||
813 | /** |
||
814 | * Represents a model for carrying out header authentication setttings. |
||
815 | * |
||
816 | * @return HeaderAuthenticationModel |
||
817 | */ |
||
818 | public function getHeaderAuthentication(): ?HeaderAuthenticationModel |
||
819 | { |
||
820 | return $this->headerAuthentication; |
||
821 | } |
||
822 | |||
823 | /** |
||
824 | * Represents a model for carrying out header authentication setttings. |
||
825 | * |
||
826 | * @param HeaderAuthenticationModel $headerAuthentication |
||
827 | * |
||
828 | * @return self |
||
829 | */ |
||
830 | public function setHeaderAuthentication(?HeaderAuthenticationModel $headerAuthentication): self |
||
831 | { |
||
832 | $this->headerAuthentication = $headerAuthentication; |
||
833 | |||
834 | return $this; |
||
835 | } |
||
836 | |||
837 | /** |
||
838 | * Gets or sets the imported links. |
||
839 | * |
||
840 | * @return string[] |
||
841 | */ |
||
842 | public function getImportedLinks(): ?array |
||
843 | { |
||
844 | return $this->importedLinks; |
||
845 | } |
||
846 | |||
847 | /** |
||
848 | * Gets or sets the imported links. |
||
849 | * |
||
850 | * @param string[] $importedLinks |
||
851 | * |
||
852 | * @return self |
||
853 | */ |
||
854 | public function setImportedLinks(?array $importedLinks): self |
||
855 | { |
||
856 | $this->importedLinks = $importedLinks; |
||
857 | |||
858 | return $this; |
||
859 | } |
||
860 | |||
861 | /** |
||
862 | * Gets or sets the imported files. |
||
863 | * |
||
864 | * @return ApiFileModel[] |
||
865 | */ |
||
866 | public function getImportedFiles(): ?array |
||
869 | } |
||
870 | |||
871 | /** |
||
872 | * Gets or sets the imported files. |
||
873 | * |
||
874 | * @param ApiFileModel[] $importedFiles |
||
875 | * |
||
876 | * @return self |
||
877 | */ |
||
878 | public function setImportedFiles(?array $importedFiles): self |
||
879 | { |
||
880 | $this->importedFiles = $importedFiles; |
||
881 | |||
882 | return $this; |
||
883 | } |
||
884 | |||
885 | /** |
||
886 | * Gets or sets a value indicating whether max scan duration is enabled. |
||
887 | This is only used for scheduled group scan and regular group scan. |
||
888 | * |
||
889 | * @return bool |
||
890 | */ |
||
891 | public function getIsMaxScanDurationEnabled(): ?bool |
||
892 | { |
||
893 | return $this->isMaxScanDurationEnabled; |
||
894 | } |
||
895 | |||
896 | /** |
||
897 | * Gets or sets a value indicating whether max scan duration is enabled. |
||
898 | This is only used for scheduled group scan and regular group scan. |
||
899 | * |
||
900 | * @param bool $isMaxScanDurationEnabled |
||
901 | * |
||
902 | * @return self |
||
903 | */ |
||
904 | public function setIsMaxScanDurationEnabled(?bool $isMaxScanDurationEnabled): self |
||
905 | { |
||
906 | $this->isMaxScanDurationEnabled = $isMaxScanDurationEnabled; |
||
907 | |||
908 | return $this; |
||
909 | } |
||
910 | |||
911 | /** |
||
912 | * Gets or sets the root path maximum dynamic signatures for heuristic URL Rewrite detection. |
||
913 | Default: 60 |
||
914 | * |
||
915 | * @return int |
||
916 | */ |
||
917 | public function getMaxDynamicSignatures(): ?int |
||
918 | { |
||
919 | return $this->maxDynamicSignatures; |
||
920 | } |
||
921 | |||
922 | /** |
||
923 | * Gets or sets the root path maximum dynamic signatures for heuristic URL Rewrite detection. |
||
924 | Default: 60 |
||
925 | * |
||
926 | * @param int $maxDynamicSignatures |
||
927 | * |
||
928 | * @return self |
||
929 | */ |
||
930 | public function setMaxDynamicSignatures(?int $maxDynamicSignatures): self |
||
935 | } |
||
936 | |||
937 | /** |
||
938 | * Gets or sets the maximum duration of the scan in hours. |
||
939 | Default: 48 hours |
||
940 | * |
||
941 | * @return int |
||
942 | */ |
||
943 | public function getMaxScanDuration(): ?int |
||
944 | { |
||
945 | return $this->maxScanDuration; |
||
946 | } |
||
947 | |||
948 | /** |
||
949 | * Gets or sets the maximum duration of the scan in hours. |
||
950 | Default: 48 hours |
||
951 | * |
||
952 | * @param int $maxScanDuration |
||
953 | * |
||
954 | * @return self |
||
955 | */ |
||
956 | public function setMaxScanDuration(?int $maxScanDuration): self |
||
957 | { |
||
958 | $this->maxScanDuration = $maxScanDuration; |
||
959 | |||
960 | return $this; |
||
961 | } |
||
962 | |||
963 | /** |
||
964 | * Gets or sets the scan scope. |
||
965 | Default: {Netsparker.Cloud.Core.Models.ScanTaskScope.EnteredPathAndBelow} |
||
966 | * |
||
967 | * @return string |
||
968 | */ |
||
969 | public function getScope(): ?string |
||
970 | { |
||
971 | return $this->scope; |
||
972 | } |
||
973 | |||
974 | /** |
||
975 | * Gets or sets the scan scope. |
||
976 | Default: {Netsparker.Cloud.Core.Models.ScanTaskScope.EnteredPathAndBelow} |
||
977 | * |
||
978 | * @param string $scope |
||
979 | * |
||
980 | * @return self |
||
981 | */ |
||
982 | public function setScope(?string $scope): self |
||
983 | { |
||
984 | $this->scope = $scope; |
||
985 | |||
986 | return $this; |
||
987 | } |
||
988 | |||
989 | /** |
||
990 | * Gets or sets the sub path maximum dynamic signatures for heuristic URL Rewrite detection. |
||
991 | Default: 30 |
||
992 | * |
||
993 | * @return int |
||
994 | */ |
||
995 | public function getSubPathMaxDynamicSignatures(): ?int |
||
996 | { |
||
997 | return $this->subPathMaxDynamicSignatures; |
||
998 | } |
||
999 | |||
1000 | /** |
||
1001 | * Gets or sets the sub path maximum dynamic signatures for heuristic URL Rewrite detection. |
||
1002 | Default: 30 |
||
1003 | * |
||
1004 | * @param int $subPathMaxDynamicSignatures |
||
1005 | * |
||
1006 | * @return self |
||
1007 | */ |
||
1008 | public function setSubPathMaxDynamicSignatures(?int $subPathMaxDynamicSignatures): self |
||
1009 | { |
||
1010 | $this->subPathMaxDynamicSignatures = $subPathMaxDynamicSignatures; |
||
1011 | |||
1012 | return $this; |
||
1013 | } |
||
1014 | |||
1015 | /** |
||
1016 | * Represents a model for carrying out scan time window settings. |
||
1017 | * |
||
1018 | * @return ScanTimeWindowModel |
||
1019 | */ |
||
1020 | public function getTimeWindow(): ?ScanTimeWindowModel |
||
1021 | { |
||
1022 | return $this->timeWindow; |
||
1023 | } |
||
1024 | |||
1025 | /** |
||
1026 | * Represents a model for carrying out scan time window settings. |
||
1027 | * |
||
1028 | * @param ScanTimeWindowModel $timeWindow |
||
1029 | * |
||
1030 | * @return self |
||
1031 | */ |
||
1032 | public function setTimeWindow(?ScanTimeWindowModel $timeWindow): self |
||
1033 | { |
||
1034 | $this->timeWindow = $timeWindow; |
||
1035 | |||
1036 | return $this; |
||
1037 | } |
||
1038 | |||
1039 | /** |
||
1040 | * Gets or sets the extensions that will be analyzed for heuristic URL Rewrite detection. |
||
1041 | Default: htm,html |
||
1042 | * |
||
1043 | * @return string |
||
1044 | */ |
||
1045 | public function getUrlRewriteAnalyzableExtensions(): ?string |
||
1048 | } |
||
1049 | |||
1050 | /** |
||
1051 | * Gets or sets the extensions that will be analyzed for heuristic URL Rewrite detection. |
||
1052 | Default: htm,html |
||
1053 | * |
||
1054 | * @param string $urlRewriteAnalyzableExtensions |
||
1055 | * |
||
1056 | * @return self |
||
1057 | */ |
||
1058 | public function setUrlRewriteAnalyzableExtensions(?string $urlRewriteAnalyzableExtensions): self |
||
1063 | } |
||
1064 | |||
1065 | /** |
||
1066 | * Gets or sets the block separators for heuristic URL Rewrite detection. |
||
1067 | Default: /_ $.,;|: |
||
1068 | * |
||
1069 | * @return string |
||
1070 | */ |
||
1071 | public function getUrlRewriteBlockSeparators(): ?string |
||
1072 | { |
||
1074 | } |
||
1075 | |||
1076 | /** |
||
1077 | * Gets or sets the block separators for heuristic URL Rewrite detection. |
||
1078 | Default: /_ $.,;|: |
||
1079 | * |
||
1080 | * @param string $urlRewriteBlockSeparators |
||
1081 | * |
||
1082 | * @return self |
||
1083 | */ |
||
1084 | public function setUrlRewriteBlockSeparators(?string $urlRewriteBlockSeparators): self |
||
1089 | } |
||
1090 | |||
1091 | /** |
||
1092 | * Gets or sets the URL Rewrite mode. |
||
1093 | Default: Heuristic |
||
1094 | * |
||
1095 | * @return string |
||
1096 | */ |
||
1097 | public function getUrlRewriteMode(): ?string |
||
1098 | { |
||
1099 | return $this->urlRewriteMode; |
||
1100 | } |
||
1101 | |||
1102 | /** |
||
1103 | * Gets or sets the URL Rewrite mode. |
||
1104 | Default: Heuristic |
||
1105 | * |
||
1106 | * @param string $urlRewriteMode |
||
1107 | * |
||
1108 | * @return self |
||
1109 | */ |
||
1110 | public function setUrlRewriteMode(?string $urlRewriteMode): self |
||
1111 | { |
||
1112 | $this->urlRewriteMode = $urlRewriteMode; |
||
1113 | |||
1114 | return $this; |
||
1115 | } |
||
1116 | |||
1117 | /** |
||
1118 | * Gets or sets the URL Rewrite rules. |
||
1119 | * |
||
1120 | * @return UrlRewriteRuleModel[] |
||
1121 | */ |
||
1122 | public function getUrlRewriteRules(): ?array |
||
1123 | { |
||
1124 | return $this->urlRewriteRules; |
||
1125 | } |
||
1126 | |||
1127 | /** |
||
1128 | * Gets or sets the URL Rewrite rules. |
||
1129 | * |
||
1130 | * @param UrlRewriteRuleModel[] $urlRewriteRules |
||
1131 | * |
||
1132 | * @return self |
||
1133 | */ |
||
1134 | public function setUrlRewriteRules(?array $urlRewriteRules): self |
||
1139 | } |
||
1140 | } |
||
1141 |