Package com.arbortext.epic.io

Class IOException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.arbortext.epic.io.IOException

All Implemented Interfaces:

Serializable

public class IOException
extends RuntimeException

Defines the exceptions thrown by content management system (CMS) adapters to notify Editor that an error has occurred. IOException contains an error code, an error message, and an optional detailed error description.

The code field contains the Arbortext-supplied IOExceptionCode constant for the error condition. The message field contains a short description of the error. This message is generated by either the adapter or the associated CMS and should be localized. The detail field contains a longer description of the error that may be written to a log. For example, this description could contain a Java stack trace or a detailed error description provided by the CMS. Detailed error descriptions do not need to be localized.

Since:

Epic 5.2

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final short	ALREADY_LOCKED_ERR	The object is already locked by the user requesting a lock.
static final short	ATTR_READ_ONLY_ERR	The specified attribute is read-only.
static final short	ATTR_UNSUPPORTED_ERR	The specified attribute is not supported by the adapter.
static final short	BAD_ARG_ERR	An invalid argument was passed to a method.
static final short	BAD_EXTENSION_ERR	The requested extension operation does not exist.
static final short	CANT_ALLOC_ERR	A resource allocation failed.
static final short	CANT_CONNECT_ERR	An attempt to connect to the CMS failed (not due to invalid credentials).
static final short	CANT_CREATE_ERR	An attempt to create an object failed.
static final short	CANT_DISCONNECT_ERR	An attempt to disconnect from the CMS failed.
static final short	CANT_INIT_ERR	An initialization failed.
static final short	CANT_LOCK_ERR	An attempt to lock an object failed.
static final short	CANT_OPEN_ERR	An attempt to open an object failed.
static final short	CANT_PARSE_ERR	An attempt to parse an XML or SGML object failed.
static final short	CANT_UNLOCK_ERR	An attempt to unlock an object failed.
final short	code
static final short	DECLS_LOCKED_ERR	The SGML declarations are locked by another user.
final String	detail
static final short	FOLDER_NOT_FOUND_ERR	A requested folder was not found in the CMS.
static final short	INVALID_CREDENTIALS_ERR	The user name, password, or other credentials were not valid.
static final short	INVALID_LOGICAL_ID_ERR	A Logical ID did not have the correct format.
static final short	INVALID_POID_ERR	A Persistent Object Identifier (POID) did not have the correct format.
static final short	LOCKED_BY_OTHER_ERR	The object is already locked by another user.
static final short	NO_CONFIG_ERR	The configuration file was not found.
static final short	NO_LICENSE_ERR	An attempt to obtain a license failed.
static final short	NO_MORE_ELEMENTS_ERR	There are no more entries to retrieve.
static final short	NO_NESTED_TRANS_ERR	The adapter does not support nested transactions.
static final short	NOT_IMPLEMENTED_ERR	The requested operation is not implemented by the adapter.
static final short	OBJECT_IS_FOLDER_ERR	The requested operation cannot be performed, because the object is a folder.
static final short	OBJECT_IS_LOCKED_ERR	The object must be unlocked to proceed.
static final short	OBJECT_NOT_CONTAINER_ERR	The requested operation cannot be performed, because the object is not a container.
static final short	OBJECT_NOT_FOUND_ERR	An object, identified by its Persistent Object Identifier (POID) or Logical ID, was not found in the CMS.
static final short	OBJECT_NOT_LEAF_ERR	The requested operation cannot be performed, because the object is not a leaf.
static final short	OPERATION_CANCELLED_ERR	The requested operation was cancelled by the user.
static final short	OPERATION_FAILED_ERR	The requested operation failed.
static final short	OPERATION_NOT_ENABLED_ERR	Method cannot be called in the current state.
static final short	PARENT_NOT_LOCKED_ERR	An attempt to create a new object failed, because the parent object is not locked.
static final short	STILL_CONNECTED_ERR	An attempt to reconnect to an already active session or to terminate the adapter with sessions still active.

Constructor Summary

Constructors

Constructor	Description
IOException(short code)
IOException(short code, String message)
IOException(short code, String message, String detail)

Method Summary

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

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

code

public final short code

detail

public final String detail

OPERATION_FAILED_ERR

public static final short OPERATION_FAILED_ERR

The requested operation failed.

See Also:

• Constant Field Values

OPERATION_CANCELLED_ERR

public static final short OPERATION_CANCELLED_ERR

The requested operation was cancelled by the user.

See Also:

• Constant Field Values

NOT_IMPLEMENTED_ERR

public static final short NOT_IMPLEMENTED_ERR

The requested operation is not implemented by the adapter.

See Also:

• Constant Field Values

BAD_ARG_ERR

public static final short BAD_ARG_ERR

An invalid argument was passed to a method.

See Also:

• Constant Field Values

CANT_ALLOC_ERR

public static final short CANT_ALLOC_ERR

A resource allocation failed.

See Also:

• Constant Field Values

CANT_INIT_ERR

public static final short CANT_INIT_ERR

An initialization failed.

See Also:

• Constant Field Values

NO_LICENSE_ERR

public static final short NO_LICENSE_ERR

An attempt to obtain a license failed.

See Also:

• Constant Field Values

BAD_EXTENSION_ERR

public static final short BAD_EXTENSION_ERR

The requested extension operation does not exist.

See Also:

• Constant Field Values

CANT_CONNECT_ERR

public static final short CANT_CONNECT_ERR

An attempt to connect to the CMS failed (not due to invalid credentials).

See Also:

• Constant Field Values

INVALID_CREDENTIALS_ERR

public static final short INVALID_CREDENTIALS_ERR

The user name, password, or other credentials were not valid.

See Also:

• Constant Field Values

STILL_CONNECTED_ERR

public static final short STILL_CONNECTED_ERR

An attempt to reconnect to an already active session or to terminate the adapter with sessions still active.

See Also:

• Constant Field Values

CANT_DISCONNECT_ERR

public static final short CANT_DISCONNECT_ERR

An attempt to disconnect from the CMS failed.

See Also:

• Constant Field Values

NO_CONFIG_ERR

public static final short NO_CONFIG_ERR

The configuration file was not found.
This error code is deprecated. New adapter implementations should, instead, simply return null from IOSession.loadConfiguration() when the requested configuration data is not available.

See Also:

• Constant Field Values

OBJECT_NOT_FOUND_ERR

public static final short OBJECT_NOT_FOUND_ERR

An object, identified by its Persistent Object Identifier (POID) or Logical ID, was not found in the CMS.

See Also:

• Constant Field Values

INVALID_LOGICAL_ID_ERR

public static final short INVALID_LOGICAL_ID_ERR

A Logical ID did not have the correct format.

See Also:

• Constant Field Values

INVALID_POID_ERR

public static final short INVALID_POID_ERR

A Persistent Object Identifier (POID) did not have the correct format.

See Also:

• Constant Field Values

NO_NESTED_TRANS_ERR

public static final short NO_NESTED_TRANS_ERR

The adapter does not support nested transactions.

See Also:

• Constant Field Values

OPERATION_NOT_ENABLED_ERR

public static final short OPERATION_NOT_ENABLED_ERR

Method cannot be called in the current state. Some adapters support more than one mode, such as online versus offline editing, and not all operations are allowed in every mode. For example, you might not be able to create new CMS folders while working offline.

See Also:

• Constant Field Values

CANT_OPEN_ERR

public static final short CANT_OPEN_ERR

An attempt to open an object failed.

See Also:

• Constant Field Values

CANT_CREATE_ERR

public static final short CANT_CREATE_ERR

An attempt to create an object failed.

See Also:

• Constant Field Values

PARENT_NOT_LOCKED_ERR

public static final short PARENT_NOT_LOCKED_ERR

An attempt to create a new object failed, because the parent object is not locked.

See Also:

• Constant Field Values

DECLS_LOCKED_ERR

public static final short DECLS_LOCKED_ERR

The SGML declarations are locked by another user.

See Also:

• Constant Field Values

OBJECT_IS_LOCKED_ERR

public static final short OBJECT_IS_LOCKED_ERR

The object must be unlocked to proceed.

See Also:

• Constant Field Values

CANT_LOCK_ERR

public static final short CANT_LOCK_ERR

An attempt to lock an object failed.

See Also:

• Constant Field Values

LOCKED_BY_OTHER_ERR

public static final short LOCKED_BY_OTHER_ERR

The object is already locked by another user.

See Also:

• Constant Field Values

ALREADY_LOCKED_ERR

public static final short ALREADY_LOCKED_ERR

The object is already locked by the user requesting a lock.

See Also:

• Constant Field Values

CANT_UNLOCK_ERR

public static final short CANT_UNLOCK_ERR

An attempt to unlock an object failed.

See Also:

• Constant Field Values

OBJECT_NOT_CONTAINER_ERR

public static final short OBJECT_NOT_CONTAINER_ERR

The requested operation cannot be performed, because the object is not a container.

See Also:

• Constant Field Values

OBJECT_NOT_LEAF_ERR

public static final short OBJECT_NOT_LEAF_ERR

The requested operation cannot be performed, because the object is not a leaf.

See Also:

• Constant Field Values

OBJECT_IS_FOLDER_ERR

public static final short OBJECT_IS_FOLDER_ERR

The requested operation cannot be performed, because the object is a folder.

See Also:

• Constant Field Values

CANT_PARSE_ERR

public static final short CANT_PARSE_ERR

An attempt to parse an XML or SGML object failed.

See Also:

• Constant Field Values

FOLDER_NOT_FOUND_ERR

public static final short FOLDER_NOT_FOUND_ERR

A requested folder was not found in the CMS.

Since:

Arbortext 6.0 M020

See Also:

• Constant Field Values

ATTR_UNSUPPORTED_ERR

public static final short ATTR_UNSUPPORTED_ERR

The specified attribute is not supported by the adapter.

See Also:

• Constant Field Values

ATTR_READ_ONLY_ERR

public static final short ATTR_READ_ONLY_ERR

The specified attribute is read-only.

See Also:

• Constant Field Values

NO_MORE_ELEMENTS_ERR

public static final short NO_MORE_ELEMENTS_ERR

There are no more entries to retrieve.

See Also:

• Constant Field Values

Constructor Details

IOException

public IOException(short code,
 String message,
 String detail)

IOException

public IOException(short code,
 String message)

IOException

public IOException(short code)