Class DispositionReport

java.lang.Object
org.uddi4j.UDDIElement
org.uddi4j.response.DispositionReport
All Implemented Interfaces:
Serializable

public class DispositionReport extends UDDIElement
Represents an UDDI defined error. This object is returned from certain UDDI API calls. Other UDDI APIs return a data object if success and generate a fault message if failure. The API returns the fault by throwing a UDDIException.

UDDIException usually contains a Disposition report that has detailed information about the UDDI error as defined by the UDDI specification. If the response is a SOAP fault, but does not contains a disposition report, a UDDIException may be thrown without containing a DispositionReport. This class contains defines for the various error values that can be returned.

Author:
David Melgar (dmelgar@us.ibm.com), Ravi Trivedi (ravi_trivedi@hp.com), Ozzy (ozzy@hursley.ibm.com)
See Also:
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    Signifies that user account limits have been exceeded.
    static final String
    Signifies that a particular publisher assertion (consisting of two businessKey values, and a keyed reference with three components) cannot be identified in a save or delete operation.
    static final String
    Signifies that the authentication token value passed in the authInfo argument is no longer valid because the token has expired.
    static final String
    Signifies that the authentication token value passed in the authInfo argument is either missing or is not valid.
    static final String
    Signifies that the request cannot be processed at the current time.
    static final String
    Restrictions have been placed by the taxonomy provider on the types of information that should be included at that location within a specific taxonomy.
    static final String
    Signifies that a serious technical error has occurred while processing the request.
    static final String
    Signifies that the given keyValue did not correspond to a category within the taxonomy identified by a tModelKey value within one of the categoryBag elements provided.
    static final String
    Signifies that one of assertion status values passed is unrecognized.
    static final String
    Signifies that the request cannot be satisfied because one or more uuid_key values specified is not a valid key value.
    static final String
    Signifies that an attempt was made to save a businessEntity containing a service projection that does not match the businessService being projected.
    static final String
    An error occurred with one of the uploadRegister URL values.
    static final String
    A value that was passed in a keyValue attribute did not pass validation.
    static final String
    Signifies that the request cannot be satisfied because one or more uuid_key values specified has previously been hidden or removed by the requester.
    static final String
    Signifies that an error was detected while processing elements that were annotated with xml:lang qualifiers.
    static final String
    Signifies that the message it too large.
    static final String
    Signifies that the partial name value passed exceeds the maximum name length designated by the policy of an implementation or Operator Site.
    static final String
    Signifies that one or more of the uuid_key values passed refers to data that is not controlled by the Operator Site that received the request for processing.
    static final String
    Signifies that the target publisher cancelled the custody transfer operation.
    static final String
    Signifies that a custody transfer request has been refused.
    static final String
    Signifies that the request could not be carried out because a needed validate_values service did not respond in a reasonable amount of time.
    static final String
    Signifies that the target publisher was unable to match the shared secret and the five (5) attempt limit was exhausted.
    static final String
    Signifies no failure occurred.
    static final String
    Signifies that too many or incompatible arguments were passed.
    static final String
    Signifies that a custody transfer request will not succeed.
    static final String
    Signifies that the user ID and password pair passed in a get_authToken message is not known to the Operator Site or is not valid.
    static final String
    Signifies that the value of the generic attribute passed is unsupported by the Operator Instance being queried.
    static final String
    Signifies that the implementer does not support a feature or API.
    static final String
    Signifies that an attempt was made to reference a taxonomy or identifier system in a keyedReference whose tModel is categorized with the unvalidatable categorization.
    static final String
    Signifies that one or more of the uuid_key values passed refers to data that is not controlled by the individual who is represented by the authentication token.
    static final String
    Signifies that a value did not pass validation because of contextual issues.
    static String
     

    Fields inherited from class org.uddi4j.UDDIElement

    base, GENERIC, SOAPNS, XMLNS, XMLNS_PREFIX
  • Constructor Summary

    Constructors
    Constructor
    Description
    Default constructor
    Constructer that parses the XML dom tree and extracts useful attributes.
  • Method Summary

    Modifier and Type
    Method
    Description
    Deprecated.
    This method has been deprecated.
    getErrCode(int index)
    Deprecated.
    This method has been deprecated.
    Deprecated.
    This method has been deprecated.
    getErrInfoText(int index)
    Deprecated.
    This method has been deprecated.
    int
    Deprecated.
    This method has been deprecated.
    int
    getErrno(int index)
    Deprecated.
    This method has been deprecated.
     
    Deprecated.
    This method has been deprecated.
    getKeyType(int index)
    Deprecated.
    This method has been deprecated.
    int
     
     
    Retrieves the Vector containing the Result objects that were present in this DispositionReport.
    boolean
     
    boolean
    Tests the passed in element to determine if the element is a serialized version of this object.
    void
     
    void
    setErrCode(String errCode)
    Deprecated.
    This method has been deprecated.
    void
    setErrCode(String errCode, int index)
    Deprecated.
    This method has been deprecated.
    void
    setErrInfoText(String errInfoText)
    Deprecated.
    This method has been deprecated.
    void
    setErrInfoText(String errInfoText, int index)
    Deprecated.
    This method has been deprecated.
    void
    setErrno(int errno)
    Deprecated.
    This method has been deprecated.
    void
    setErrno(int errno, int index)
    Deprecated.
    This method has been deprecated.
    void
     
    void
    setKeyType(String keyType)
    Deprecated.
    This method has been deprecated.
    void
    setKeyType(String keyType, int index)
    Deprecated.
    This method has been deprecated.
    void
     
    void
    Set the Vector of result objects for this DispositionReport
    void
    setTruncated(boolean t)
     
    boolean
     

    Methods inherited from class org.uddi4j.UDDIElement

    getChildElementsByTagName, getText

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

    • UDDI_TAG

      public static String UDDI_TAG
    • E_assertionNotFound

      public static final String E_assertionNotFound
      Signifies that a particular publisher assertion (consisting of two businessKey values, and a keyed reference with three components) cannot be identified in a save or delete operation.
      See Also:
    • E_authTokenExpired

      public static final String E_authTokenExpired
      Signifies that the authentication token value passed in the authInfo argument is no longer valid because the token has expired.
      See Also:
    • E_authTokenRequired

      public static final String E_authTokenRequired
      Signifies that the authentication token value passed in the authInfo argument is either missing or is not valid.
      See Also:
    • E_accountLimitExceeded

      public static final String E_accountLimitExceeded
      Signifies that user account limits have been exceeded.
      See Also:
    • E_busy

      public static final String E_busy
      Signifies that the request cannot be processed at the current time.
      See Also:
    • E_categorizationNotAllowed

      public static final String E_categorizationNotAllowed
      Restrictions have been placed by the taxonomy provider on the types of information that should be included at that location within a specific taxonomy. The validation routine chosen by the Operator Site has rejected this tModel for at least one specified category.
      See Also:
    • E_fatalError

      public static final String E_fatalError
      Signifies that a serious technical error has occurred while processing the request.
      See Also:
    • E_invalidKeyPassed

      public static final String E_invalidKeyPassed
      Signifies that the request cannot be satisfied because one or more uuid_key values specified is not a valid key value. This will occur if a uuid_key value is passed in a tModel that does not match with any known tModel key.
      See Also:
    • E_invalidProjection

      public static final String E_invalidProjection
      Signifies that an attempt was made to save a businessEntity containing a service projection that does not match the businessService being projected. The serviceKey of at least one such businessService will be included in the dispositionReport
      See Also:
    • E_invalidCategory

      public static final String E_invalidCategory
      Signifies that the given keyValue did not correspond to a category within the taxonomy identified by a tModelKey value within one of the categoryBag elements provided.
      See Also:
    • E_invalidCompletionStatus

      public static final String E_invalidCompletionStatus
      Signifies that one of assertion status values passed is unrecognized. The completion status that caused the problem will be clearly indicated in the error text.
      See Also:
    • E_invalidURLPassed

      public static final String E_invalidURLPassed
      An error occurred with one of the uploadRegister URL values.
      See Also:
    • E_invalidValue

      public static final String E_invalidValue
      A value that was passed in a keyValue attribute did not pass validation. This applies to checked categorizations, identifiers and other validated code lists. The error text will clearly indicate the key and value combination that failed validation.
      See Also:
    • E_keyRetired

      public static final String E_keyRetired
      Signifies that the request cannot be satisfied because one or more uuid_key values specified has previously been hidden or removed by the requester. This specifically applies to the tModelKey values passed.
      See Also:
    • E_languageError

      public static final String E_languageError
      Signifies that an error was detected while processing elements that were annotated with xml:lang qualifiers. Presently, only the description and name elements support xml:lang qualifications.
      See Also:
    • E_messageTooLarge

      public static final String E_messageTooLarge
      Signifies that the message it too large. The upper limit will be clearly indicated in the error text.
      See Also:
    • E_nameTooLong

      public static final String E_nameTooLong
      Signifies that the partial name value passed exceeds the maximum name length designated by the policy of an implementation or Operator Site.
      See Also:
    • E_operatorMismatch

      public static final String E_operatorMismatch
      Signifies that one or more of the uuid_key values passed refers to data that is not controlled by the Operator Site that received the request for processing.
      See Also:
    • E_publisherCancelled

      public static final String E_publisherCancelled
      Signifies that the target publisher cancelled the custody transfer operation.
      See Also:
    • E_requestDenied

      public static final String E_requestDenied
      Signifies that a custody transfer request has been refused.
      See Also:
    • E_requestTimeout

      public static final String E_requestTimeout
      Signifies that the request could not be carried out because a needed validate_values service did not respond in a reasonable amount of time.
      See Also:
    • E_secretUnknown

      public static final String E_secretUnknown
      Signifies that the target publisher was unable to match the shared secret and the five (5) attempt limit was exhausted. The target operator automatically cancelled the transfer operation.
      See Also:
    • E_success

      public static final String E_success
      Signifies no failure occurred. This return code is used with the dispositionReport for reporting results from requests with no natural response document.
      See Also:
    • E_tooManyOptions

      public static final String E_tooManyOptions
      Signifies that too many or incompatible arguments were passed. The error text will clearly indicate the nature of the problem.
      See Also:
    • E_transferAborted

      public static final String E_transferAborted
      Signifies that a custody transfer request will not succeed.
      See Also:
    • E_unrecognizedVersion

      public static final String E_unrecognizedVersion
      Signifies that the value of the generic attribute passed is unsupported by the Operator Instance being queried.
      See Also:
    • E_unknownUser

      public static final String E_unknownUser
      Signifies that the user ID and password pair passed in a get_authToken message is not known to the Operator Site or is not valid.
      See Also:
    • E_unsupported

      public static final String E_unsupported
      Signifies that the implementer does not support a feature or API.
      See Also:
    • E_unvalidatable

      public static final String E_unvalidatable
      Signifies that an attempt was made to reference a taxonomy or identifier system in a keyedReference whose tModel is categorized with the unvalidatable categorization.
      See Also:
    • E_userMismatch

      public static final String E_userMismatch
      Signifies that one or more of the uuid_key values passed refers to data that is not controlled by the individual who is represented by the authentication token.
      See Also:
    • E_valueNotAllowed

      public static final String E_valueNotAllowed
      Signifies that a value did not pass validation because of contextual issues. The value may be valid in some contexts, but not in the context used. The error text may contain information about the contextual problem.
      See Also:
  • Constructor Details

    • DispositionReport

      public DispositionReport()
      Default constructor
    • DispositionReport

      public DispositionReport(Element el) throws UDDIException
      Constructer that parses the XML dom tree and extracts useful attributes.
      Parameters:
      el - Root element of the tree within the SOAP body.
      Throws:
      UDDIException
  • Method Details

    • getTruncated

      public boolean getTruncated()
    • getGeneric

      public String getGeneric()
    • getOperator

      public String getOperator()
    • success

      public boolean success()
    • getErrno

      public int getErrno()
      Deprecated.
      This method has been deprecated. Use getResultVector() then
    • getErrno

      public int getErrno(int index)
      Deprecated.
      This method has been deprecated. Use getResultVector() instead.
    • getErrCode

      public String getErrCode()
      Deprecated.
      This method has been deprecated. Use getResultVector() instead.
    • getErrCode

      public String getErrCode(int index)
      Deprecated.
      This method has been deprecated. Use getResultVector() instead.
    • getErrInfoText

      public String getErrInfoText()
      Deprecated.
      This method has been deprecated. Use getResultVector() instead.
    • getErrInfoText

      public String getErrInfoText(int index)
      Deprecated.
      This method has been deprecated. Use getResultVector() instead.
    • getKeyType

      public String getKeyType()
      Deprecated.
      This method has been deprecated. Use getResultVector() instead.
    • getKeyType

      public String getKeyType(int index)
      Deprecated.
      This method has been deprecated. Use getResultVector() instead.
    • getResultVector

      public Vector getResultVector()
      Retrieves the Vector containing the Result objects that were present in this DispositionReport.
      Returns:
      s Vector the Vector of Result objects.
    • getNumResults

      public int getNumResults()
    • setGeneric

      public void setGeneric(String gen)
    • setOperator

      public void setOperator(String oper)
    • setTruncated

      public void setTruncated(boolean t)
    • setErrno

      public void setErrno(int errno)
      Deprecated.
      This method has been deprecated. Use setResultVector(Vector) instead.
    • setErrno

      public void setErrno(int errno, int index)
      Deprecated.
      This method has been deprecated. Use setResultVector(Vector) instead.
    • setErrCode

      public void setErrCode(String errCode)
      Deprecated.
      This method has been deprecated. Use setResultVector(Vector) instead.
    • setErrCode

      public void setErrCode(String errCode, int index)
      Deprecated.
      This method has been deprecated. Use setResultVector(Vector) instead.
    • setErrInfoText

      public void setErrInfoText(String errInfoText)
      Deprecated.
      This method has been deprecated. Use setResultVector(Vector) instead.
    • setErrInfoText

      public void setErrInfoText(String errInfoText, int index)
      Deprecated.
      This method has been deprecated. Use setResultVector(Vector) instead.
    • setKeyType

      public void setKeyType(String keyType)
      Deprecated.
      This method has been deprecated. Use setResultVector(Vector) instead.
    • setKeyType

      public void setKeyType(String keyType, int index)
      Deprecated.
      This method has been deprecated. Use setResultVector(Vector) instead.
    • setResultVector

      public void setResultVector(Vector rv)
      Set the Vector of result objects for this DispositionReport
      Parameters:
      rv - Vector of Result objects.
    • isValidElement

      public boolean isValidElement(Element el)
      Tests the passed in element to determine if the element is a serialized version of this object.
      Parameters:
      el - Root element for this object
    • saveToXML

      public void saveToXML(Element parent)
      Specified by:
      saveToXML in class UDDIElement