javax.naming: public class: LinkException

javax.naming
public class: LinkException [javadoc | source]

java.lang.Object
   java.lang.Throwable
      java.lang.Exception
         javax.naming.NamingException
            javax.naming.LinkException

All Implemented Interfaces:
Serializable

Direct Known Subclasses:
MalformedLinkException, LinkLoopException

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.

Also see:

Context#lookupLink

LinkRef

author: Rosanna - Lee

author: Scott - Seligman

since: 1.3 -

Field 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. Also see: getLinkResolvedName setLinkResolvedName serial:
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. Also see: getLinkResolvedObj setLinkResolvedObj serial:
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. Also see: getLinkRemainingName setLinkRemainingName serial:
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. Also see: getLinkExplanation setLinkExplanation serial:

Fields inherited from javax.naming.NamingException:
resolvedName, resolvedObj, remainingName, rootException

Fields inherited from java.lang.Exception:
serialVersionUID

Constructor:

Constructor:
public LinkException() { super(); linkResolvedName = null; linkResolvedObj = null; linkRemainingName = null; linkExplanation = null; } Constructs a new instance of LinkException. All the non-link-related and link-related fields are initialized to null.
public LinkException(String explanation) { super(explanation); linkResolvedName = null; linkResolvedObj = null; linkRemainingName = null; linkExplanation = null; } Constructs a new instance of LinkException with an explanation All the other fields are initialized to null. Parameters: `explanation` - A possibly null string containing additional detail about this exception. Also see: java.lang.Throwable#getMessage

 public LinkException() {
        super();
        linkResolvedName = null;
        linkResolvedObj = null;
        linkRemainingName = null;
        linkExplanation = null;
}

Constructs a new instance of LinkException. All the non-link-related and link-related fields are initialized to null.

 public LinkException(String explanation) {
        super(explanation);
        linkResolvedName = null;
        linkResolvedObj = null;
        linkRemainingName = null;
        linkExplanation = null;
}

Constructs a new instance of LinkException with an explanation All the other fields are initialized to null.

Parameters:

explanation - A possibly null string containing additional detail about this exception.

Also see:

java.lang.Throwable#getMessage

Method from javax.naming.LinkException Summary:
getLinkExplanation, getLinkRemainingName, getLinkResolvedName, getLinkResolvedObj, setLinkExplanation, setLinkRemainingName, setLinkResolvedName, setLinkResolvedObj, toString, toString

Methods from javax.naming.NamingException:
appendRemainingComponent, appendRemainingName, getCause, getExplanation, getRemainingName, getResolvedName, getResolvedObj, getRootCause, initCause, setRemainingName, setResolvedName, setResolvedObj, setRootCause, toString, toString

Methods from java.lang.Throwable:
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from javax.naming.LinkException Detail:
public String getLinkExplanation() { return this.linkExplanation; } Retrieves the explanation associated with the problem encounter when resolving a link.
public Name getLinkRemainingName() { return this.linkRemainingName; } Retrieves the remaining unresolved portion of the link name.
public Name getLinkResolvedName() { return this.linkResolvedName; } Retrieves the leading portion of the link name that was resolved successfully.
public Object getLinkResolvedObj() { return this.linkResolvedObj; } Retrieves the object to which resolution was successful. This is the object to which the resolved link name is bound.
public void setLinkExplanation(String msg) { this.linkExplanation = msg; } Sets the explanation associated with the problem encounter when resolving a link.
public void setLinkRemainingName(Name name) { if (name != null) this.linkRemainingName = (Name)(name.clone()); else this.linkRemainingName = null; } 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.
public void setLinkResolvedName(Name name) { if (name != null) { this.linkResolvedName = (Name)(name.clone()); } else { this.linkResolvedName = null; } } 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.
public void setLinkResolvedObj(Object obj) { this.linkResolvedObj = obj; } Sets the link resolved object field of this exception. This indicates the last successfully resolved object of link name.
public String toString() { return super.toString() + "; Link Remaining Name: '" + this.linkRemainingName + "'"; } 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.
public String toString(boolean detail) { if (!detail \|\| this.linkResolvedObj == null) return this.toString(); return this.toString() + "; Link Resolved Object: " + this.linkResolvedObj; } 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.

Method from javax.naming.LinkException Detail:

 public String getLinkExplanation() {
        return this.linkExplanation;
}

Retrieves the explanation associated with the problem encounter when resolving a link.

 public Name getLinkRemainingName() {
        return this.linkRemainingName;
}

Retrieves the remaining unresolved portion of the link name.

 public Name getLinkResolvedName() {
        return this.linkResolvedName;
}

Retrieves the leading portion of the link name that was resolved successfully.

 public Object getLinkResolvedObj() {
        return this.linkResolvedObj;
}

Retrieves the object to which resolution was successful. This is the object to which the resolved link name is bound.

 public  void setLinkExplanation(String msg) {
        this.linkExplanation = msg;
}

Sets the explanation associated with the problem encounter when resolving a link.

 public  void setLinkRemainingName(Name name) {
        if (name != null)
            this.linkRemainingName = (Name)(name.clone());
        else
            this.linkRemainingName = null;
}

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.

 public  void setLinkResolvedName(Name name) {
        if (name != null) {
            this.linkResolvedName = (Name)(name.clone());
        } else {
            this.linkResolvedName = null;
        }
}

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

 public  void setLinkResolvedObj(Object obj) {
        this.linkResolvedObj = obj;
}

Sets the link resolved object field of this exception. This indicates the last successfully resolved object of link name.

 public String toString() {
        return super.toString() + "; Link Remaining Name: '" +
            this.linkRemainingName + "'";
}

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.

 public String toString(boolean detail) {
        if (!detail || this.linkResolvedObj == null)
            return this.toString();
        return this.toString() + "; Link Resolved Object: " +
            this.linkResolvedObj;
}

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.