Package org.forgerock.opendj.config.client

Class OperationRejectedException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.forgerock.opendj.config.AdminException

org.forgerock.opendj.config.client.OperationRejectedException

All Implemented Interfaces:

Serializable, LocalizableException

public class OperationRejectedException
extends AdminException

This exception is thrown when the client or server refuses to create, delete, or modify a managed object due to one or more constraints that cannot be satisfied.

Operations can be rejected either by a client-side constraint violation triggered by ClientConstraintHandler, or by a server-side error.

For example, the Directory Server might not be able perform an operation due to some OS related problem, such as lack of disk space, or missing files.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OperationRejectedException.OperationType	The type of operation that caused this exception.

Constructor Summary

Constructors

Constructor	Description
OperationRejectedException(OperationRejectedException.OperationType type, LocalizableMessage ufn)	Creates a new operation rejected exception with a default message.
OperationRejectedException(OperationRejectedException.OperationType type, LocalizableMessage ufn, Collection<LocalizableMessage> messages)	Creates a new operation rejected exception with the provided messages.
OperationRejectedException(OperationRejectedException.OperationType type, LocalizableMessage ufn, LocalizableMessage message)	Creates a new operation rejected exception with the provided message.

Method Summary

Modifier and Type	Method	Description
Collection<LocalizableMessage>	getMessages()	Gets an unmodifiable collection view of the messages describing the constraint violations that occurred.
LocalizableMessage	getMessagesAsSingleMessage()	Creates a single message listing all the messages combined into a single list separated by semi-colons.
OperationRejectedException.OperationType	getOperationType()	Gets the type of operation that caused this exception.
LocalizableMessage	getUserFriendlyName()	Gets the user friendly name of the component that caused this exception.

Methods inherited from class org.forgerock.opendj.config.AdminException

getMessageObject

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

OperationRejectedException

public OperationRejectedException(OperationRejectedException.OperationType type,
                                  LocalizableMessage ufn)

Creates a new operation rejected exception with a default message.

Parameters:

type - The type of operation that caused this exception.

ufn - The user friendly name of the component that caused this exception.

OperationRejectedException

public OperationRejectedException(OperationRejectedException.OperationType type,
                                  LocalizableMessage ufn,
                                  Collection<LocalizableMessage> messages)

Creates a new operation rejected exception with the provided messages.

Parameters:

type - The type of operation that caused this exception.

ufn - The user friendly name of the component that caused this exception.

messages - The messages describing the constraint violations that occurred (must be non-null and non-empty).

OperationRejectedException

public OperationRejectedException(OperationRejectedException.OperationType type,
                                  LocalizableMessage ufn,
                                  LocalizableMessage message)

Creates a new operation rejected exception with the provided message.

Parameters:

type - The type of operation that caused this exception.

ufn - The user friendly name of the component that caused this exception.

message - The message describing the constraint violation that occurred.

Method Detail

getMessages

public Collection<LocalizableMessage> getMessages()

Gets an unmodifiable collection view of the messages describing the constraint violations that occurred.

Returns:

Returns an unmodifiable collection view of the messages describing the constraint violations that occurred.

getMessagesAsSingleMessage

public LocalizableMessage getMessagesAsSingleMessage()

Creates a single message listing all the messages combined into a single list separated by semi-colons.

Returns:

Returns a single message listing all the messages combined into a single list separated by semi-colons.

getOperationType

public OperationRejectedException.OperationType getOperationType()

Gets the type of operation that caused this exception.

Returns:

Returns the type of operation that caused this exception.

getUserFriendlyName

public LocalizableMessage getUserFriendlyName()

Gets the user friendly name of the component that caused this exception.

Returns:

Returns the user friendly name of the component that caused this exception.