FileDocCategorySizeDatePackage
LinkException.javaAPI DocJava SE 5 API9897Fri Aug 26 14:57:38 BST 2005javax.naming

LinkException

public class LinkException extends NamingException
This exception is used to describe problems encounter while resolving links. Addition information is added to the base NamingException for pinpointing the problem with the link.

Analogous to how NamingException captures name resolution information, LinkException captures "link"-name resolution information pinpointing the problem encountered while resolving a link. All these fields may be null.

  • Link Resolved Name. Portion of link name that has been resolved.
  • Link Resolved Object. Object to which resolution of link name proceeded.
  • Link Remaining Name. Portion of link name that has not been resolved.
  • Link Explanation. Detail explaining why link resolution failed.

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

author
Rosanna Lee
author
Scott Seligman
version
1.8 03/12/19
see
Context#lookupLink
see
LinkRef
since
1.3

Fields Summary
protected Name
linkResolvedName
Contains the part of the link that has been successfully resolved. It is a composite name and can be null. This field is initialized by the constructors. You should access and manipulate this field through its get and set methods.
protected Object
linkResolvedObj
Contains the object to which resolution of the part of the link was successful. Can be null. This field is initialized by the constructors. You should access and manipulate this field through its get and set methods.
protected Name
linkRemainingName
Contains the remaining link name that has not been resolved yet. It is a composite name and can be null. This field is initialized by the constructors. You should access and manipulate this field through its get and set methods.
protected String
linkExplanation
Contains the exception of why resolution of the link failed. Can be null. This field is initialized by the constructors. You should access and manipulate this field through its get and set methods.
private static final long
serialVersionUID
Use serialVersionUID from JNDI 1.1.1 for interoperability
Constructors Summary
public LinkException(String explanation)
Constructs a new instance of LinkException with an explanation All the other fields are initialized to null.

param
explanation A possibly null string containing additional detail about this exception.
see
java.lang.Throwable#getMessage

	super(explanation);
	linkResolvedName = null;
	linkResolvedObj = null;
	linkRemainingName = null;
	linkExplanation = null;
public LinkException()
Constructs a new instance of LinkException. All the non-link-related and link-related fields are initialized to null.

	super();
	linkResolvedName = null;
	linkResolvedObj = null;
	linkRemainingName = null;
	linkExplanation = null;
Methods Summary
public java.lang.StringgetLinkExplanation()
Retrieves the explanation associated with the problem encounter when resolving a link.

return
The possibly null detail string explaining more about the problem with resolving a link. If null, it means there is no link detail message for this exception.
see
#setLinkExplanation

	return this.linkExplanation;
public javax.naming.NamegetLinkRemainingName()
Retrieves the remaining unresolved portion of the link name.

return
The part of the link name that has not been resolved. It is a composite name. It can be null, which means the link remaining name field has not been set.
see
#setLinkRemainingName

	return this.linkRemainingName;
public javax.naming.NamegetLinkResolvedName()
Retrieves the leading portion of the link name that was resolved successfully.

return
The part of the link name that was resolved successfully. It is a composite name. It can be null, which means the link resolved name field has not been set.
see
#getLinkResolvedObj
see
#setLinkResolvedName

	return this.linkResolvedName;
public java.lang.ObjectgetLinkResolvedObj()
Retrieves the object to which resolution was successful. This is the object to which the resolved link name is bound.

return
The possibly null object that was resolved so far. If null, it means the link resolved object field has not been set.
see
#getLinkResolvedName
see
#setLinkResolvedObj

	return this.linkResolvedObj;
public voidsetLinkExplanation(java.lang.String msg)
Sets the explanation associated with the problem encounter when resolving a link.

param
msg The possibly null detail string explaining more about the problem with resolving a link. If null, it means no detail will be recorded.
see
#getLinkExplanation

	this.linkExplanation = msg;
public voidsetLinkRemainingName(javax.naming.Name name)
Sets the remaining link name field of this exception.

name is a composite name. If the intent is to set this field using a compound name or string, you must "stringify" the compound name, and create a composite name with a single component using the string. You can then invoke this method using the resulting composite name.

A copy of name is made and stored. Subsequent changes to name does not affect the copy in this NamingException and vice versa.

param
name The name to set remaining link name to. This can be null. If null, it sets the remaining name field to null.
see
#getLinkRemainingName

	if (name != null)
	    this.linkRemainingName = (Name)(name.clone());
	else
	    this.linkRemainingName = null;
public voidsetLinkResolvedName(javax.naming.Name name)
Sets the resolved link name field of this exception.

name is a composite name. If the intent is to set this field using a compound name or string, you must "stringify" the compound name, and create a composite name with a single component using the string. You can then invoke this method using the resulting composite name.

A copy of name is made and stored. Subsequent changes to name does not affect the copy in this NamingException and vice versa.

param
name The name to set resolved link name to. This can be null. If null, it sets the link resolved name field to null.
see
#getLinkResolvedName

	if (name != null) {
	    this.linkResolvedName = (Name)(name.clone());
	} else {
	    this.linkResolvedName = null;
	}
public voidsetLinkResolvedObj(java.lang.Object obj)
Sets the link resolved object field of this exception. This indicates the last successfully resolved object of link name.

param
obj The object to set link resolved object to. This can be null. If null, the link resolved object field is set to null.
see
#getLinkResolvedObj

	this.linkResolvedObj = obj;
public java.lang.StringtoString()
Generates the string representation of this exception. This string consists of the NamingException information plus the link's remaining name. This string is used for debugging and not meant to be interpreted programmatically.

return
The non-null string representation of this link exception.

	return super.toString() + "; Link Remaining Name: '" +
	    this.linkRemainingName + "'";
public java.lang.StringtoString(boolean detail)
Generates the string representation of this exception. This string consists of the NamingException information plus the additional information of resolving the link. If 'detail' is true, the string also contains information on the link resolved object. If false, this method is the same as the form of toString() that accepts no parameters. This string is used for debugging and not meant to be interpreted programmatically.

param
detail If true, add information about the link resolved object.
return
The non-null string representation of this link exception.

	if (!detail || this.linkResolvedObj == null)
	    return this.toString();

	return this.toString() + "; Link Resolved Object: " +
	    this.linkResolvedObj;