com.unboundid.directory.sdk.sync.types

Class EndpointException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.unboundid.directory.sdk.sync.types.EndpointException

All Implemented Interfaces:

java.io.Serializable

@Extensible
public class EndpointException
extends java.lang.Exception

This class provides a type of Exception which is used to indicate an error when interfacing with an external resource. There is an included PostStepResult which can be used to communicate back to the Data Sync Server what it should do after a failure.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
EndpointException(LDAPException cause) Creates a new EndpointException with the provided information.
EndpointException(PostStepResult result) Creates a new EndpointException with the provided information.
EndpointException(PostStepResult result, java.lang.String message) Creates a new EndpointException with the provided information.
EndpointException(PostStepResult result, java.lang.String message, java.lang.Throwable cause) Creates a new EndpointException with the provided information.
EndpointException(PostStepResult result, java.lang.Throwable cause) Creates a new EndpointException with the provided information.

Method Summary

Modifier and Type	Method and Description
PostStepResult	getPostStepResult() Gets the result object which indicates how the Data Sync Server should proceed with the sync operation.

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

EndpointException

public EndpointException(PostStepResult result)

Creates a new EndpointException with the provided information.

Parameters:

result - The result object which indicates how the Data Sync Server should proceed with the sync operation. The value of PostStepResult.CONTINUE is undefined in this context and cannot be used.

EndpointException

public EndpointException(PostStepResult result,
                         java.lang.String message)

Creates a new EndpointException with the provided information.

Parameters:

result - The result object which indicates how the Data Sync Server should proceed with the sync operation. The value of PostStepResult.CONTINUE is undefined in this context and cannot be used.

message - The message that explains the problem that occurred.

EndpointException

public EndpointException(PostStepResult result,
                         java.lang.Throwable cause)

Creates a new EndpointException with the provided information.

Parameters:

result - The result object which indicates how the Data Sync Server should proceed with the sync operation. The value of PostStepResult.CONTINUE is undefined in this context and cannot be used.

cause - The underlying cause that triggered this exception.

EndpointException

public EndpointException(PostStepResult result,
                         java.lang.String message,
                         java.lang.Throwable cause)

Creates a new EndpointException with the provided information.

Parameters:

result - The result object which indicates how the Data Sync Server should proceed with the sync operation. The value of PostStepResult.CONTINUE is undefined in this context and cannot be used.

message - The message that explains the problem that occurred.

cause - The underlying cause that triggered this exception.

EndpointException

public EndpointException(LDAPException cause)

Creates a new EndpointException with the provided information. No PostStepResult is required here because the Data Sync Server has built-in logic to interpret an LDAPException.

Parameters:

cause - The underlying cause that triggered this exception.

Method Detail

getPostStepResult

public final PostStepResult getPostStepResult()

Gets the result object which indicates how the Data Sync Server should proceed with the sync operation. The value will never be PostStepResult.CONTINUE, because this is undefined in this context. If the object was constructed with EndpointException(LDAPException) then this method will return null.

Returns:

a PostStepResult indicating the retry policy that should be taken