OSGi 8.1.0 · org.osgi.service.dmt.DmtException · APIdia, the JavaDoc alternative

Field Summary

Modifier and Type	Field and Description
public static final int	ALERT_NOT_ROUTED An alert can not be sent from the device to the given principal.
private final Throwable[]	causes The list of originating exceptions, or empty list or `null` if there are no originating exceptions.
private final int	code The error code of the failure, one of the constants defined in this class.
public static final int	COMMAND_FAILED The recipient encountered an error which prevented it from fulfilling the request.
public static final int	COMMAND_NOT_ALLOWED The requested command is not allowed on the target node.
public static final int	CONCURRENT_ACCESS An error occurred related to concurrent access of nodes.
public static final int	DATA_STORE_FAILURE An error related to the recipient data store occurred while processing the request.
private final boolean	fatal Determines whether the exception is fatal or not.
public static final int	FEATURE_NOT_SUPPORTED The requested command failed because an optional feature required by the command is not supported.
public static final int	INVALID_URI The requested command failed because the target URI or node name is `null` or syntactically invalid.
public static final int	LIMIT_EXCEEDED The requested operation failed because a specific limit was exceeded, e.g. if a requested resource exceeds a size limit.
private final String	message The message associated with the exception, or `null` if there is no error message.
public static final int	METADATA_MISMATCH Operation failed because of meta data restrictions.
public static final int	NODE_ALREADY_EXISTS The requested node creation operation failed because the target already exists.
public static final int	NODE_NOT_FOUND The requested target node was not found.
public static final int	PERMISSION_DENIED The requested command failed because the principal associated with the session does not have adequate access control permissions (ACL) on the target.
public static final int	REMOTE_ERROR A device initiated remote operation failed.
public static final int	ROLLBACK_FAILED The rollback command was not completed successfully.
private static final long	serialVersionUID Hides java.lang.Exception.serialVersionUID.
public static final int	SESSION_CREATION_TIMEOUT Creation of a session timed out because of another ongoing session.
public static final int	TRANSACTION_ERROR A transaction-related error occurred in an atomic session.
public static final int	UNAUTHORIZED The originator's authentication credentials specify a principal with insufficient rights to complete the command.
private final String	uri The URI of the node on which the failed DMT operation was issued, or `null` if the operation was not associated with a node.
public static final int	URI_TOO_LONG The requested command failed because the target URI is too long for what the recipient is able or willing to process.

Constructor Summary

Access	Constructor and Description
public	DmtException(String the node on which the failed DMT operation was issued, or `null` if the operation is not associated with a node uri, int the error code of the failure code, String the message associated with the exception, or `null` if there is no error message message) Create an instance of the exception.
public	DmtException(String the node on which the failed DMT operation was issued, or `null` if the operation is not associated with a node uri, int the error code of the failure code, String the message associated with the exception, or `null` if there is no error message message, Throwable the originating exception, or `null` if there is no originating exception cause) Create an instance of the exception, specifying the cause exception.
public	DmtException(String the node on which the failed DMT operation was issued, or `null` if the operation is not associated with a node uri, int the error code of the failure code, String the message associated with the exception, or `null` if there is no error message message, Vector<? extends Throwable> the list of originating exceptions, or empty list or `null` if there are no originating exceptions causes, boolean whether the exception is fatal fatal) Create an instance of the exception, specifying the list of cause exceptions and whether the exception is a fatal one.
private	DmtException(String uri, int code, String message, Throwable[] causes, boolean fatal)
public	DmtException(String[] the path of the node on which the failed DMT operation was issued, or `null` if the operation is not associated with a node path, int the error code of the failure code, String the message associated with the exception, or `null` if there is no error message message) Create an instance of the exception, specifying the target node as an array of path segments.
public	DmtException(String[] the path of the node on which the failed DMT operation was issued, or `null` if the operation is not associated with a node path, int the error code of the failure code, String the message associated with the exception, or `null` if there is no error message message, Throwable the originating exception, or `null` if there is no originating exception cause) Create an instance of the exception, specifying the target node as an array of path segments, and specifying the cause exception.
public	DmtException(String[] the path of the node on which the failed DMT operation was issued, or `null` if the operation is not associated with a node path, int the error code of the failure code, String the message associated with the exception, or `null` if there is no error message message, Vector<? extends Throwable> the list of originating exceptions, or empty list or `null` if there are no originating exceptions causes, boolean whether the exception is fatal fatal) Create an instance of the exception, specifying the target node as an array of path segments, the list of cause exceptions, and whether the exception is a fatal one.

Method Summary

Modifier and Type	Method and Description
public Throwable	Returns: the cause of this exception, or `null` if no cause was given getCause() Overrides java.lang.Throwable.getCause. Get the cause of this exception.
public Throwable[]	Returns: the list of causes of this exception getCauses() Get all causes of this exception.
public int	Returns: the error code getCode() Get the error code associated with this exception.
private static String	Returns: a string containing the error code name getCodeText(int the error code code) Returns the name of the given error code.
public String	Returns: the error message in the format described above getMessage() Overrides java.lang.Throwable.getMessage. Get the message associated with this exception.
public String	Returns: the URI of the node, or `null` getURI() Get the node on which the failed DMT operation was issued.
public boolean	Returns: whether the exception is marked as fatal isFatal() Check whether this exception is marked as fatal in the session.
pack-priv static String	Returns: the URI string representing the same node as the given path pathToUri(String[] the path to convert path) Converts the given path, given as an array of path segments, to a single URI string.
public void	printStackTrace(PrintStream `PrintStream` to use for output s) Overrides java.lang.Throwable.printStackTrace. Prints the exception and its stacktrace to the specified print stream.

Field Detail

ALERT_NOT_ROUTED	back to summary
public static final int ALERT_NOT_ROUTED An alert can not be sent from the device to the given principal. This can happen if there is no Remote Alert Sender willing to forward the alert to the given principal, or if no principal was given and the DmtAdmin did not find an appropriate default destination. This error code does not correspond to any OMA DM response status code. It should be translated to the code 500 "Command Failed" when transferring over OMA DM.

ALERT_NOT_ROUTED

back to summary

public static final int ALERT_NOT_ROUTED

An alert can not be sent from the device to the given principal. This can happen if there is no Remote Alert Sender willing to forward the alert to the given principal, or if no principal was given and the DmtAdmin did not find an appropriate default destination.

This error code does not correspond to any OMA DM response status code. It should be translated to the code 500 "Command Failed" when transferring over OMA DM.

causes	back to summary
private final Throwable[] causes The list of originating exceptions, or empty list or `null` if there are no originating exceptions.

code	back to summary
private final int code The error code of the failure, one of the constants defined in this class.

COMMAND_FAILED	back to summary
public static final int COMMAND_FAILED The recipient encountered an error which prevented it from fulfilling the request. This error code is only used in situations not covered by any of the other error codes that a method may use. Some methods specify more specific error situations for this code, but it can generally be used for any unexpected condition that causes the command to fail. This error code corresponds to the OMA DM response status code 500 "Command Failed".

COMMAND_FAILED

back to summary

public static final int COMMAND_FAILED

The recipient encountered an error which prevented it from fulfilling the request.

This error code is only used in situations not covered by any of the other error codes that a method may use. Some methods specify more specific error situations for this code, but it can generally be used for any unexpected condition that causes the command to fail.

This error code corresponds to the OMA DM response status code 500 "Command Failed".

COMMAND_NOT_ALLOWED	back to summary
public static final int COMMAND_NOT_ALLOWED The requested command is not allowed on the target node. This includes the following situations: an interior node operation is requested for a leaf node, or vice versa (e.g. trying to retrieve the children of a leaf node) an attempt is made to create a node where the parent is a leaf node an attempt is made to rename or delete the root node of the tree an attempt is made to rename or delete the root node of the session a write operation (other than setting the ACL) is performed in a non-atomic write session on a node provided by a plugin that is read-only or does not support non-atomic writing a node is copied to its descendant the ACL of the root node is changed not to include Add rights for all principals This error code corresponds to the OMA DM response status code 405 "Command not allowed".

COMMAND_NOT_ALLOWED

back to summary

public static final int COMMAND_NOT_ALLOWED

The requested command is not allowed on the target node. This includes the following situations:

an interior node operation is requested for a leaf node, or vice versa (e.g. trying to retrieve the children of a leaf node)
an attempt is made to create a node where the parent is a leaf node
an attempt is made to rename or delete the root node of the tree
an attempt is made to rename or delete the root node of the session
a write operation (other than setting the ACL) is performed in a non-atomic write session on a node provided by a plugin that is read-only or does not support non-atomic writing
a node is copied to its descendant
the ACL of the root node is changed not to include Add rights for all principals

This error code corresponds to the OMA DM response status code 405 "Command not allowed".

CONCURRENT_ACCESS	back to summary
public static final int CONCURRENT_ACCESS An error occurred related to concurrent access of nodes. This can happen for example if a configuration node was deleted directly through the Configuration Admin service, while the node was manipulated via the tree. This error code does not correspond to any OMA DM response status code. It should be translated to the code 500 "Command Failed" when transferring over OMA DM.

CONCURRENT_ACCESS

back to summary

public static final int CONCURRENT_ACCESS

An error occurred related to concurrent access of nodes. This can happen for example if a configuration node was deleted directly through the Configuration Admin service, while the node was manipulated via the tree.

This error code does not correspond to any OMA DM response status code. It should be translated to the code 500 "Command Failed" when transferring over OMA DM.

DATA_STORE_FAILURE	back to summary
public static final int DATA_STORE_FAILURE An error related to the recipient data store occurred while processing the request. This error code may be thrown by any of the methods accessing the tree, but whether it is really used depends on the implementation, and the data store it uses. This error code corresponds to the OMA DM response status code 510 "Data store failure".

DATA_STORE_FAILURE

back to summary

public static final int DATA_STORE_FAILURE

An error related to the recipient data store occurred while processing the request. This error code may be thrown by any of the methods accessing the tree, but whether it is really used depends on the implementation, and the data store it uses.

This error code corresponds to the OMA DM response status code 510 "Data store failure".

fatal	back to summary
private final boolean fatal Determines whether the exception is fatal or not. This is basically a two-state severity indicator, with the 'fatal' severity being the more serious one.

FEATURE_NOT_SUPPORTED	back to summary
public static final int FEATURE_NOT_SUPPORTED The requested command failed because an optional feature required by the command is not supported. For example, opening an atomic session might return this error code if the DmtAdmin implementation does not support transactions. Similarly, accessing the optional node properties (Title, Timestamp, Version, Size) might not succeed if either the DmtAdmin implementation or the underlying plugin does not support the property. When getting or setting values for interior nodes (an optional optimization feature), a plugin can use this error code to indicate that the given interior node does not support values. This error code corresponds to the OMA DM response status code 406 "Optional feature not supported".

FEATURE_NOT_SUPPORTED

back to summary

public static final int FEATURE_NOT_SUPPORTED

The requested command failed because an optional feature required by the command is not supported. For example, opening an atomic session might return this error code if the DmtAdmin implementation does not support transactions. Similarly, accessing the optional node properties (Title, Timestamp, Version, Size) might not succeed if either the DmtAdmin implementation or the underlying plugin does not support the property.

When getting or setting values for interior nodes (an optional optimization feature), a plugin can use this error code to indicate that the given interior node does not support values.

This error code corresponds to the OMA DM response status code 406 "Optional feature not supported".

INVALID_URI back to summary

INVALID_URI	back to summary
public static final int INVALID_URI The requested command failed because the target URI or node name is `null` or syntactically invalid. This covers the following cases: the URI or node name ends with the '\' or '/' character the URI is an empty string (only invalid if the method does not accept relative URIs) the URI contains the segment "`.`" at a position other than the beginning of the URI the node name is "`..`" or the URI contains such a segment the node name contains an unescaped '/' character See the `Uri#encode(String)` method for support on escaping invalid characters in a URI. This code is only used if the URI or node name does not match any of the criteria for `URI_TOO_LONG`. This error code does not correspond to any OMA DM response status code. It should be translated to the code 404 "Not Found" when transferring over OMA DM.

public static final int INVALID_URI

The requested command failed because the target URI or node name is null or syntactically invalid. This covers the following cases:

the URI or node name ends with the '\' or '/' character
the URI is an empty string (only invalid if the method does not accept relative URIs)
the URI contains the segment "." at a position other than the beginning of the URI
the node name is ".." or the URI contains such a segment
the node name contains an unescaped '/' character

See the Uri#encode(String) method for support on escaping invalid characters in a URI.

This code is only used if the URI or node name does not match any of the criteria for URI_TOO_LONG. This error code does not correspond to any OMA DM response status code. It should be translated to the code 404 "Not Found" when transferring over OMA DM.

LIMIT_EXCEEDED	back to summary
public static final int LIMIT_EXCEEDED The requested operation failed because a specific limit was exceeded, e.g. if a requested resource exceeds a size limit. This error code corresponds to the OMA DM response status code 413 "Request entity too large". Since 2.0

LIMIT_EXCEEDED

back to summary

public static final int LIMIT_EXCEEDED

The requested operation failed because a specific limit was exceeded, e.g. if a requested resource exceeds a size limit.

This error code corresponds to the OMA DM response status code 413 "Request entity too large".

Since: 2.0

message	back to summary
private final String message The message associated with the exception, or `null` if there is no error message.

METADATA_MISMATCH back to summary

public static final int METADATA_MISMATCH

Operation failed because of meta data restrictions. This covers any attempted deviation from the parameters defined by the MetaNode objects of the affected nodes, for example in the following situations:

creating, deleting or renaming a permanent node, or modifying its type
creating an interior node where the meta-node defines it as a leaf, or vice versa
any operation on a node which does not have the required access type (e.g. executing a node that lacks the MetaNode.CMD_EXECUTE access type)
any node creation or deletion that would violate the cardinality constraints
any leaf node value setting that would violate the allowed formats, values, mime types, etc.
any node creation that would violate the allowed node names

This error code can also be used to indicate any other meta data violation, even if it cannot be described by the MetaNode class. For example, detecting a multi-node constraint violation while committing an atomic session should result in this error.

This error code does not correspond to any OMA DM response status code. It should be translated to the code 405 "Command not allowed" when transferring over OMA DM.

NODE_ALREADY_EXISTS back to summary

NODE_ALREADY_EXISTS	back to summary
public static final int NODE_ALREADY_EXISTS The requested node creation operation failed because the target already exists. This can occur if the node is created directly (with one of the `create...` methods), or indirectly (during a `copy` operation). This error code corresponds to the OMA DM response status code 418 "Already exists".

public static final int NODE_ALREADY_EXISTS

The requested node creation operation failed because the target already exists. This can occur if the node is created directly (with one of the create... methods), or indirectly (during a copy operation).

This error code corresponds to the OMA DM response status code 418 "Already exists".

NODE_NOT_FOUND back to summary

NODE_NOT_FOUND	back to summary
public static final int NODE_NOT_FOUND The requested target node was not found. No indication is given as to whether this is a temporary or permanent condition, unless otherwise noted. This is only used when the requested node name is valid, otherwise the more specific error codes `URI_TOO_LONG` or `INVALID_URI` are used. This error code corresponds to the OMA DM response status code 404 "Not Found".

public static final int NODE_NOT_FOUND

The requested target node was not found. No indication is given as to whether this is a temporary or permanent condition, unless otherwise noted.

This is only used when the requested node name is valid, otherwise the more specific error codes URI_TOO_LONG or INVALID_URI are used. This error code corresponds to the OMA DM response status code 404 "Not Found".

PERMISSION_DENIED	back to summary
public static final int PERMISSION_DENIED The requested command failed because the principal associated with the session does not have adequate access control permissions (ACL) on the target. This can only appear in case of remote sessions, i.e. if the session is associated with an authenticated principal. This error code corresponds to the OMA DM response status code 425 "Permission denied".

PERMISSION_DENIED

back to summary

public static final int PERMISSION_DENIED

The requested command failed because the principal associated with the session does not have adequate access control permissions (ACL) on the target. This can only appear in case of remote sessions, i.e. if the session is associated with an authenticated principal.

This error code corresponds to the OMA DM response status code 425 "Permission denied".

REMOTE_ERROR back to summary

REMOTE_ERROR	back to summary
public static final int REMOTE_ERROR A device initiated remote operation failed. This is used when the protocol adapter fails to send an alert for any reason. Alert routing errors (that occur while looking for the proper protocol adapter to use) are indicated by `ALERT_NOT_ROUTED`, this code is only for errors encountered while sending the routed alert. This error code does not correspond to any OMA DM response status code. It should be translated to the code 500 "Command Failed" when transferring over OMA DM.

public static final int REMOTE_ERROR

A device initiated remote operation failed. This is used when the protocol adapter fails to send an alert for any reason.

Alert routing errors (that occur while looking for the proper protocol adapter to use) are indicated by ALERT_NOT_ROUTED, this code is only for errors encountered while sending the routed alert. This error code does not correspond to any OMA DM response status code. It should be translated to the code 500 "Command Failed" when transferring over OMA DM.

ROLLBACK_FAILED	back to summary
public static final int ROLLBACK_FAILED The rollback command was not completed successfully. The tree might be in an inconsistent state after this error. This error code corresponds to the OMA DM response status code 516 "Atomic roll back failed".

ROLLBACK_FAILED

back to summary

public static final int ROLLBACK_FAILED

The rollback command was not completed successfully. The tree might be in an inconsistent state after this error.

This error code corresponds to the OMA DM response status code 516 "Atomic roll back failed".

serialVersionUID	back to summary
private static final long serialVersionUID Hides java.lang.Exception.serialVersionUID.

SESSION_CREATION_TIMEOUT	back to summary
public static final int SESSION_CREATION_TIMEOUT Creation of a session timed out because of another ongoing session. The length of time while the DmtAdmin waits for the blocking session(s) to finish is implementation dependent. This error code does not correspond to any OMA DM response status code. OMA has several status codes related to timeout, but these are meant to be used when a request times out, not if a session can not be established. This error code should be translated to the code 500 "Command Failed" when transferring over OMA DM.

SESSION_CREATION_TIMEOUT

back to summary

public static final int SESSION_CREATION_TIMEOUT

Creation of a session timed out because of another ongoing session. The length of time while the DmtAdmin waits for the blocking session(s) to finish is implementation dependent.

This error code does not correspond to any OMA DM response status code. OMA has several status codes related to timeout, but these are meant to be used when a request times out, not if a session can not be established. This error code should be translated to the code 500 "Command Failed" when transferring over OMA DM.

TRANSACTION_ERROR back to summary

TRANSACTION_ERROR	back to summary
public static final int TRANSACTION_ERROR A transaction-related error occurred in an atomic session. This error is caused by one of the following situations: an updating method within an atomic session can not be executed because the underlying plugin is read-only or does not support atomic writing a commit operation at the end of an atomic session failed because one of the underlying plugins failed to close The latter case may leave the tree in an inconsistent state due to the lack of a two-phase commit system, see `DmtSession#commit()` for details. This error code does not correspond to any OMA DM response status code. It should be translated to the code 500 "Command Failed" when transferring over OMA DM.

public static final int TRANSACTION_ERROR

A transaction-related error occurred in an atomic session. This error is caused by one of the following situations:

an updating method within an atomic session can not be executed because the underlying plugin is read-only or does not support atomic writing
a commit operation at the end of an atomic session failed because one of the underlying plugins failed to close

The latter case may leave the tree in an inconsistent state due to the lack of a two-phase commit system, see DmtSession#commit() for details.

This error code does not correspond to any OMA DM response status code. It should be translated to the code 500 "Command Failed" when transferring over OMA DM.

UNAUTHORIZED	back to summary
public static final int UNAUTHORIZED The originator's authentication credentials specify a principal with insufficient rights to complete the command. This status code is used as response to device originated sessions if the remote management server cannot authorize the device to perform the requested operation. This error code corresponds to the OMA DM response status code 401 "Unauthorized".

UNAUTHORIZED

back to summary

public static final int UNAUTHORIZED

The originator's authentication credentials specify a principal with insufficient rights to complete the command.

This status code is used as response to device originated sessions if the remote management server cannot authorize the device to perform the requested operation.

This error code corresponds to the OMA DM response status code 401 "Unauthorized".

uri	back to summary
private final String uri The URI of the node on which the failed DMT operation was issued, or `null` if the operation was not associated with a node.

URI_TOO_LONG	back to summary
public static final int URI_TOO_LONG The requested command failed because the target URI is too long for what the recipient is able or willing to process. This error code corresponds to the OMA DM response status code 414 "URI too long". See Also OSGi Service Platform, Mobile Specification Release 4

URI_TOO_LONG

back to summary

public static final int URI_TOO_LONG

The requested command failed because the target URI is too long for what the recipient is able or willing to process.

This error code corresponds to the OMA DM response status code 414 "URI too long".

See Also: OSGi Service Platform, Mobile Specification Release 4

Constructor Detail

DmtException back to summary

DmtException	back to summary
public DmtException(String uri, int code, String message) Create an instance of the exception. The `uri` and `message` parameters are optional. No originating exception is specified. Parameters uri:String the node on which the failed DMT operation was issued, or `null` if the operation is not associated with a node code:int the error code of the failure message:String the message associated with the exception, or `null` if there is no error message

public DmtException(String uri, int code, String message)

Create an instance of the exception. The uri and message parameters are optional. No originating exception is specified.

Parameters

uri:String: the node on which the failed DMT operation was issued, or null if the operation is not associated with a node
code:int: the error code of the failure
message:String: the message associated with the exception, or null if there is no error message

DmtException back to summary

DmtException	back to summary
public DmtException(String uri, int code, String message, Throwable cause) Create an instance of the exception, specifying the cause exception. The `uri`, `message` and `cause` parameters are optional. Parameters uri:String the node on which the failed DMT operation was issued, or `null` if the operation is not associated with a node code:int the error code of the failure message:String the message associated with the exception, or `null` if there is no error message cause:Throwable the originating exception, or `null` if there is no originating exception

public DmtException(String uri, int code, String message, Throwable cause)

Create an instance of the exception, specifying the cause exception. The uri, message and cause parameters are optional.

Parameters

uri:String: the node on which the failed DMT operation was issued, or null if the operation is not associated with a node
code:int: the error code of the failure
message:String: the message associated with the exception, or null if there is no error message
cause:Throwable: the originating exception, or null if there is no originating exception

DmtException back to summary

DmtException	back to summary
public DmtException(String uri, int code, String message, Vector<? extends Throwable> causes, boolean fatal) Create an instance of the exception, specifying the list of cause exceptions and whether the exception is a fatal one. This constructor is meant to be used by plugins wishing to indicate that a serious error occurred which should invalidate the ongoing atomic session. The `uri`, `message` and `causes` parameters are optional. If a fatal exception is thrown, no further business methods will be called on the originator plugin. In case of atomic sessions, all other open plugins will be rolled back automatically, except if the fatal exception was thrown during commit. Parameters uri:String the node on which the failed DMT operation was issued, or `null` if the operation is not associated with a node code:int the error code of the failure message:String the message associated with the exception, or `null` if there is no error message causes:Vector<? extends Throwable> the list of originating exceptions, or empty list or `null` if there are no originating exceptions fatal:boolean whether the exception is fatal

public DmtException(String uri, int code, String message, Vector<? extends Throwable> causes, boolean fatal)

Create an instance of the exception, specifying the list of cause exceptions and whether the exception is a fatal one. This constructor is meant to be used by plugins wishing to indicate that a serious error occurred which should invalidate the ongoing atomic session. The uri, message and causes parameters are optional.

If a fatal exception is thrown, no further business methods will be called on the originator plugin. In case of atomic sessions, all other open plugins will be rolled back automatically, except if the fatal exception was thrown during commit.

Parameters

uri:String: the node on which the failed DMT operation was issued, or null if the operation is not associated with a node
code:int: the error code of the failure
message:String: the message associated with the exception, or null if there is no error message
causes:Vector<? extends Throwable>: the list of originating exceptions, or empty list or null if there are no originating exceptions
fatal:boolean: whether the exception is fatal

DmtException	back to summary
private DmtException(String uri, int code, String message, Throwable[] causes, boolean fatal)

DmtException back to summary

DmtException	back to summary
public DmtException(String[] path, int code, String message) Create an instance of the exception, specifying the target node as an array of path segments. This method behaves in exactly the same way as if the path was given as a URI string. Parameters path:String[] the path of the node on which the failed DMT operation was issued, or `null` if the operation is not associated with a node code:int the error code of the failure message:String the message associated with the exception, or `null` if there is no error message See Also `DmtException(String, int, String)`

public DmtException(String[] path, int code, String message)

Create an instance of the exception, specifying the target node as an array of path segments. This method behaves in exactly the same way as if the path was given as a URI string.

Parameters

path:String[]: the path of the node on which the failed DMT operation was issued, or null if the operation is not associated with a node
code:int: the error code of the failure
message:String: the message associated with the exception, or null if there is no error message

See Also

DmtException(String, int, String)

DmtException back to summary

DmtException	back to summary
public DmtException(String[] path, int code, String message, Throwable cause) Create an instance of the exception, specifying the target node as an array of path segments, and specifying the cause exception. This method behaves in exactly the same way as if the path was given as a URI string. Parameters path:String[] the path of the node on which the failed DMT operation was issued, or `null` if the operation is not associated with a node code:int the error code of the failure message:String the message associated with the exception, or `null` if there is no error message cause:Throwable the originating exception, or `null` if there is no originating exception See Also `DmtException(String, int, String, Throwable)`

public DmtException(String[] path, int code, String message, Throwable cause)

Create an instance of the exception, specifying the target node as an array of path segments, and specifying the cause exception. This method behaves in exactly the same way as if the path was given as a URI string.

Parameters

path:String[]: the path of the node on which the failed DMT operation was issued, or null if the operation is not associated with a node
code:int: the error code of the failure
message:String: the message associated with the exception, or null if there is no error message
cause:Throwable: the originating exception, or null if there is no originating exception

DmtException back to summary

DmtException	back to summary
public DmtException(String[] path, int code, String message, Vector<? extends Throwable> causes, boolean fatal) Create an instance of the exception, specifying the target node as an array of path segments, the list of cause exceptions, and whether the exception is a fatal one. This method behaves in exactly the same way as if the path was given as a URI string. Parameters path:String[] the path of the node on which the failed DMT operation was issued, or `null` if the operation is not associated with a node code:int the error code of the failure message:String the message associated with the exception, or `null` if there is no error message causes:Vector<? extends Throwable> the list of originating exceptions, or empty list or `null` if there are no originating exceptions fatal:boolean whether the exception is fatal See Also `DmtException(String, int, String, Vector, boolean)`

public DmtException(String[] path, int code, String message, Vector<? extends Throwable> causes, boolean fatal)

Create an instance of the exception, specifying the target node as an array of path segments, the list of cause exceptions, and whether the exception is a fatal one. This method behaves in exactly the same way as if the path was given as a URI string.

Parameters

path:String[]: the path of the node on which the failed DMT operation was issued, or null if the operation is not associated with a node
code:int: the error code of the failure
message:String: the message associated with the exception, or null if there is no error message
causes:Vector<? extends Throwable>: the list of originating exceptions, or empty list or null if there are no originating exceptions
fatal:boolean: whether the exception is fatal

Method Detail

getCause back to summary

getCause	back to summary
public Throwable getCause() Overrides java.lang.Throwable.getCause. Get the cause of this exception. Returns non-`null`, if this exception is caused by one or more other exceptions (like a `NullPointerException` in a DmtPlugin). If there are more than one cause exceptions, the first one is returned. Returns:Throwable the cause of this exception, or `null` if no cause was given Annotations @Override

public Throwable getCause()

Overrides java.lang.Throwable.getCause.

Get the cause of this exception. Returns non-null, if this exception is caused by one or more other exceptions (like a NullPointerException in a DmtPlugin). If there are more than one cause exceptions, the first one is returned.

Returns:Throwable

the cause of this exception, or null if no cause was given

Annotations

@Override

getCauses	back to summary
public Throwable[] getCauses() Get all causes of this exception. Returns the causing exceptions in an array. If no cause was specified, an empty array is returned. Returns:Throwable[] the list of causes of this exception

getCauses

back to summary

public Throwable[] getCauses()

Get all causes of this exception. Returns the causing exceptions in an array. If no cause was specified, an empty array is returned.

Returns:Throwable[]: the list of causes of this exception

getCode	back to summary
public int getCode() Get the error code associated with this exception. Most of the error codes within this exception correspond to OMA DM error codes. Returns:int the error code

getCode

back to summary

public int getCode()

Get the error code associated with this exception. Most of the error codes within this exception correspond to OMA DM error codes.

Returns:int: the error code

getCodeText	back to summary
private static String getCodeText(int code) Returns the name of the given error code. Parameters code:int the error code Returns:String a string containing the error code name

getCodeText

back to summary

private static String getCodeText(int code)

Returns the name of the given error code.

Parameters

code:int: the error code

Returns:String

a string containing the error code name

getMessage back to summary

getMessage	back to summary
public String getMessage() Overrides java.lang.Throwable.getMessage. Get the message associated with this exception. The returned string also contains the associated URI (if any) and the exception code. The resulting message has the following format (parts in square brackets are only included if the field inside them is not `null`): <exception_code>[: '<uri>'][: <error_message>] Returns:String the error message in the format described above Annotations @Override

public String getMessage()

Overrides java.lang.Throwable.getMessage.

Get the message associated with this exception. The returned string also contains the associated URI (if any) and the exception code. The resulting message has the following format (parts in square brackets are only included if the field inside them is not null):

 <exception_code>[: '<uri>'][: <error_message>]

Returns:String

the error message in the format described above

Annotations

@Override

getURI back to summary

getURI	back to summary
public String getURI() Get the node on which the failed DMT operation was issued. Some operations like `DmtSession.close()` don't require an URI, in this case this method returns `null`. Returns:String the URI of the node, or `null`

public String getURI()

Get the node on which the failed DMT operation was issued. Some operations like DmtSession.close() don't require an URI, in this case this method returns null.

Returns:String: the URI of the node, or null

isFatal	back to summary
public boolean isFatal() Check whether this exception is marked as fatal in the session. Fatal exceptions trigger an automatic rollback of atomic sessions. Returns:boolean whether the exception is marked as fatal

isFatal

back to summary

public boolean isFatal()

Check whether this exception is marked as fatal in the session. Fatal exceptions trigger an automatic rollback of atomic sessions.

Returns:boolean: whether the exception is marked as fatal

pathToUri	back to summary
pack-priv static String pathToUri(String[] path) Converts the given path, given as an array of path segments, to a single URI string. Parameters path:String[] the path to convert Returns:String the URI string representing the same node as the given path

pathToUri

back to summary

pack-priv static String pathToUri(String[] path)

Converts the given path, given as an array of path segments, to a single URI string.

Parameters

path:String[]: the path to convert

Returns:String

the URI string representing the same node as the given path

printStackTrace back to summary

printStackTrace	back to summary
public void printStackTrace(PrintStream s) Overrides java.lang.Throwable.printStackTrace. Prints the exception and its stacktrace to the specified print stream. Any causes that were specified for this exception are also printed, together with their stacktraces. Parameters s:PrintStream `PrintStream` to use for output Annotations @Override

public void printStackTrace(PrintStream s)

Overrides java.lang.Throwable.printStackTrace.

Prints the exception and its stacktrace to the specified print stream. Any causes that were specified for this exception are also printed, together with their stacktraces.

Parameters

s:PrintStream: PrintStream to use for output

Annotations

@Override

public Class DmtException

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail