pyscalpel.java.burp

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        ...

 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    #

 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"""

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        ...

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"""

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"""