Module com.github.alexdlaird.ngrok

Package com.github.alexdlaird.exception

Class NgrokException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.github.alexdlaird.exception.JavaNgrokException

com.github.alexdlaird.exception.NgrokException

All Implemented Interfaces:

java.io.Serializable

public class NgrokException
extends JavaNgrokException

Thrown from NgrokProcess when an error occurs interacting directly with the ngrok binary.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
NgrokException(java.lang.String message)	An exception with a message.
NgrokException(java.lang.String message, java.lang.Throwable cause)	An exception with a message and a root cause.
NgrokException(java.lang.String message, java.util.List<NgrokLog> ngrokLogs)	An exception with a message and ngrok logs.
NgrokException(java.lang.String message, java.util.List<NgrokLog> ngrokLogs, java.lang.String ngrokError)	An exception with a message, ngrok logs, and the error that caused ngrok to fail.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getNgrokError()	Get The error that caused the ngrok process to fail.
java.util.List<NgrokLog>	getNgrokLogs()	Get the ngrok logs, which may be useful for debugging.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

NgrokException

public NgrokException(java.lang.String message)

An exception with a message.

Parameters:

message - The message describing the exception.

NgrokException

public NgrokException(java.lang.String message,
                      java.lang.Throwable cause)

An exception with a message and a root cause.

Parameters:

message - The message describing the exception.

cause - The initial cause of the exception.

NgrokException

public NgrokException(java.lang.String message,
                      java.util.List<NgrokLog> ngrokLogs)

An exception with a message and ngrok logs.

Parameters:

message - The message describing the exception.

ngrokLogs - The ngrok logs.

NgrokException

public NgrokException(java.lang.String message,
                      java.util.List<NgrokLog> ngrokLogs,
                      java.lang.String ngrokError)

An exception with a message, ngrok logs, and the error that caused ngrok to fail.

Parameters:

message - The message describing the exception.

ngrokLogs - The ngrok logs.

ngrokError - The error that caused the ngrok process to fail.

Method Detail

getNgrokLogs

public java.util.List<NgrokLog> getNgrokLogs()

Get the ngrok logs, which may be useful for debugging.

getNgrokError

public java.lang.String getNgrokError()

Get The error that caused the ngrok process to fail.