Package com.mongodb.event

Class CommandFailedEvent

java.lang.Object

com.mongodb.event.CommandEvent

com.mongodb.event.CommandFailedEvent

public final class CommandFailedEvent
extends CommandEvent

An event representing the failure of a MongoDB database command.

Since:

3.1

Constructor Summary

Constructors

Constructor	Description
CommandFailedEvent(int requestId, ConnectionDescription connectionDescription, String commandName, long elapsedTimeNanos, Throwable throwable)	Deprecated.
CommandFailedEvent(RequestContext requestContext, int requestId, ConnectionDescription connectionDescription, String commandName, long elapsedTimeNanos, Throwable throwable)	Deprecated. Prefer CommandFailedEvent(RequestContext, long, int, ConnectionDescription, String, String, long, Throwable)
CommandFailedEvent(RequestContext requestContext, long operationId, int requestId, ConnectionDescription connectionDescription, String commandName, long elapsedTimeNanos, Throwable throwable)	Deprecated.
CommandFailedEvent(RequestContext requestContext, long operationId, int requestId, ConnectionDescription connectionDescription, String databaseName, String commandName, long elapsedTimeNanos, Throwable throwable)	Construct an instance.

Method Summary

Modifier and Type	Method	Description
long	getElapsedTime(TimeUnit timeUnit)	Gets the elapsed time in the given unit of time.
Throwable	getThrowable()	Gets the throwable cause of the failure

Methods inherited from class com.mongodb.event.CommandEvent

getCommandName, getConnectionDescription, getDatabaseName, getOperationId, getRequestContext, getRequestId

Methods inherited from class java.lang.Object

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

Constructor Details

CommandFailedEvent

public CommandFailedEvent(@Nullable
 RequestContext requestContext,
 long operationId,
 int requestId,
 ConnectionDescription connectionDescription,
 String databaseName,
 String commandName,
 long elapsedTimeNanos,
 Throwable throwable)

Construct an instance.

Parameters:

requestContext - the request context

operationId - the operation id

requestId - the request id

connectionDescription - the connection description

databaseName - the database name

commandName - the command name

elapsedTimeNanos - the non-negative elapsed time in nanoseconds for the operation to complete

throwable - the throwable cause of the failure

Since:

4.11

CommandFailedEvent

@Deprecated
public CommandFailedEvent(@Nullable
 RequestContext requestContext,
 long operationId,
 int requestId,
 ConnectionDescription connectionDescription,
 String commandName,
 long elapsedTimeNanos,
 Throwable throwable)

Deprecated.

Construct an instance.

Parameters:

requestContext - the request context

operationId - the operation id

requestId - the request id

connectionDescription - the connection description

commandName - the command name

elapsedTimeNanos - the non-negative elapsed time in nanoseconds for the operation to complete

throwable - the throwable cause of the failure

Since:

4.10 CommandFailedEvent(RequestContext, long, int, ConnectionDescription, String, String, long, Throwable)

CommandFailedEvent

@Deprecated
public CommandFailedEvent(@Nullable
 RequestContext requestContext,
 int requestId,
 ConnectionDescription connectionDescription,
 String commandName,
 long elapsedTimeNanos,
 Throwable throwable)

Deprecated.

Prefer CommandFailedEvent(RequestContext, long, int, ConnectionDescription, String, String, long, Throwable)

Construct an instance.

Parameters:

requestContext - the request context

requestId - the requestId

connectionDescription - the connection description

commandName - the command name

elapsedTimeNanos - the non-negative elapsed time in nanoseconds for the operation to complete

throwable - the throwable cause of the failure

Since:

4.4

CommandFailedEvent

@Deprecated
public CommandFailedEvent(int requestId,
 ConnectionDescription connectionDescription,
 String commandName,
 long elapsedTimeNanos,
 Throwable throwable)

Deprecated.

Construct an instance.

Parameters:

requestId - the requestId

connectionDescription - the connection description

commandName - the command name

elapsedTimeNanos - the non-negative elapsed time in nanoseconds for the operation to complete

throwable - the throwable cause of the failure CommandFailedEvent(RequestContext, long, int, ConnectionDescription, String, long, Throwable)

Method Details

getElapsedTime

public long getElapsedTime(TimeUnit timeUnit)

Gets the elapsed time in the given unit of time.

Parameters:

timeUnit - the time unit in which to get the elapsed time

Returns:

the elapsed time

getThrowable

public Throwable getThrowable()

Gets the throwable cause of the failure

Returns:

the throwable cause of the failuer