com.helger.as2lib.util.dump

Class HTTPOutgoingDumperStreamBased

java.lang.Object

com.helger.as2lib.util.dump.HTTPOutgoingDumperStreamBased

All Implemented Interfaces:

IHTTPOutgoingDumper, AutoCloseable

Direct Known Subclasses:

HTTPOutgoingDumperFileBased

public class HTTPOutgoingDumperStreamBased
extends Object
implements IHTTPOutgoingDumper

Abstract outgoing HTTP dumper using an OutputStream for operations.

Since:

3.1.0

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
HTTPOutgoingDumperStreamBased(OutputStream aOS)

Method Summary

Modifier and Type	Method and Description
void	close() Close the dumper.
void	dumpHeader(String sName, String sValue) Get notified on a single outgoing HTTP headers.
void	dumpPayload(byte[] aBytes, int nOfs, int nLen) Dump a single payload byte.
void	dumpPayload(int nByte) Dump a single payload byte.
void	finishedHeaders() Called after all headers were emitted.
void	finishedPayload() Called after the payload was emitted.
protected OutputStream	getWrappedOS()
boolean	isDumpComment()
boolean	isDumpHeader()
boolean	isDumpPayload()
HTTPOutgoingDumperStreamBased	setDumpComment(boolean bDumpComment)
HTTPOutgoingDumperStreamBased	setDumpHeader(boolean bDumpHeader)
HTTPOutgoingDumperStreamBased	setDumpPayload(boolean bDumpPayload)
void	start(String sURL, AS2Message aMsg) Called when a new outgoing connection is initiated.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.helger.as2lib.util.dump.IHTTPOutgoingDumper

getDumpOS

Constructor Detail

HTTPOutgoingDumperStreamBased

public HTTPOutgoingDumperStreamBased(@Nonnull @WillCloseWhenClosed
                                     OutputStream aOS)

Parameters:

aOS - The output stream to dump to. May not be null.

Method Detail

getWrappedOS

@Nonnull
protected final OutputStream getWrappedOS()

isDumpComment

public final boolean isDumpComment()

setDumpComment

@Nonnull
public final HTTPOutgoingDumperStreamBased setDumpComment(boolean bDumpComment)

isDumpHeader

public final boolean isDumpHeader()

setDumpHeader

@Nonnull
public final HTTPOutgoingDumperStreamBased setDumpHeader(boolean bDumpHeader)

isDumpPayload

public final boolean isDumpPayload()

setDumpPayload

@Nonnull
public final HTTPOutgoingDumperStreamBased setDumpPayload(boolean bDumpPayload)

start

public void start(@Nonnull
                  String sURL,
                  @Nonnull
                  AS2Message aMsg)

Description copied from interface: IHTTPOutgoingDumper

Called when a new outgoing connection is initiated.

Specified by:

start in interface IHTTPOutgoingDumper

Parameters:

sURL - The URL to which a connection is established.

aMsg - The message to be dumped. Never null.

dumpHeader

public void dumpHeader(@Nonnull
                       String sName,
                       @Nonnull
                       String sValue)

Description copied from interface: IHTTPOutgoingDumper

Get notified on a single outgoing HTTP headers. For HTTP headers usually the ISO-8859-1 charset is used.

Specified by:

dumpHeader in interface IHTTPOutgoingDumper

Parameters:

sName - HTTP header name. Never null.

sValue - HTTP header value. Never null.

finishedHeaders

public void finishedHeaders()

Description copied from interface: IHTTPOutgoingDumper

Called after all headers were emitted.

Specified by:

finishedHeaders in interface IHTTPOutgoingDumper

dumpPayload

public void dumpPayload(int nByte)

Description copied from interface: IHTTPOutgoingDumper

Dump a single payload byte. May not throw an IOException!

Specified by:

dumpPayload in interface IHTTPOutgoingDumper

Parameters:

nByte - Current byte

dumpPayload

public void dumpPayload(@Nonnull
                        byte[] aBytes,
                        @Nonnegative
                        int nOfs,
                        @Nonnegative
                        int nLen)

Description copied from interface: IHTTPOutgoingDumper

Dump a single payload byte. May not throw an IOException!

Specified by:

dumpPayload in interface IHTTPOutgoingDumper

Parameters:

aBytes - bytes

nOfs - Offset into the array

nLen - Number of bytes to write

finishedPayload

public void finishedPayload()

Description copied from interface: IHTTPOutgoingDumper

Called after the payload was emitted.

Specified by:

finishedPayload in interface IHTTPOutgoingDumper

close

public void close()

Description copied from interface: IHTTPOutgoingDumper

Close the dumper.

Specified by:

close in interface IHTTPOutgoingDumper

Specified by:

close in interface AutoCloseable

toString

public String toString()

Overrides:

toString in class Object