Package org.opends.server.types

Class SynchronizationProviderResult.StopProcessing

java.lang.Object

org.opends.server.types.SynchronizationProviderResult.StopProcessing

All Implemented Interfaces:

PluginResult.OperationResult, SynchronizationProviderResult

Enclosing interface:

SynchronizationProviderResult

public static class SynchronizationProviderResult.StopProcessing
extends Object
implements SynchronizationProviderResult

Defines a stop processing synchronization provider result.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opends.server.types.SynchronizationProviderResult

SynchronizationProviderResult.ContinueProcessing, SynchronizationProviderResult.StopProcessing

Constructor Summary

Constructors

Constructor	Description
StopProcessing(ResultCode resultCode, org.forgerock.i18n.LocalizableMessage errorMessage)	Construct a new stop processing synchronization provider result.
StopProcessing(ResultCode resultCode, org.forgerock.i18n.LocalizableMessage errorMessage, DN matchedDN, List<String> referralURLs)	Construct a new stop processing synchronization provider result.

Method Summary

Modifier and Type	Method	Description
boolean	continueProcessing()	Indicates whether processing on the associated operation should continue.
org.forgerock.i18n.LocalizableMessage	getErrorMessage()	Retrieves the error message if PluginResult.OperationResult.continueProcessing() returned false.
DN	getMatchedDN()	Retrieves the matched DN for the operation if PluginResult.OperationResult.continueProcessing() returned false.
List<String>	getReferralURLs()	Retrieves the referral URLs for the operation if PluginResult.OperationResult.continueProcessing() returned false.
ResultCode	getResultCode()	Retrieves the result code for the operation if PluginResult.OperationResult.continueProcessing() returned false.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

StopProcessing

public StopProcessing(ResultCode resultCode,
                      org.forgerock.i18n.LocalizableMessage errorMessage,
                      DN matchedDN,
                      List<String> referralURLs)

Construct a new stop processing synchronization provider result.

Parameters:

resultCode - The result code for this result.

errorMessage - An message explaining why processing should stop.

matchedDN - The matched DN for this result.

referralURLs - The set of referral URLs for this result.

StopProcessing

public StopProcessing(ResultCode resultCode,
                      org.forgerock.i18n.LocalizableMessage errorMessage)

Construct a new stop processing synchronization provider result.

Parameters:

resultCode - The result code for this result.

errorMessage - An message explaining why processing should stop.

Method Detail

getResultCode

public ResultCode getResultCode()

Description copied from interface: PluginResult.OperationResult

Retrieves the result code for the operation if PluginResult.OperationResult.continueProcessing() returned false.

Specified by:

getResultCode in interface PluginResult.OperationResult

Returns:

the result code for the operation or null if none is provided.

getMatchedDN

public DN getMatchedDN()

Description copied from interface: PluginResult.OperationResult

Retrieves the matched DN for the operation if PluginResult.OperationResult.continueProcessing() returned false.

Specified by:

getMatchedDN in interface PluginResult.OperationResult

Returns:

the matched DN for the operation or null if none is provided.

getReferralURLs

public List<String> getReferralURLs()

Description copied from interface: PluginResult.OperationResult

Retrieves the referral URLs for the operation if PluginResult.OperationResult.continueProcessing() returned false.

Specified by:

getReferralURLs in interface PluginResult.OperationResult

Returns:

the referral URLs for the operation or null if none is provided.

continueProcessing

public boolean continueProcessing()

Description copied from interface: PluginResult.OperationResult

Indicates whether processing on the associated operation should continue.

Specified by:

continueProcessing in interface PluginResult.OperationResult

Returns:

true if processing on the associated operation should continue, or false if it should stop.

getErrorMessage

public org.forgerock.i18n.LocalizableMessage getErrorMessage()

Description copied from interface: PluginResult.OperationResult

Retrieves the error message if PluginResult.OperationResult.continueProcessing() returned false.

Specified by:

getErrorMessage in interface PluginResult.OperationResult

Returns:

An error message explaining why processing should stop or null if none is provided.

toString

public String toString()

Overrides:

toString in class Object