APIdia Launch Partner
Top Description Fields Constructors Methods
javax.naming.directory

public Class AttributeModificationException

extends NamingException
Class Inheritance
Imports
javax.naming.NamingException

This exception is thrown when an attempt is made to add, or remove, or modify an attribute, its identifier, or its values that conflicts with the attribute's (schema) definition or the attribute's state. It is thrown in response to DirContext.modifyAttributes(). It contains a list of modifications that have not been performed, in the order that they were supplied to modifyAttributes(). If the list is null, none of the modifications were performed successfully.

An AttributeModificationException instance is not synchronized against concurrent multithreaded access. Multiple threads trying to access and modify a single AttributeModification instance should lock the object.

Authors
Rosanna Lee, Scott Seligman
Since
1.3
See Also
DirContext#modifyAttributes

Field Summary

Modifier and TypeField and Description
private static final long
serialVersionUID

Hides javax.naming.NamingException.serialVersionUID.

Use serialVersionUID from JNDI 1.1.1 for interoperability
private ModificationItem[]
unexecs

Contains the possibly null list of unexecuted modifications.

Inherited from javax.naming.NamingException:
remainingNameresolvedNameresolvedObjrootException

Constructor Summary

AccessConstructor and Description
public
AttributeModificationException(String
Possibly null additional detail about this exception. If null, this exception has no detail message.
explanation
)

Constructs a new instance of AttributeModificationException using an explanation.

public
AttributeModificationException()

Constructs a new instance of AttributeModificationException.

Method Summary

Modifier and TypeMethod and Description
public ModificationItem[]

Returns:

The possibly null unexecuted modification list.
getUnexecutedModifications
()

Retrieves the unexecuted modification list.

public void
setUnexecutedModifications(ModificationItem[]
The possibly null list of unexecuted modifications.
e
)

Sets the unexecuted modification list to be e.

public String

Returns:

The non-null string representation of this exception.
toString
()

Overrides javax.naming.NamingException.toString.

The string representation of this exception consists of information about where the error occurred, and the first unexecuted modification.

Inherited from javax.naming.NamingException:
appendRemainingComponentappendRemainingNamegetCausegetExplanationgetRemainingNamegetResolvedNamegetResolvedObjgetRootCauseinitCausesetRemainingNamesetResolvedNamesetResolvedObjsetRootCausetoString

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Hides javax.naming.NamingException.serialVersionUID.

Use serialVersionUID from JNDI 1.1.1 for interoperability

unexecsback to summary
private ModificationItem[] unexecs

Contains the possibly null list of unexecuted modifications.

Constructor Detail

AttributeModificationExceptionback to summary
public AttributeModificationException(String explanation)

Constructs a new instance of AttributeModificationException using an explanation. All other fields are set to null.

Parameters
explanation:String

Possibly null additional detail about this exception. If null, this exception has no detail message.

See Also
java.lang.Throwable#getMessage
AttributeModificationExceptionback to summary
public AttributeModificationException()

Constructs a new instance of AttributeModificationException. All fields are set to null.

Method Detail

getUnexecutedModificationsback to summary
public ModificationItem[] getUnexecutedModifications()

Retrieves the unexecuted modification list. Items in the list appear in the same order in which they were originally supplied in DirContext.modifyAttributes(). The first item in the list is the first one that was not executed. If this list is null, none of the operations originally submitted to modifyAttributes() were executed.

Returns:ModificationItem[]

The possibly null unexecuted modification list.

See Also
setUnexecutedModifications
setUnexecutedModificationsback to summary
public void setUnexecutedModifications(ModificationItem[] e)

Sets the unexecuted modification list to be e. Items in the list must appear in the same order in which they were originally supplied in DirContext.modifyAttributes(). The first item in the list is the first one that was not executed. If this list is null, none of the operations originally submitted to modifyAttributes() were executed.

Parameters
e:ModificationItem[]

The possibly null list of unexecuted modifications.

See Also
getUnexecutedModifications
toStringback to summary
public String toString()

Overrides javax.naming.NamingException.toString.

The string representation of this exception consists of information about where the error occurred, and the first unexecuted modification. This string is meant for debugging and not mean to be interpreted programmatically.

Returns:String

The non-null string representation of this exception.