python3-10.pyscalpel.java.burp
This module exposes Java objects from Burp's extensions API
If you are a normal user, you should probably never have to manipulate these objects yourself.
1""" 2 This module exposes Java objects from Burp's extensions API 3 4 If you are a normal user, you should probably never have to manipulate these objects yourself. 5""" 6from .byte_array import IByteArray, ByteArray 7from .http_header import IHttpHeader, HttpHeader 8from .http_message import IHttpMessage 9from .http_request import IHttpRequest, HttpRequest 10from .http_response import IHttpResponse, HttpResponse 11from .http_parameter import IHttpParameter, HttpParameter 12from .http_service import IHttpService, HttpService 13from .http_request_response import IHttpRequestResponse 14from .http import IHttp 15from .logging import Logging 16 17__all__ = [ 18 "IHttp", 19 "IHttpRequest", 20 "HttpRequest", 21 "IHttpResponse", 22 "HttpResponse", 23 "IHttpRequestResponse", 24 "IHttpHeader", 25 "HttpHeader", 26 "IHttpMessage", 27 "IHttpParameter", 28 "HttpParameter", 29 "IHttpService", 30 "HttpService", 31 "IByteArray", 32 "ByteArray", 33 "Logging", 34]
12class IHttp(JavaObject, Protocol, metaclass=ABCMeta): # pragma: no cover 13 """generated source for interface Http""" 14 15 __metaclass__ = ABCMeta 16 17 @abstractmethod 18 def sendRequest(self, request: IHttpRequest) -> IHttpRequestResponse: 19 ...
generated source for interface Http
Inherited Members
- pyscalpel.java.object.JavaObject
- getClass
- hashCode
- equals
- clone
- notify
- notifyAll
- wait
- finalize
20class IHttpRequest(IHttpMessage, Protocol): # pragma: no cover 21 """generated source for interface HttpRequest""" 22 23 # * HTTP service for the request. 24 # * 25 # * @return An {@link HttpService} object containing details of the HTTP service. 26 # 27 28 @abstractmethod 29 def httpService(self) -> IHttpService: 30 """generated source for method httpService""" 31 32 # 33 # * URL for the request. 34 # * If the request is malformed, then a {@link MalformedRequestException} is thrown. 35 # * 36 # * @return The URL in the request. 37 # * @throws MalformedRequestException if request is malformed. 38 # 39 40 @abstractmethod 41 def url(self) -> str: 42 """generated source for method url""" 43 44 # 45 # * HTTP method for the request. 46 # * If the request is malformed, then a {@link MalformedRequestException} is thrown. 47 # * 48 # * @return The HTTP method used in the request. 49 # * @throws MalformedRequestException if request is malformed. 50 # 51 52 @abstractmethod 53 def method(self) -> str: 54 """generated source for method method""" 55 56 # 57 # * Path and File for the request. 58 # * If the request is malformed, then a {@link MalformedRequestException} is thrown. 59 # * 60 # * @return the path and file in the request 61 # * @throws MalformedRequestException if request is malformed. 62 # 63 64 @abstractmethod 65 def path(self) -> str: 66 """generated source for method path""" 67 68 # 69 # * HTTP Version text parsed from the request line for HTTP 1 messages. 70 # * HTTP 2 messages will return "HTTP/2" 71 # * 72 # * @return Version string 73 # 74 75 @abstractmethod 76 def httpVersion(self) -> str | None: 77 """generated source for method httpVersion""" 78 79 # 80 # * {@inheritDoc} 81 # 82 83 @abstractmethod 84 def headers(self) -> list[IHttpHeader]: 85 """generated source for method headers""" 86 87 # 88 # * @return The detected content type of the request. 89 # 90 91 @abstractmethod 92 def contentType(self) -> JavaObject: 93 """generated source for method contentType""" 94 95 # 96 # * @return The parameters contained in the request. 97 # 98 99 @abstractmethod 100 def parameters(self) -> list[IHttpParameter]: 101 """generated source for method parameters""" 102 103 # 104 # * {@inheritDoc} 105 # 106 107 @abstractmethod 108 def body(self) -> IByteArray: 109 """generated source for method body""" 110 111 # 112 # * {@inheritDoc} 113 # 114 115 @abstractmethod 116 def bodyToString(self) -> str: 117 """generated source for method bodyToString""" 118 119 # 120 # * {@inheritDoc} 121 # 122 123 @abstractmethod 124 def bodyOffset(self) -> int: 125 """generated source for method bodyOffset""" 126 127 # 128 # * {@inheritDoc} 129 # 130 131 @abstractmethod 132 def markers(self): 133 """generated source for method markers""" 134 135 # 136 # * {@inheritDoc} 137 # 138 139 @abstractmethod 140 def toByteArray(self) -> IByteArray: 141 """generated source for method toByteArray""" 142 143 # 144 # * {@inheritDoc} 145 # 146 147 @abstractmethod 148 def __str__(self) -> str: 149 """generated source for method toString""" 150 151 # 152 # * Create a copy of the {@code HttpRequest} in temporary file.<br> 153 # * This method is used to save the {@code HttpRequest} object to a temporary file, 154 # * so that it is no longer held in memory. Extensions can use this method to convert 155 # * {@code HttpRequest} objects into a form suitable for long-term usage. 156 # * 157 # * @return A new {@code ByteArray} instance stored in temporary file. 158 # 159 160 @abstractmethod 161 def copyToTempFile(self) -> IHttpRequest: 162 """generated source for method copyToTempFile""" 163 164 # 165 # * Create a copy of the {@code HttpRequest} with the new service. 166 # * 167 # * @param service An {@link HttpService} reference to add. 168 # * 169 # * @return A new {@code HttpRequest} instance. 170 # 171 172 @abstractmethod 173 def withService(self, service: IHttpService) -> IHttpRequest: 174 """generated source for method withService""" 175 176 # 177 # * Create a copy of the {@code HttpRequest} with the new path. 178 # * 179 # * @param path The path to use. 180 # * 181 # * @return A new {@code HttpRequest} instance with updated path. 182 # 183 184 @abstractmethod 185 def withPath(self, path: str) -> IHttpRequest: 186 """generated source for method withPath""" 187 188 # 189 # * Create a copy of the {@code HttpRequest} with the new method. 190 # * 191 # * @param method the method to use 192 # * 193 # * @return a new {@code HttpRequest} instance with updated method. 194 # 195 196 @abstractmethod 197 def withMethod(self, method: str) -> IHttpRequest: 198 """generated source for method withMethod""" 199 200 # 201 # * Create a copy of the {@code HttpRequest} with the added HTTP parameters. 202 # * 203 # * @param parameters HTTP parameters to add. 204 # * 205 # * @return A new {@code HttpRequest} instance. 206 # 207 208 @abstractmethod 209 def withAddedParameters(self, parameters: Iterable[IHttpParameter]) -> IHttpRequest: 210 """generated source for method withAddedParameters""" 211 212 # 213 # * Create a copy of the {@code HttpRequest} with the added HTTP parameters. 214 # * 215 # * @param parameters HTTP parameters to add. 216 # * 217 # * @return A new {@code HttpRequest} instance. 218 # 219 220 @abstractmethod 221 def withAddedParameters_0(self, *parameters: IHttpParameter) -> IHttpRequest: 222 """generated source for method withAddedParameters_0""" 223 224 # 225 # * Create a copy of the {@code HttpRequest} with the removed HTTP parameters. 226 # * 227 # * @param parameters HTTP parameters to remove. 228 # * 229 # * @return A new {@code HttpRequest} instance. 230 # 231 232 @abstractmethod 233 def withRemovedParameters( 234 self, parameters: Iterable[IHttpParameter] 235 ) -> IHttpRequest: 236 """generated source for method withRemovedParameters""" 237 238 # 239 # * Create a copy of the {@code HttpRequest} with the removed HTTP parameters. 240 # * 241 # * @param parameters HTTP parameters to remove. 242 # * 243 # * @return A new {@code HttpRequest} instance. 244 # 245 246 @abstractmethod 247 def withRemovedParameters_0(self, *parameters: IHttpParameter) -> IHttpRequest: 248 """generated source for method withRemovedParameters_0""" 249 250 # 251 # * Create a copy of the {@code HttpRequest} with the updated HTTP parameters.<br> 252 # * If a parameter does not exist in the request, a new one will be added. 253 # * 254 # * @param parameters HTTP parameters to update. 255 # * 256 # * @return A new {@code HttpRequest} instance. 257 # 258 259 @abstractmethod 260 def withUpdatedParameters(self, parameters: list[IHttpParameter]) -> IHttpRequest: 261 """generated source for method withUpdatedParameters""" 262 263 # 264 # * Create a copy of the {@code HttpRequest} with the updated HTTP parameters.<br> 265 # * If a parameter does not exist in the request, a new one will be added. 266 # * 267 # * @param parameters HTTP parameters to update. 268 # * 269 # * @return A new {@code HttpRequest} instance. 270 # 271 272 @abstractmethod 273 def withUpdatedParameters_0(self, *parameters: IHttpParameter) -> IHttpRequest: 274 """generated source for method withUpdatedParameters_0""" 275 276 # 277 # * Create a copy of the {@code HttpRequest} with the transformation applied. 278 # * 279 # * @param transformation Transformation to apply. 280 # * 281 # * @return A new {@code HttpRequest} instance. 282 # 283 284 @abstractmethod 285 def withTransformationApplied(self, transformation) -> IHttpRequest: 286 """generated source for method withTransformationApplied""" 287 288 # 289 # * Create a copy of the {@code HttpRequest} with the updated body.<br> 290 # * Updates Content-Length header. 291 # * 292 # * @param body the new body for the request 293 # * 294 # * @return A new {@code HttpRequest} instance. 295 # 296 297 @abstractmethod 298 def withBody(self, body) -> IHttpRequest: 299 """generated source for method withBody""" 300 301 # 302 # * Create a copy of the {@code HttpRequest} with the updated body.<br> 303 # * Updates Content-Length header. 304 # * 305 # * @param body the new body for the request 306 # * 307 # * @return A new {@code HttpRequest} instance. 308 # 309 310 @abstractmethod 311 def withBody_0(self, body: IByteArray) -> IHttpRequest: 312 """generated source for method withBody_0""" 313 314 # 315 # * Create a copy of the {@code HttpRequest} with the added header. 316 # * 317 # * @param name The name of the header. 318 # * @param value The value of the header. 319 # * 320 # * @return The updated HTTP request with the added header. 321 # 322 323 @abstractmethod 324 def withAddedHeader(self, name: str, value: str) -> IHttpRequest: 325 """generated source for method withAddedHeader""" 326 327 # 328 # * Create a copy of the {@code HttpRequest} with the added header. 329 # * 330 # * @param header The {@link HttpHeader} to add to the HTTP request. 331 # * 332 # * @return The updated HTTP request with the added header. 333 # 334 335 @abstractmethod 336 def withAddedHeader_0(self, header: IHttpHeader) -> IHttpRequest: 337 """generated source for method withAddedHeader_0""" 338 339 # 340 # * Create a copy of the {@code HttpRequest} with the updated header. 341 # * 342 # * @param name The name of the header to update the value of. 343 # * @param value The new value of the specified HTTP header. 344 # * 345 # * @return The updated request containing the updated header. 346 # 347 348 @abstractmethod 349 def withUpdatedHeader(self, name: str, value: str) -> IHttpRequest: 350 """generated source for method withUpdatedHeader""" 351 352 # 353 # * Create a copy of the {@code HttpRequest} with the updated header. 354 # * 355 # * @param header The {@link HttpHeader} to update containing the new value. 356 # * 357 # * @return The updated request containing the updated header. 358 # 359 360 @abstractmethod 361 def withUpdatedHeader_0(self, header: IHttpHeader) -> IHttpRequest: 362 """generated source for method withUpdatedHeader_0""" 363 364 # 365 # * Removes an existing HTTP header from the current request. 366 # * 367 # * @param name The name of the HTTP header to remove from the request. 368 # * 369 # * @return The updated request containing the removed header. 370 # 371 372 @abstractmethod 373 def withRemovedHeader(self, name: str) -> IHttpRequest: 374 """generated source for method withRemovedHeader""" 375 376 # 377 # * Removes an existing HTTP header from the current request. 378 # * 379 # * @param header The {@link HttpHeader} to remove from the request. 380 # * 381 # * @return The updated request containing the removed header. 382 # 383 384 @abstractmethod 385 def withRemovedHeader_0(self, header: IHttpHeader) -> IHttpRequest: 386 """generated source for method withRemovedHeader_0""" 387 388 # 389 # * Create a copy of the {@code HttpRequest} with the added markers. 390 # * 391 # * @param markers Request markers to add. 392 # * 393 # * @return A new {@code MarkedHttpRequestResponse} instance. 394 # 395 396 @abstractmethod 397 def withMarkers(self, markers) -> IHttpRequest: 398 """generated source for method withMarkers""" 399 400 # 401 # * Create a copy of the {@code HttpRequest} with the added markers. 402 # * 403 # * @param markers Request markers to add. 404 # * 405 # * @return A new {@code MarkedHttpRequestResponse} instance. 406 # 407 408 @abstractmethod 409 def withMarkers_0(self, *markers) -> IHttpRequest: 410 """generated source for method withMarkers_0""" 411 412 # 413 # * Create a copy of the {@code HttpRequest} with added default headers. 414 # * 415 # * @return a new (@code HttpRequest) with added default headers 416 # 417 418 @abstractmethod 419 def withDefaultHeaders(self) -> IHttpRequest: 420 """generated source for method withDefaultHeaders""" 421 422 # 423 # * Create a new empty instance of {@link HttpRequest}.<br> 424 # * 425 # * @². 426 # 427 428 @abstractmethod 429 @overload 430 def httpRequest(self, request: IByteArray | str) -> IHttpRequest: 431 """generated source for method httpRequest""" 432 433 @abstractmethod 434 @overload 435 def httpRequest(self, service: IHttpService, req: IByteArray | str) -> IHttpRequest: 436 """generated source for method httpRequest""" 437 438 # 439 # * Create a new instance of {@link HttpRequest}.<br> 440 # * 441 # * 442 # * @². 443 # 444 # 445 446 @abstractmethod 447 def httpRequestFromUrl(self, url: str) -> IHttpRequest: 448 """generated source for method httpRequestFromUrl""" 449 450 # 451 # * Create a new instance of {@link HttpRequest} containing HTTP 2 headers and body.<br> 452 # * 453 # * @param service An HTTP service for the request. 454 # * @param headers A list of HTTP 2 headers. 455 # * @param body A body of the HTTP 2 request. 456 # * 457 # * @². 458 # 459 460 @abstractmethod 461 def http2Request( 462 self, service: IHttpService, headers: Iterable[IHttpHeader], body: IByteArray 463 ) -> IHttpRequest: 464 """generated source for method http2Request""" 465 466 # 467 # * Create a new instance of {@link HttpRequest} containing HTTP 2 headers and body.<br> 468 # * 469 # * @param service An HTTP service for the request. 470 # * @param headers A list of HTTP 2 headers. 471 # * @param body A body of the HTTP 2 request. 472 # * 473 # * @². 474 #
generated source for interface HttpRequest
28 @abstractmethod 29 def httpService(self) -> IHttpService: 30 """generated source for method httpService"""
generated source for method httpService
75 @abstractmethod 76 def httpVersion(self) -> str | None: 77 """generated source for method httpVersion"""
generated source for method httpVersion
83 @abstractmethod 84 def headers(self) -> list[IHttpHeader]: 85 """generated source for method headers"""
generated source for method headers
91 @abstractmethod 92 def contentType(self) -> JavaObject: 93 """generated source for method contentType"""
generated source for method contentType
99 @abstractmethod 100 def parameters(self) -> list[IHttpParameter]: 101 """generated source for method parameters"""
generated source for method parameters
generated source for method body
115 @abstractmethod 116 def bodyToString(self) -> str: 117 """generated source for method bodyToString"""
generated source for method bodyToString
123 @abstractmethod 124 def bodyOffset(self) -> int: 125 """generated source for method bodyOffset"""
generated source for method bodyOffset
139 @abstractmethod 140 def toByteArray(self) -> IByteArray: 141 """generated source for method toByteArray"""
generated source for method toByteArray
160 @abstractmethod 161 def copyToTempFile(self) -> IHttpRequest: 162 """generated source for method copyToTempFile"""
generated source for method copyToTempFile
172 @abstractmethod 173 def withService(self, service: IHttpService) -> IHttpRequest: 174 """generated source for method withService"""
generated source for method withService
184 @abstractmethod 185 def withPath(self, path: str) -> IHttpRequest: 186 """generated source for method withPath"""
generated source for method withPath
196 @abstractmethod 197 def withMethod(self, method: str) -> IHttpRequest: 198 """generated source for method withMethod"""
generated source for method withMethod
208 @abstractmethod 209 def withAddedParameters(self, parameters: Iterable[IHttpParameter]) -> IHttpRequest: 210 """generated source for method withAddedParameters"""
generated source for method withAddedParameters
220 @abstractmethod 221 def withAddedParameters_0(self, *parameters: IHttpParameter) -> IHttpRequest: 222 """generated source for method withAddedParameters_0"""
generated source for method withAddedParameters_0
232 @abstractmethod 233 def withRemovedParameters( 234 self, parameters: Iterable[IHttpParameter] 235 ) -> IHttpRequest: 236 """generated source for method withRemovedParameters"""
generated source for method withRemovedParameters
246 @abstractmethod 247 def withRemovedParameters_0(self, *parameters: IHttpParameter) -> IHttpRequest: 248 """generated source for method withRemovedParameters_0"""
generated source for method withRemovedParameters_0
259 @abstractmethod 260 def withUpdatedParameters(self, parameters: list[IHttpParameter]) -> IHttpRequest: 261 """generated source for method withUpdatedParameters"""
generated source for method withUpdatedParameters
272 @abstractmethod 273 def withUpdatedParameters_0(self, *parameters: IHttpParameter) -> IHttpRequest: 274 """generated source for method withUpdatedParameters_0"""
generated source for method withUpdatedParameters_0
284 @abstractmethod 285 def withTransformationApplied(self, transformation) -> IHttpRequest: 286 """generated source for method withTransformationApplied"""
generated source for method withTransformationApplied
297 @abstractmethod 298 def withBody(self, body) -> IHttpRequest: 299 """generated source for method withBody"""
generated source for method withBody
310 @abstractmethod 311 def withBody_0(self, body: IByteArray) -> IHttpRequest: 312 """generated source for method withBody_0"""
generated source for method withBody_0
323 @abstractmethod 324 def withAddedHeader(self, name: str, value: str) -> IHttpRequest: 325 """generated source for method withAddedHeader"""
generated source for method withAddedHeader
335 @abstractmethod 336 def withAddedHeader_0(self, header: IHttpHeader) -> IHttpRequest: 337 """generated source for method withAddedHeader_0"""
generated source for method withAddedHeader_0
348 @abstractmethod 349 def withUpdatedHeader(self, name: str, value: str) -> IHttpRequest: 350 """generated source for method withUpdatedHeader"""
generated source for method withUpdatedHeader
360 @abstractmethod 361 def withUpdatedHeader_0(self, header: IHttpHeader) -> IHttpRequest: 362 """generated source for method withUpdatedHeader_0"""
generated source for method withUpdatedHeader_0
372 @abstractmethod 373 def withRemovedHeader(self, name: str) -> IHttpRequest: 374 """generated source for method withRemovedHeader"""
generated source for method withRemovedHeader
384 @abstractmethod 385 def withRemovedHeader_0(self, header: IHttpHeader) -> IHttpRequest: 386 """generated source for method withRemovedHeader_0"""
generated source for method withRemovedHeader_0
396 @abstractmethod 397 def withMarkers(self, markers) -> IHttpRequest: 398 """generated source for method withMarkers"""
generated source for method withMarkers
408 @abstractmethod 409 def withMarkers_0(self, *markers) -> IHttpRequest: 410 """generated source for method withMarkers_0"""
generated source for method withMarkers_0
418 @abstractmethod 419 def withDefaultHeaders(self) -> IHttpRequest: 420 """generated source for method withDefaultHeaders"""
generated source for method withDefaultHeaders
2010def _overload_dummy(*args, **kwds): 2011 """Helper for @overload to raise when called.""" 2012 raise NotImplementedError( 2013 "You should not call an overloaded function. " 2014 "A series of @overload-decorated functions " 2015 "outside a stub module should always be followed " 2016 "by an implementation that is not @overload-ed.")
Helper for @overload to raise when called.
446 @abstractmethod 447 def httpRequestFromUrl(self, url: str) -> IHttpRequest: 448 """generated source for method httpRequestFromUrl"""
generated source for method httpRequestFromUrl
460 @abstractmethod 461 def http2Request( 462 self, service: IHttpService, headers: Iterable[IHttpHeader], body: IByteArray 463 ) -> IHttpRequest: 464 """generated source for method http2Request"""
generated source for method http2Request
Inherited Members
- pyscalpel.java.object.JavaObject
- getClass
- hashCode
- equals
- clone
- notify
- notifyAll
- wait
- finalize
18class IHttpResponse(IHttpMessage, Protocol): # pragma: no cover 19 """generated source for interface HttpResponse""" 20 21 # 22 # * Obtain the HTTP status code contained in the response. 23 # * 24 # * @return HTTP status code. 25 # 26 @abstractmethod 27 def statusCode(self) -> int: 28 """generated source for method statusCode""" 29 30 # 31 # * Obtain the HTTP reason phrase contained in the response for HTTP 1 messages. 32 # * HTTP 2 messages will return a mapped phrase based on the status code. 33 # * 34 # * @return HTTP Reason phrase. 35 # 36 @abstractmethod 37 def reasonPhrase(self) -> str | None: 38 """generated source for method reasonPhrase""" 39 40 # 41 # * Return the HTTP Version text parsed from the response line for HTTP 1 messages. 42 # * HTTP 2 messages will return "HTTP/2" 43 # * 44 # * @return Version string 45 # 46 @abstractmethod 47 def httpVersion(self) -> str | None: 48 """generated source for method httpVersion""" 49 50 # 51 # * {@inheritDoc} 52 # 53 @abstractmethod 54 def headers(self) -> list[IHttpHeader]: 55 """generated source for method headers""" 56 57 # 58 # * {@inheritDoc} 59 # 60 @abstractmethod 61 def body(self) -> IByteArray | None: 62 """generated source for method body""" 63 64 # 65 # * {@inheritDoc} 66 # 67 @abstractmethod 68 def bodyToString(self) -> str: 69 """generated source for method bodyToString""" 70 71 # 72 # * {@inheritDoc} 73 # 74 @abstractmethod 75 def bodyOffset(self) -> int: 76 """generated source for method bodyOffset""" 77 78 # 79 # * {@inheritDoc} 80 # 81 @abstractmethod 82 def markers(self) -> JavaObject: 83 """generated source for method markers""" 84 85 # 86 # * Obtain details of the HTTP cookies set in the response. 87 # * 88 # * @return A list of {@link Cookie} objects representing the cookies set in the response, if any. 89 # 90 @abstractmethod 91 def cookies(self) -> JavaObject: 92 """generated source for method cookies""" 93 94 # 95 # * Obtain the MIME type of the response, as stated in the HTTP headers. 96 # * 97 # * @return The stated MIME type. 98 # 99 @abstractmethod 100 def statedMimeType(self) -> JavaObject: 101 """generated source for method statedMimeType""" 102 103 # 104 # * Obtain the MIME type of the response, as inferred from the contents of the HTTP message body. 105 # * 106 # * @return The inferred MIME type. 107 # 108 @abstractmethod 109 def inferredMimeType(self) -> JavaObject: 110 """generated source for method inferredMimeType""" 111 112 # 113 # * Retrieve the number of types given keywords appear in the response. 114 # * 115 # * @param keywords Keywords to count. 116 # * 117 # * @return List of keyword counts in the order they were provided. 118 # 119 @abstractmethod 120 def keywordCounts(self, *keywords) -> int: 121 """generated source for method keywordCounts""" 122 123 # 124 # * Retrieve the values of response attributes. 125 # * 126 # * @param types Response attributes to retrieve values for. 127 # * 128 # * @return List of {@link Attribute} objects. 129 # 130 @abstractmethod 131 def attributes(self, *types) -> JavaObject: 132 """generated source for method attributes""" 133 134 # 135 # * {@inheritDoc} 136 # 137 @abstractmethod 138 def toByteArray(self) -> IByteArray: 139 """generated source for method toByteArray""" 140 141 # 142 # * {@inheritDoc} 143 # 144 @abstractmethod 145 def __str__(self) -> str: 146 """generated source for method toString""" 147 148 # 149 # * Create a copy of the {@code HttpResponse} in temporary file.<br> 150 # * This method is used to save the {@code HttpResponse} object to a temporary file, 151 # * so that it is no longer held in memory. Extensions can use this method to convert 152 # * {@code HttpResponse} objects into a form suitable for long-term usage. 153 # * 154 # * @return A new {@code HttpResponse} instance stored in temporary file. 155 # 156 @abstractmethod 157 def copyToTempFile(self) -> IHttpResponse: 158 """generated source for method copyToTempFile""" 159 160 # 161 # * Create a copy of the {@code HttpResponse} with the provided status code. 162 # * 163 # * @param statusCode the new status code for response 164 # * 165 # * @return A new {@code HttpResponse} instance. 166 # 167 @abstractmethod 168 def withStatusCode(self, statusCode: int) -> IHttpResponse: 169 """generated source for method withStatusCode""" 170 171 # 172 # * Create a copy of the {@code HttpResponse} with the new reason phrase. 173 # * 174 # * @param reasonPhrase the new reason phrase for response 175 # * 176 # * @return A new {@code HttpResponse} instance. 177 # 178 @abstractmethod 179 def withReasonPhrase(self, reasonPhrase: str) -> IHttpResponse: 180 """generated source for method withReasonPhrase""" 181 182 # 183 # * Create a copy of the {@code HttpResponse} with the new http version. 184 # * 185 # * @param httpVersion the new http version for response 186 # * 187 # * @return A new {@code HttpResponse} instance. 188 # 189 @abstractmethod 190 def withHttpVersion(self, httpVersion: str) -> IHttpResponse: 191 """generated source for method withHttpVersion""" 192 193 # 194 # * Create a copy of the {@code HttpResponse} with the updated body.<br> 195 # * Updates Content-Length header. 196 # * 197 # * @param body the new body for the response 198 # * 199 # * @return A new {@code HttpResponse} instance. 200 # 201 @abstractmethod 202 def withBody(self, body: IByteArray | str) -> IHttpResponse: 203 """generated source for method withBody""" 204 205 # 206 # * Create a copy of the {@code HttpResponse} with the added header. 207 # * 208 # * @param header The {@link HttpHeader} to add to the response. 209 # * 210 # * @return The updated response containing the added header. 211 # 212 # @abstractmethod 213 # def withAddedHeader(self, header) -> 'IHttpResponse': 214 # """ generated source for method withAddedHeader """ 215 216 # # 217 # # * Create a copy of the {@code HttpResponse} with the added header. 218 # # * 219 # # * @param name The name of the header. 220 # # * @param value The value of the header. 221 # # * 222 # # * @return The updated response containing the added header. 223 # # 224 @abstractmethod 225 def withAddedHeader(self, name: str, value: str) -> IHttpResponse: 226 """generated source for method withAddedHeader_0""" 227 228 # 229 # * Create a copy of the {@code HttpResponse} with the updated header. 230 # * 231 # * @param header The {@link HttpHeader} to update containing the new value. 232 # * 233 # * @return The updated response containing the updated header. 234 # 235 # @abstractmethod 236 # def withUpdatedHeader(self, header) -> 'IHttpResponse': 237 # """ generated source for method withUpdatedHeader """ 238 239 # # 240 # # * Create a copy of the {@code HttpResponse} with the updated header. 241 # # * 242 # # * @param name The name of the header to update the value of. 243 # # * @param value The new value of the specified HTTP header. 244 # # * 245 # # * @return The updated response containing the updated header. 246 # # 247 @abstractmethod 248 def withUpdatedHeader(self, name: str, value: str) -> IHttpResponse: 249 """generated source for method withUpdatedHeader_0""" 250 251 # 252 # * Create a copy of the {@code HttpResponse} with the removed header. 253 # * 254 # * @param header The {@link HttpHeader} to remove from the response. 255 # * 256 # * @return The updated response containing the removed header. 257 # 258 # @abstractmethod 259 # def withRemovedHeader(self, header) -> 'IHttpResponse': 260 # """ generated source for method withRemovedHeader """ 261 262 # # 263 # # * Create a copy of the {@code HttpResponse} with the removed header. 264 # # * 265 # # * @param name The name of the HTTP header to remove from the response. 266 # # * 267 # # * @return The updated response containing the removed header. 268 # # 269 @abstractmethod 270 def withRemovedHeader(self, name: str) -> IHttpResponse: 271 """generated source for method withRemovedHeader_0""" 272 273 # 274 # * Create a copy of the {@code HttpResponse} with the added markers. 275 # * 276 # * @param markers Request markers to add. 277 # * 278 # * @return A new {@code MarkedHttpRequestResponse} instance. 279 # 280 @abstractmethod 281 @overload 282 def withMarkers(self, markers: JavaObject) -> IHttpResponse: 283 """generated source for method withMarkers""" 284 285 # 286 # * Create a copy of the {@code HttpResponse} with the added markers. 287 # * 288 # * @param markers Request markers to add. 289 # * 290 # * @return A new {@code MarkedHttpRequestResponse} instance. 291 # 292 @abstractmethod 293 @overload 294 def withMarkers(self, *markers: JavaObject) -> IHttpResponse: 295 """generated source for method withMarkers_0""" 296 297 # 298 # * Create a new empty instance of {@link HttpResponse}.<br> 299 # * 300 # * @return A new {@link HttpResponse} instance. 301 # 302 @abstractmethod 303 def httpResponse(self, response: IByteArray | str) -> IHttpResponse: 304 """generated source for method httpResponse"""
generated source for interface HttpResponse
36 @abstractmethod 37 def reasonPhrase(self) -> str | None: 38 """generated source for method reasonPhrase"""
generated source for method reasonPhrase
46 @abstractmethod 47 def httpVersion(self) -> str | None: 48 """generated source for method httpVersion"""
generated source for method httpVersion
53 @abstractmethod 54 def headers(self) -> list[IHttpHeader]: 55 """generated source for method headers"""
generated source for method headers
60 @abstractmethod 61 def body(self) -> IByteArray | None: 62 """generated source for method body"""
generated source for method body
67 @abstractmethod 68 def bodyToString(self) -> str: 69 """generated source for method bodyToString"""
generated source for method bodyToString
generated source for method markers
99 @abstractmethod 100 def statedMimeType(self) -> JavaObject: 101 """generated source for method statedMimeType"""
generated source for method statedMimeType
108 @abstractmethod 109 def inferredMimeType(self) -> JavaObject: 110 """generated source for method inferredMimeType"""
generated source for method inferredMimeType
119 @abstractmethod 120 def keywordCounts(self, *keywords) -> int: 121 """generated source for method keywordCounts"""
generated source for method keywordCounts
130 @abstractmethod 131 def attributes(self, *types) -> JavaObject: 132 """generated source for method attributes"""
generated source for method attributes
137 @abstractmethod 138 def toByteArray(self) -> IByteArray: 139 """generated source for method toByteArray"""
generated source for method toByteArray
156 @abstractmethod 157 def copyToTempFile(self) -> IHttpResponse: 158 """generated source for method copyToTempFile"""
generated source for method copyToTempFile
167 @abstractmethod 168 def withStatusCode(self, statusCode: int) -> IHttpResponse: 169 """generated source for method withStatusCode"""
generated source for method withStatusCode
178 @abstractmethod 179 def withReasonPhrase(self, reasonPhrase: str) -> IHttpResponse: 180 """generated source for method withReasonPhrase"""
generated source for method withReasonPhrase
189 @abstractmethod 190 def withHttpVersion(self, httpVersion: str) -> IHttpResponse: 191 """generated source for method withHttpVersion"""
generated source for method withHttpVersion
201 @abstractmethod 202 def withBody(self, body: IByteArray | str) -> IHttpResponse: 203 """generated source for method withBody"""
generated source for method withBody
224 @abstractmethod 225 def withAddedHeader(self, name: str, value: str) -> IHttpResponse: 226 """generated source for method withAddedHeader_0"""
generated source for method withAddedHeader_0
247 @abstractmethod 248 def withUpdatedHeader(self, name: str, value: str) -> IHttpResponse: 249 """generated source for method withUpdatedHeader_0"""
generated source for method withUpdatedHeader_0
269 @abstractmethod 270 def withRemovedHeader(self, name: str) -> IHttpResponse: 271 """generated source for method withRemovedHeader_0"""
generated source for method withRemovedHeader_0
2010def _overload_dummy(*args, **kwds): 2011 """Helper for @overload to raise when called.""" 2012 raise NotImplementedError( 2013 "You should not call an overloaded function. " 2014 "A series of @overload-decorated functions " 2015 "outside a stub module should always be followed " 2016 "by an implementation that is not @overload-ed.")
Helper for @overload to raise when called.
302 @abstractmethod 303 def httpResponse(self, response: IByteArray | str) -> IHttpResponse: 304 """generated source for method httpResponse"""
generated source for method httpResponse
Inherited Members
- pyscalpel.java.object.JavaObject
- getClass
- hashCode
- equals
- clone
- notify
- notifyAll
- wait
- finalize
12class IHttpRequestResponse(JavaObject, Protocol, metaclass=ABCMeta): # pragma: no cover 13 """generated source for interface HttpRequestResponse""" 14 15 __metaclass__ = ABCMeta 16 17 @abstractmethod 18 def request(self) -> IHttpRequest | None: 19 ... 20 21 @abstractmethod 22 def response(self) -> IHttpResponse | None: 23 ...
generated source for interface HttpRequestResponse
Inherited Members
- pyscalpel.java.object.JavaObject
- getClass
- hashCode
- equals
- clone
- notify
- notifyAll
- wait
- finalize
16class IHttpHeader(JavaObject, Protocol, metaclass=ABCMeta): # pragma: no cover 17 """generated source for interface HttpHeader""" 18 19 __metaclass__ = ABCMeta 20 # 21 # * @return The name of the header. 22 # 23 24 @abstractmethod 25 def name(self) -> str: 26 """generated source for method name""" 27 28 # 29 # * @return The value of the header. 30 # 31 @abstractmethod 32 def value(self) -> str: 33 """generated source for method value""" 34 35 # 36 # * @return The {@code String} representation of the header. 37 # 38 @abstractmethod 39 def __str__(self): 40 """generated source for method toString""" 41 42 # 43 # * Create a new instance of {@code HttpHeader} from name and value. 44 # * 45 # * @param name The name of the header. 46 # * @param value The value of the header. 47 # * 48 # * @return A new {@code HttpHeader} instance. 49 # 50 @abstractmethod 51 @overload 52 def httpHeader(self, name: str, value: str) -> IHttpHeader: 53 """generated source for method httpHeader""" 54 55 # 56 # * Create a new instance of HttpHeader from a {@code String} header representation. 57 # * It will be parsed according to the HTTP/1.1 specification for headers. 58 # * 59 # * @param header The {@code String} header representation. 60 # * 61 # * @return A new {@code HttpHeader} instance. 62 # 63 @abstractmethod 64 @overload 65 def httpHeader(self, header: str) -> IHttpHeader: 66 """generated source for method httpHeader_0"""
generated source for interface HttpHeader
2010def _overload_dummy(*args, **kwds): 2011 """Helper for @overload to raise when called.""" 2012 raise NotImplementedError( 2013 "You should not call an overloaded function. " 2014 "A series of @overload-decorated functions " 2015 "outside a stub module should always be followed " 2016 "by an implementation that is not @overload-ed.")
Helper for @overload to raise when called.
Inherited Members
- pyscalpel.java.object.JavaObject
- getClass
- hashCode
- equals
- clone
- notify
- notifyAll
- wait
- finalize
15class IHttpMessage(JavaObject, Protocol): # pragma: no cover 16 """generated source for interface HttpMessage""" 17 18 # 19 # * HTTP headers contained in the message. 20 # * 21 # * @return A list of HTTP headers. 22 # 23 @abstractmethod 24 def headers(self) -> IHttpHeader: 25 """generated source for method headers""" 26 27 # 28 # * Offset within the message where the message body begins. 29 # * 30 # * @return The message body offset. 31 # 32 @abstractmethod 33 def bodyOffset(self) -> int: 34 """generated source for method bodyOffset""" 35 36 # 37 # * Body of a message as a byte array. 38 # * 39 # * @return The body of a message as a byte array. 40 # 41 @abstractmethod 42 def body(self) -> IByteArray: 43 """generated source for method body""" 44 45 # 46 # * Body of a message as a {@code String}. 47 # * 48 # * @return The body of a message as a {@code String}. 49 # 50 @abstractmethod 51 def bodyToString(self) -> str: 52 """generated source for method bodyToString""" 53 54 # 55 # * Markers for the message. 56 # * 57 # * @return A list of markers. 58 # 59 @abstractmethod 60 def markers(self) -> JavaObject: 61 """generated source for method markers""" 62 63 # 64 # * Message as a byte array. 65 # * 66 # * @return The message as a byte array. 67 # 68 @abstractmethod 69 def toByteArray(self) -> IByteArray: 70 """generated source for method toByteArray""" 71 72 # 73 # * Message as a {@code String}. 74 # * 75 # * @return The message as a {@code String}. 76 # 77 @abstractmethod 78 def __str__(self) -> str: 79 """generated source for method toString"""
generated source for interface HttpMessage
23 @abstractmethod 24 def headers(self) -> IHttpHeader: 25 """generated source for method headers"""
generated source for method headers
generated source for method body
50 @abstractmethod 51 def bodyToString(self) -> str: 52 """generated source for method bodyToString"""
generated source for method bodyToString
generated source for method markers
68 @abstractmethod 69 def toByteArray(self) -> IByteArray: 70 """generated source for method toByteArray"""
generated source for method toByteArray
Inherited Members
- pyscalpel.java.object.JavaObject
- getClass
- hashCode
- equals
- clone
- notify
- notifyAll
- wait
- finalize
15class IHttpParameter(JavaObject): # pragma: no cover 16 """generated source for interface HttpParameter""" 17 18 __metaclass__ = ABCMeta 19 # 20 # * @return The parameter type. 21 # 22 23 @abstractmethod 24 def type_(self) -> JavaObject: 25 """generated source for method type_""" 26 27 # 28 # * @return The parameter name. 29 # 30 @abstractmethod 31 def name(self) -> str: 32 """generated source for method name""" 33 34 # 35 # * @return The parameter value. 36 # 37 @abstractmethod 38 def value(self) -> str: 39 """generated source for method value""" 40 41 # 42 # * Create a new Instance of {@code HttpParameter} with {@link HttpParameterType#URL} type. 43 # * 44 # * @param name The parameter name. 45 # * @param value The parameter value. 46 # * 47 # * @return A new {@code HttpParameter} instance. 48 # 49 @abstractmethod 50 def urlParameter(self, name: str, value: str) -> IHttpParameter: 51 """generated source for method urlParameter""" 52 53 # 54 # * Create a new Instance of {@code HttpParameter} with {@link HttpParameterType#BODY} type. 55 # * 56 # * @param name The parameter name. 57 # * @param value The parameter value. 58 # * 59 # * @return A new {@code HttpParameter} instance. 60 # 61 @abstractmethod 62 def bodyParameter(self, name: str, value: str) -> IHttpParameter: 63 """generated source for method bodyParameter""" 64 65 # 66 # * Create a new Instance of {@code HttpParameter} with {@link HttpParameterType#COOKIE} type. 67 # * 68 # * @param name The parameter name. 69 # * @param value The parameter value. 70 # * 71 # * @return A new {@code HttpParameter} instance. 72 # 73 @abstractmethod 74 def cookieParameter(self, name: str, value: str) -> IHttpParameter: 75 """generated source for method cookieParameter""" 76 77 # 78 # * Create a new Instance of {@code HttpParameter} with the specified type. 79 # * 80 # * @param name The parameter name. 81 # * @param value The parameter value. 82 # * @param type The header type. 83 # * 84 # * @return A new {@code HttpParameter} instance. 85 # 86 @abstractmethod 87 def parameter(self, name: str, value: str, type_: JavaObject) -> IHttpParameter: 88 """generated source for method parameter"""
generated source for interface HttpParameter
generated source for method type_
49 @abstractmethod 50 def urlParameter(self, name: str, value: str) -> IHttpParameter: 51 """generated source for method urlParameter"""
generated source for method urlParameter
61 @abstractmethod 62 def bodyParameter(self, name: str, value: str) -> IHttpParameter: 63 """generated source for method bodyParameter"""
generated source for method bodyParameter
86 @abstractmethod 87 def parameter(self, name: str, value: str, type_: JavaObject) -> IHttpParameter: 88 """generated source for method parameter"""
generated source for method parameter
Inherited Members
- pyscalpel.java.object.JavaObject
- getClass
- hashCode
- equals
- clone
- notify
- notifyAll
- wait
- finalize
12class IHttpService(JavaObject, metaclass=ABCMeta): # pragma: no cover 13 @abstractmethod 14 def host(self) -> str: 15 """The hostname or IP address for the service.""" 16 17 @abstractmethod 18 @overload 19 def httpService(self, baseUrl: str) -> IHttpService: 20 """Create a new instance of {@code HttpService} from a base URL.""" 21 22 @abstractmethod 23 @overload 24 def httpService(self, baseUrl: str, secure: bool) -> IHttpService: 25 """Create a new instance of {@code HttpService} from a base URL and a protocol.""" 26 27 @abstractmethod 28 @overload 29 def httpService(self, host: str, port: int, secure: bool) -> IHttpService: 30 """Create a new instance of {@code HttpService} from a host, a port and a protocol.""" 31 32 @abstractmethod 33 def httpService(self, *args, **kwargs) -> IHttpService: 34 """Create a new instance of {@code HttpService} from a host, a port and a protocol.""" 35 36 @abstractmethod 37 def port(self) -> int: 38 """The port number for the service.""" 39 40 @abstractmethod 41 def secure(self) -> bool: 42 """True if a secure protocol is used for the connection, false otherwise.""" 43 44 @abstractmethod 45 def __str__(self) -> str: 46 """The {@code String} representation of the service."""
generated source for class Object
32 @abstractmethod 33 def httpService(self, *args, **kwargs) -> IHttpService: 34 """Create a new instance of {@code HttpService} from a host, a port and a protocol."""
Create a new instance of {@code HttpService} from a host, a port and a protocol.
40 @abstractmethod 41 def secure(self) -> bool: 42 """True if a secure protocol is used for the connection, false otherwise."""
True if a secure protocol is used for the connection, false otherwise.
Inherited Members
- pyscalpel.java.object.JavaObject
- getClass
- hashCode
- equals
- clone
- notify
- notifyAll
- wait
- finalize
13class IByteArray(JavaObject, Protocol): # pragma: no cover 14 __metaclass__ = ABCMeta 15 16 """ generated source for interface ByteArray """ 17 18 # 19 # * Access the byte stored at the provided index. 20 # * 21 # * @param index Index of the byte to be retrieved. 22 # * 23 # * @return The byte at the index. 24 # 25 @abstractmethod 26 def getByte(self, index: int) -> int: 27 """generated source for method getByte""" 28 29 # 30 # * Sets the byte at the provided index to the provided byte. 31 # * 32 # * @param index Index of the byte to be set. 33 # * @param value The byte to be set. 34 # 35 @abstractmethod 36 @overload 37 def setByte(self, index: int, value: int) -> None: 38 """generated source for method setByte""" 39 40 # 41 # * Sets the byte at the provided index to the provided narrowed integer value. 42 # * 43 # * @param index Index of the byte to be set. 44 # * @param value The integer value to be set after a narrowing primitive conversion to a byte. 45 # 46 @abstractmethod 47 @overload 48 def setByte(self, index: int, value: int) -> None: 49 """generated source for method setByte_0""" 50 51 # 52 # * Sets bytes starting at the specified index to the provided bytes. 53 # * 54 # * @param index The index of the first byte to set. 55 # * @param data The byte[] or sequence of bytes to be set. 56 # 57 @abstractmethod 58 @overload 59 def setBytes(self, index: int, *data: int) -> None: 60 """generated source for method setBytes""" 61 62 # 63 # * Sets bytes starting at the specified index to the provided integers after narrowing primitive conversion to bytes. 64 # * 65 # * @param index The index of the first byte to set. 66 # * @param data The int[] or the sequence of integers to be set after a narrowing primitive conversion to bytes. 67 # 68 69 @abstractmethod 70 @overload 71 def setBytes(self, index: int, byteArray: IByteArray) -> None: 72 """generated source for method setBytes_1""" 73 74 # 75 # * Number of bytes stored in the {@code ByteArray}. 76 # * 77 # * @return Length of the {@code ByteArray}. 78 # 79 @abstractmethod 80 def length(self) -> int: 81 """generated source for method length""" 82 83 # 84 # * Copy of all bytes 85 # * 86 # * @return Copy of all bytes. 87 # 88 @abstractmethod 89 def getBytes(self) -> JavaBytes: 90 """generated source for method getBytes""" 91 92 # 93 # * New ByteArray with all bytes between the start index (inclusive) and the end index (exclusive). 94 # * 95 # * @param startIndexInclusive The inclusive start index of retrieved range. 96 # * @param endIndexExclusive The exclusive end index of retrieved range. 97 # * 98 # * @return ByteArray containing all bytes in the specified range. 99 # 100 @abstractmethod 101 @overload 102 def subArray( 103 self, startIndexInclusive: int, endIndexExclusive: int 104 ) -> "IByteArray": 105 """generated source for method subArray""" 106 107 # 108 # * New ByteArray with all bytes in the specified range. 109 # * 110 # * @param range The {@link Range} of bytes to be returned. 111 # * 112 # * @return ByteArray containing all bytes in the specified range. 113 # 114 @abstractmethod 115 @overload 116 def subArray(self, _range) -> IByteArray: 117 """generated source for method subArray_0""" 118 119 # 120 # * Create a copy of the {@code ByteArray} 121 # * 122 # * @return New {@code ByteArray} with a copy of the wrapped bytes. 123 # 124 @abstractmethod 125 def copy(self) -> IByteArray: 126 """generated source for method copy""" 127 128 # 129 # * Create a copy of the {@code ByteArray} in temporary file.<br> 130 # * This method is used to save the {@code ByteArray} object to a temporary file, 131 # * so that it is no longer held in memory. Extensions can use this method to convert 132 # * {@code ByteArray} objects into a form suitable for long-term usage. 133 # * 134 # * @return A new {@code ByteArray} instance stored in temporary file. 135 # 136 @abstractmethod 137 def copyToTempFile(self) -> IByteArray: 138 """generated source for method copyToTempFile""" 139 140 # 141 # * Searches the data in the ByteArray for the first occurrence of a specified term. 142 # * It works on byte-based data in a way that is similar to the way the native Java method {@link String#indexOf(String)} works on String-based data. 143 # * 144 # * @param searchTerm The value to be searched for. 145 # * 146 # * @return The offset of the first occurrence of the pattern within the specified bounds, or -1 if no match is found. 147 # 148 @abstractmethod 149 @overload 150 def indexOf(self, searchTerm: IByteArray) -> int: 151 """generated source for method indexOf""" 152 153 # 154 # * Searches the data in the ByteArray for the first occurrence of a specified term. 155 # * It works on byte-based data in a way that is similar to the way the native Java method {@link String#indexOf(String)} works on String-based data. 156 # * 157 # * @param searchTerm The value to be searched for. 158 # * 159 # * @return The offset of the first occurrence of the pattern within the specified bounds, or -1 if no match is found. 160 # 161 @abstractmethod 162 @overload 163 def indexOf(self, searchTerm: str) -> int: 164 """generated source for method indexOf_0""" 165 166 # 167 # * Searches the data in the ByteArray for the first occurrence of a specified term. 168 # * It works on byte-based data in a way that is similar to the way the native Java method {@link String#indexOf(String)} works on String-based data. 169 # * 170 # * @param searchTerm The value to be searched for. 171 # * @param caseSensitive Flags whether the search is case-sensitive. 172 # * 173 # * @return The offset of the first occurrence of the pattern within the specified bounds, or -1 if no match is found. 174 # 175 @abstractmethod 176 @overload 177 def indexOf(self, searchTerm: IByteArray, caseSensitive: bool) -> int: 178 """generated source for method indexOf_1""" 179 180 # 181 # * Searches the data in the ByteArray for the first occurrence of a specified term. 182 # * It works on byte-based data in a way that is similar to the way the native Java method {@link String#indexOf(String)} works on String-based data. 183 # * 184 # * @param searchTerm The value to be searched for. 185 # * @param caseSensitive Flags whether the search is case-sensitive. 186 # * 187 # * @return The offset of the first occurrence of the pattern within the specified bounds, or -1 if no match is found. 188 # 189 @abstractmethod 190 @overload 191 def indexOf(self, searchTerm: str, caseSensitive: bool) -> int: 192 """generated source for method indexOf_2""" 193 194 # 195 # * Searches the data in the ByteArray for the first occurrence of a specified term. 196 # * It works on byte-based data in a way that is similar to the way the native Java method {@link String#indexOf(String)} works on String-based data. 197 # * 198 # * @param searchTerm The value to be searched for. 199 # * @param caseSensitive Flags whether the search is case-sensitive. 200 # * @param startIndexInclusive The inclusive start index for the search. 201 # * @param endIndexExclusive The exclusive end index for the search. 202 # * 203 # * @return The offset of the first occurrence of the pattern within the specified bounds, or -1 if no match is found. 204 # 205 @abstractmethod 206 @overload 207 def indexOf( 208 self, 209 searchTerm: IByteArray, 210 caseSensitive: bool, 211 startIndexInclusive: int, 212 endIndexExclusive: int, 213 ) -> int: 214 """generated source for method indexOf_3""" 215 216 # 217 # * Searches the data in the ByteArray for the first occurrence of a specified term. 218 # * It works on byte-based data in a way that is similar to the way the native Java method {@link String#indexOf(String)} works on String-based data. 219 # * 220 # * @param searchTerm The value to be searched for. 221 # * @param caseSensitive Flags whether the search is case-sensitive. 222 # * @param startIndexInclusive The inclusive start index for the search. 223 # * @param endIndexExclusive The exclusive end index for the search. 224 # * 225 # * @return The offset of the first occurrence of the pattern within the specified bounds, or -1 if no match is found. 226 # 227 @abstractmethod 228 @overload 229 def indexOf( 230 self, 231 searchTerm: str, 232 caseSensitive: bool, 233 startIndexInclusive: int, 234 endIndexExclusive: int, 235 ) -> int: 236 """generated source for method indexOf_4""" 237 238 # 239 # * Searches the data in the ByteArray and counts all matches for a specified term. 240 # * 241 # * @param searchTerm The value to be searched for. 242 # * 243 # * @return The count of all matches of the pattern 244 # 245 @abstractmethod 246 @overload 247 def countMatches(self, searchTerm: IByteArray) -> int: 248 """generated source for method countMatches""" 249 250 # 251 # * Searches the data in the ByteArray and counts all matches for a specified term. 252 # * 253 # * @param searchTerm The value to be searched for. 254 # * 255 # * @return The count of all matches of the pattern 256 # 257 @abstractmethod 258 @overload 259 def countMatches(self, searchTerm: str) -> int: 260 """generated source for method countMatches_0""" 261 262 # 263 # * Searches the data in the ByteArray and counts all matches for a specified term. 264 # * 265 # * @param searchTerm The value to be searched for. 266 # * @param caseSensitive Flags whether the search is case-sensitive. 267 # * 268 # * @return The count of all matches of the pattern 269 # 270 @abstractmethod 271 @overload 272 def countMatches(self, searchTerm: IByteArray, caseSensitive: bool) -> int: 273 """generated source for method countMatches_1""" 274 275 # 276 # * Searches the data in the ByteArray and counts all matches for a specified term. 277 # * 278 # * @param searchTerm The value to be searched for. 279 # * @param caseSensitive Flags whether the search is case-sensitive. 280 # * 281 # * @return The count of all matches of the pattern 282 # 283 @abstractmethod 284 @overload 285 def countMatches(self, searchTerm: str, caseSensitive: bool) -> int: 286 """generated source for method countMatches_2""" 287 288 # 289 # * Searches the data in the ByteArray and counts all matches for a specified term. 290 # * 291 # * @param searchTerm The value to be searched for. 292 # * @param caseSensitive Flags whether the search is case-sensitive. 293 # * @param startIndexInclusive The inclusive start index for the search. 294 # * @param endIndexExclusive The exclusive end index for the search. 295 # * 296 # * @return The count of all matches of the pattern within the specified bounds 297 # 298 @abstractmethod 299 @overload 300 def countMatches( 301 self, 302 searchTerm: IByteArray, 303 caseSensitive: bool, 304 startIndexInclusive: int, 305 endIndexExclusive: int, 306 ) -> int: 307 """generated source for method countMatches_3""" 308 309 # 310 # * Searches the data in the ByteArray and counts all matches for a specified term. 311 # * 312 # * @param searchTerm The value to be searched for. 313 # * @param caseSensitive Flags whether the search is case-sensitive. 314 # * @param startIndexInclusive The inclusive start index for the search. 315 # * @param endIndexExclusive The exclusive end index for the search. 316 # * 317 # * @return The count of all matches of the pattern within the specified bounds 318 # 319 @abstractmethod 320 @overload 321 def countMatches( 322 self, 323 searchTerm: str, 324 caseSensitive: bool, 325 startIndexInclusive: int, 326 endIndexExclusive: int, 327 ) -> int: 328 """generated source for method countMatches_4""" 329 330 # 331 # * Convert the bytes of the ByteArray into String form using the encoding specified by Burp Suite. 332 # * 333 # * @return The converted data in String form. 334 # 335 @abstractmethod 336 def __str__(self) -> str: 337 """generated source for method toString""" 338 339 # 340 # * Create a copy of the {@code ByteArray} appended with the provided bytes. 341 # * 342 # * @param data The byte[] or sequence of bytes to append. 343 # 344 @abstractmethod 345 def withAppended(self, *data: int) -> IByteArray: 346 """generated source for method withAppended""" 347 348 # 349 # * Create a copy of the {@code ByteArray} appended with the provided integers after narrowing primitive conversion to bytes. 350 # * 351 # * @param data The int[] or sequence of integers to append after narrowing primitive conversion to bytes. 352 # 353 354 # 355 @abstractmethod 356 def byteArrayOfLength(self, length: int) -> IByteArray: 357 """generated source for method byteArrayOfLength""" 358 359 # 360 # * Create a new {@code ByteArray} with the provided byte data.<br> 361 # * 362 # * @param data byte[] to wrap, or sequence of bytes to wrap. 363 # * 364 # * @return New {@code ByteArray} wrapping the provided byte array. 365 # 366 # @abstractmethod 367 @abstractmethod 368 def byteArray(self, data: bytes | JavaBytes | list[int] | str) -> IByteArray: 369 """generated source for method byteArray""" 370 371 # 372 # * Create a new {@code ByteArray} with the provided integers after a narrowing primitive conversion to bytes.<br> 373 # * 374 # * @param data bytes. 375 # * 376 # * @return New {@code ByteArray} wrapping the provided data after a narrowing primitive conversion to bytes. 377 #
generated source for class Object
25 @abstractmethod 26 def getByte(self, index: int) -> int: 27 """generated source for method getByte"""
generated source for method getByte
2010def _overload_dummy(*args, **kwds): 2011 """Helper for @overload to raise when called.""" 2012 raise NotImplementedError( 2013 "You should not call an overloaded function. " 2014 "A series of @overload-decorated functions " 2015 "outside a stub module should always be followed " 2016 "by an implementation that is not @overload-ed.")
Helper for @overload to raise when called.
2010def _overload_dummy(*args, **kwds): 2011 """Helper for @overload to raise when called.""" 2012 raise NotImplementedError( 2013 "You should not call an overloaded function. " 2014 "A series of @overload-decorated functions " 2015 "outside a stub module should always be followed " 2016 "by an implementation that is not @overload-ed.")
Helper for @overload to raise when called.
88 @abstractmethod 89 def getBytes(self) -> JavaBytes: 90 """generated source for method getBytes"""
generated source for method getBytes
2010def _overload_dummy(*args, **kwds): 2011 """Helper for @overload to raise when called.""" 2012 raise NotImplementedError( 2013 "You should not call an overloaded function. " 2014 "A series of @overload-decorated functions " 2015 "outside a stub module should always be followed " 2016 "by an implementation that is not @overload-ed.")
Helper for @overload to raise when called.
generated source for method copy
136 @abstractmethod 137 def copyToTempFile(self) -> IByteArray: 138 """generated source for method copyToTempFile"""
generated source for method copyToTempFile
2010def _overload_dummy(*args, **kwds): 2011 """Helper for @overload to raise when called.""" 2012 raise NotImplementedError( 2013 "You should not call an overloaded function. " 2014 "A series of @overload-decorated functions " 2015 "outside a stub module should always be followed " 2016 "by an implementation that is not @overload-ed.")
Helper for @overload to raise when called.
2010def _overload_dummy(*args, **kwds): 2011 """Helper for @overload to raise when called.""" 2012 raise NotImplementedError( 2013 "You should not call an overloaded function. " 2014 "A series of @overload-decorated functions " 2015 "outside a stub module should always be followed " 2016 "by an implementation that is not @overload-ed.")
Helper for @overload to raise when called.
344 @abstractmethod 345 def withAppended(self, *data: int) -> IByteArray: 346 """generated source for method withAppended"""
generated source for method withAppended
355 @abstractmethod 356 def byteArrayOfLength(self, length: int) -> IByteArray: 357 """generated source for method byteArrayOfLength"""
generated source for method byteArrayOfLength
367 @abstractmethod 368 def byteArray(self, data: bytes | JavaBytes | list[int] | str) -> IByteArray: 369 """generated source for method byteArray"""
generated source for method byteArray
Inherited Members
- pyscalpel.java.object.JavaObject
- getClass
- hashCode
- equals
- clone
- notify
- notifyAll
- wait
- finalize
12class Logging(JavaObject): # pragma: no cover 13 """generated source for interface Logging""" 14 15 # 16 # * Obtain the current extension's standard output 17 # * stream. Extensions should write all output to this stream, allowing the 18 # * Burp user to configure how that output is handled from within the UI. 19 # * 20 # * @return The extension's standard output stream. 21 # 22 @abstractmethod 23 def output(self) -> JavaObject: 24 """generated source for method output""" 25 26 # 27 # * Obtain the current extension's standard error 28 # * stream. Extensions should write all error messages to this stream, 29 # * allowing the Burp user to configure how that output is handled from 30 # * within the UI. 31 # * 32 # * @return The extension's standard error stream. 33 # 34 @abstractmethod 35 def error(self) -> JavaObject: 36 """generated source for method error""" 37 38 # 39 # * This method prints a line of output to the current extension's standard 40 # * output stream. 41 # * 42 # * @param message The message to print. 43 # 44 @abstractmethod 45 def logToOutput(self, message: str) -> None: 46 """generated source for method logToOutput""" 47 48 # 49 # * This method prints a line of output to the current extension's standard 50 # * error stream. 51 # * 52 # * @param message The message to print. 53 # 54 @abstractmethod 55 def error(self, message: str) -> None: 56 """generated source for method error""" 57 58 # 59 # * This method can be used to display a debug event in the Burp Suite 60 # * event log. 61 # * 62 # * @param message The debug message to display. 63 # 64 @abstractmethod 65 def raiseDebugEvent(self, message: str) -> None: 66 """generated source for method raiseDebugEvent""" 67 68 # 69 # * This method can be used to display an informational event in the Burp 70 # * Suite event log. 71 # * 72 # * @param message The informational message to display. 73 # 74 @abstractmethod 75 def raiseInfoEvent(self, message: str) -> None: 76 """generated source for method raiseInfoEvent""" 77 78 # 79 # * This method can be used to display an error event in the Burp Suite 80 # * event log. 81 # * 82 # * @param message The error message to display. 83 # 84 @abstractmethod 85 def raiseErrorEvent(self, message: str) -> None: 86 """generated source for method raiseErrorEvent""" 87 88 # 89 # * This method can be used to display a critical event in the Burp Suite 90 # * event log. 91 # * 92 # * @param message The critical message to display. 93 # 94 @abstractmethod 95 def raiseCriticalEvent(self, message: str) -> None: 96 """generated source for method raiseCriticalEvent"""
generated source for interface Logging
generated source for method output
54 @abstractmethod 55 def error(self, message: str) -> None: 56 """generated source for method error"""
generated source for method error
44 @abstractmethod 45 def logToOutput(self, message: str) -> None: 46 """generated source for method logToOutput"""
generated source for method logToOutput
64 @abstractmethod 65 def raiseDebugEvent(self, message: str) -> None: 66 """generated source for method raiseDebugEvent"""
generated source for method raiseDebugEvent
74 @abstractmethod 75 def raiseInfoEvent(self, message: str) -> None: 76 """generated source for method raiseInfoEvent"""
generated source for method raiseInfoEvent
84 @abstractmethod 85 def raiseErrorEvent(self, message: str) -> None: 86 """generated source for method raiseErrorEvent"""
generated source for method raiseErrorEvent
94 @abstractmethod 95 def raiseCriticalEvent(self, message: str) -> None: 96 """generated source for method raiseCriticalEvent"""
generated source for method raiseCriticalEvent
Inherited Members
- pyscalpel.java.object.JavaObject
- getClass
- hashCode
- equals
- clone
- notify
- notifyAll
- wait
- finalize