inspireit.uddi.response.base
Class Result

java.lang.Object
  |
  +--inspireit.uddi.response.base.Result

All Implemented Interfaces:

java.io.Serializable, inspireit.uddi.util.visitors.UDDIElement

public class Result

extends java.lang.Object

implements java.io.Serializable, inspireit.uddi.util.visitors.UDDIElement

Result encapsulates result information part of a DispositionReport. Return codes

The following list of error codes can be returned in the errno values within a dispositionReport response to the API calls defined in UDDI programmer’s reference. The descriptions in this section are general and when used with the specific return information defined in the individual API call descriptions are useful for determining the reason for failures.

• E_authTokenExpired: (10110) signifies that the authentication token information has timed out.
• E_authTokenRequired: (10120) signifies that an invalid authentication token was passed to an API call that requires authentication.
• E_accountLimitExceeded: (10160) signifies that a save request exceeded the quantity limits for a given structure type.
• E_busy: (10400) signifies that the request cannot be processed at the current time.
• E_categorizationNotAllowed: (20100) RETIRED. Used for UDDI Version 1.0 compatibility. Replaced by E_valueNotAllowed in UDDI 2.0 and higher. Restrictions have been placed by the on the types of information that can categorized within a specific taxonomy. The data provided does not conform to the restrictions placed on the category used. Used with categorization only.
• E_fatalError: (10500) signifies that a serious technical error has occurred while processing the request.
• E_invalidKeyPassed: (10210) signifies that the uuid_key value passed did not match with any known key values. The details on the invalid key will be included in the dispositionReport structure.
• E_invalidCategory: (20000) RETIRED. Used for UDDI Version 1.0 compatibility only. Replaced by E_invalidValue in version 2 and higher. Signifies that the given keyValue did not correspond to a category within the taxonomy identified by the tModelKey. Used with categorization only.
• E_invalidURLPassed: (10220) DO NOT USE. Signifies that an error occurred during processing of a save function involving accessing data from a remote URL. The details of the HTTP Get report will be included in the dispositionReport element. Not used in V1 or V2.
• E_keyRetired: (10310) DO NOT USE. Signifies that a uuid_key value passed has been removed from the registry. While the key was once valid as an accessor, and is still possibly valid, the publisher has removed the information referenced by the uuid_key passed. V1 errata – not used. Included here for historical code-set completion.
• E_languageError: (10060) signifies that an error was detected while processing elements that were annotated with xml:lang qualifiers. Presently, only the description element supports xml:lang qualifications.
• E_nameTooLong: (10020) signifies that the partial name value passed exceeds the maximum name length designated by the policy of an implementation or Operator Site.
• E_operatorMismatch: (10130) DO NOT USE. Signifies that an attempt was made to use the publishing API to change data that is mastered at another Operator Site. This error is only relevant to the public Operator Sites and does not apply to other compatible registries. V1 defined this in error – caused precedence problems with E_unknownUser. Included here for historical code set completeness. Retired.
• E_success: (0) signifies no failure occurred. This return code is used with the dispositionReport for reporting results from requests with no natural response document.
• E_tooManyOptions: (10030) signifies that incompatible arguments were passed.
• E_unrecognizedVersion: (10040) signifies that the value of the generic attribute passed is unsupported by the Operator Instance being queried.
• E_unknownUser: (10150) 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.
• E_unsupported: (10050) signifies that the implementer does not support a feature or API.
• E_userMismatch: (10140) signifies that an attempt was made to use the publishing API to change data that is controlled by another party. In certain cases, E_operatorMismatch takes precedence in reporting an error.
• E_assertionNotFound: (30000) 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.
• E_invalidProjection: (20230) 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.
• E_messageTooLarge: (30110) signifies that the message it too large. The upper limit will be clearly indicated in the error text.
• E_invalidCompletionStatus: (30100) 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.
• E_invalidValue: (20200) signifies that 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.
• E_publisherCancelled: (30220) signifies that the target publisher cancelled the custody transfer operation.
• E_requestDenied: (30210) signifies that a custody transfer request has been refused.
• E_secretUnknown: (30230) 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.
• E_transferAborted: (30200) signifies that a custody transfer request will not succeed.
• E_valueNotAllowed: (20210) 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.
• E_unvalidatable: (20220)
• E_requestTimeout: (20240) signifies that the request could not be carried out because a needed web service, such as validate_values, did not respond in a reasonable amount of time.

Author:

Bertrand Fontaine, INSPIRE IT $Revision: 1.2 $

See Also:

Serialized Form

Field Summary

static int	E_accountLimitExceeded Constant for specifying an E_accountLimitExceeded errNo.
static int	E_assertionNotFound Constant for specifying an E_assertionNotFound errNo.
static int	E_authTokenExpired Constant for specifying an E_authTokenExpired errNo.
static int	E_authTokenRequired Constant for specifying an E_authTokenRequired errNo.
static int	E_busy Constant for specifying an E_busy errNo.
static int	E_categorizationNotAllowed Constant for specifying an E_categorizationNotAllowed errNo.
static int	E_fatalError Constant for specifying an E_fatalError errNo.
static int	E_invalidCategory Constant for specifying an E_invalidCategory errNo.
static int	E_invalidCompletionStatus Constant for specifying an E_invalidCompletionStatus errNo.
static int	E_invalidKeyPassed Constant for specifying an E_invalidKeyPassed errNo.
static int	E_invalidProjection Constant for specifying an E_invalidProjection errNo.
static int	E_invalidURLPassed Constant for specifying an E_invalidURLPassed errNo.
static int	E_invalidValue Constant for specifying an E_invalidValue errNo.
static int	E_keyRetired Constant for specifying an E_keyRetired errNo.
static int	E_languageError Constant for specifying an E_languageError errNo.
static int	E_messageTooLarge Constant for specifying an E_messageTollLarge errNo.
static int	E_nameTooLong Constant for specifying an E_nameTooLong errNo.
static int	E_operatorMismatch Constant for specifying an E_operatorMismatch errNo.
static int	E_publisherCancelled Constant for specifying an E_publisherCancelled errNo.
static int	E_requestDenied Constant for specifying an E_requestDenied errNo.
static int	E_requestTimeout Constant for specifying an E_requestTimeout errNo.
static int	E_secretUnknown Constant for specifying an E_secretUnknown errNo.
static int	E_success Constant for specifying an E_success errNo.
static int	E_tooManyOptions Constant for specifying an E_tooManyOptions errNo.
static int	E_transferAborted Constant for specifying an E_transferAborted errNo.
static int	E_unknownUser Constant for specifying an E_unknownUser errNo.
static int	E_unrecognizedVersion Constant for specifying an E_unrecognizedVersion errNo.
static int	E_unsupported Constant for specifying an E_unsupported errNo.
static int	E_unvalidatable Constant for specifying an E_unvalidatable errNo.
static int	E_userMismatch Constant for specifying an E_userMismatch errNo.
static int	E_valueNotAllowed Constant for specifying an E_valueNotAllowed errNo.
protected ErrInfo	errInfo Information on the error.
protected int	errNo The error number.
protected java.lang.String	keyType One of businessKey, tModelKey, serviceKey, bindingKey.

Constructor Summary

Result(java.lang.String keyType, int errNo, ErrInfo errInfo)
Result constructor.

Method Summary

ErrInfo	getErrInfo() Gets information on the error.
int	getErrNo() Gets the error number.
java.lang.String	getKeyType() Gets the key type (one of businessKey, tModelKey, serviceKey, bindingKey).
java.lang.Object	visit(inspireit.uddi.util.visitors.UDDIVisitor visitor) Visits this UDDI element.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

E_authTokenExpired

public static final int E_authTokenExpired

Constant for specifying an E_authTokenExpired errNo.

See Also:

Constant Field Values

E_authTokenRequired

public static final int E_authTokenRequired

Constant for specifying an E_authTokenRequired errNo.

See Also:

Constant Field Values

E_accountLimitExceeded

public static final int E_accountLimitExceeded

Constant for specifying an E_accountLimitExceeded errNo.

See Also:

Constant Field Values

E_busy

public static final int E_busy

Constant for specifying an E_busy errNo.

See Also:

Constant Field Values

E_categorizationNotAllowed

public static final int E_categorizationNotAllowed

Constant for specifying an E_categorizationNotAllowed errNo.

See Also:

Constant Field Values

E_fatalError

public static final int E_fatalError

Constant for specifying an E_fatalError errNo.

See Also:

Constant Field Values

E_invalidKeyPassed

public static final int E_invalidKeyPassed

Constant for specifying an E_invalidKeyPassed errNo.

See Also:

Constant Field Values

E_invalidCategory

public static final int E_invalidCategory

Constant for specifying an E_invalidCategory errNo.

See Also:

Constant Field Values

E_invalidURLPassed

public static final int E_invalidURLPassed

Constant for specifying an E_invalidURLPassed errNo.

See Also:

Constant Field Values

E_keyRetired

public static final int E_keyRetired

Constant for specifying an E_keyRetired errNo.

See Also:

Constant Field Values

E_languageError

public static final int E_languageError

Constant for specifying an E_languageError errNo.

See Also:

Constant Field Values

E_nameTooLong

public static final int E_nameTooLong

Constant for specifying an E_nameTooLong errNo.

See Also:

Constant Field Values

E_operatorMismatch

public static final int E_operatorMismatch

Constant for specifying an E_operatorMismatch errNo.

See Also:

Constant Field Values

E_success

public static final int E_success

Constant for specifying an E_success errNo.

See Also:

Constant Field Values

E_tooManyOptions

public static final int E_tooManyOptions

Constant for specifying an E_tooManyOptions errNo.

See Also:

Constant Field Values

E_unrecognizedVersion

public static final int E_unrecognizedVersion

Constant for specifying an E_unrecognizedVersion errNo.

See Also:

Constant Field Values

E_unknownUser

public static final int E_unknownUser

Constant for specifying an E_unknownUser errNo.

See Also:

Constant Field Values

E_unsupported

public static final int E_unsupported

Constant for specifying an E_unsupported errNo.

See Also:

Constant Field Values

E_userMismatch

public static final int E_userMismatch

Constant for specifying an E_userMismatch errNo.

See Also:

Constant Field Values

E_assertionNotFound

public static final int E_assertionNotFound

Constant for specifying an E_assertionNotFound errNo.

See Also:

Constant Field Values

E_invalidProjection

public static final int E_invalidProjection

Constant for specifying an E_invalidProjection errNo.

See Also:

Constant Field Values

E_messageTooLarge

public static final int E_messageTooLarge

Constant for specifying an E_messageTollLarge errNo.

See Also:

Constant Field Values

E_invalidCompletionStatus

public static final int E_invalidCompletionStatus

Constant for specifying an E_invalidCompletionStatus errNo.

See Also:

Constant Field Values

E_invalidValue

public static final int E_invalidValue

Constant for specifying an E_invalidValue errNo.

See Also:

Constant Field Values

E_publisherCancelled

public static final int E_publisherCancelled

Constant for specifying an E_publisherCancelled errNo.

See Also:

Constant Field Values

E_requestDenied

public static final int E_requestDenied

Constant for specifying an E_requestDenied errNo.

See Also:

Constant Field Values

E_secretUnknown

public static final int E_secretUnknown

Constant for specifying an E_secretUnknown errNo.

See Also:

Constant Field Values

E_transferAborted

public static final int E_transferAborted

Constant for specifying an E_transferAborted errNo.

See Also:

Constant Field Values

E_valueNotAllowed

public static final int E_valueNotAllowed

Constant for specifying an E_valueNotAllowed errNo.

See Also:

Constant Field Values

E_unvalidatable

public static final int E_unvalidatable

Constant for specifying an E_unvalidatable errNo.

See Also:

Constant Field Values

E_requestTimeout

public static final int E_requestTimeout

Constant for specifying an E_requestTimeout errNo.

See Also:

Constant Field Values

keyType

protected java.lang.String keyType

One of businessKey, tModelKey, serviceKey, bindingKey.

errNo

protected int errNo

The error number.

errInfo

protected ErrInfo errInfo

Information on the error.

Constructor Detail

Result

public Result(java.lang.String keyType,
              int errNo,
              ErrInfo errInfo)

Result constructor.

Parameters:

errNo - One of businessKey, tModelKey, serviceKey, bindingKey.

errInfo - The error number.

Method Detail

getKeyType

public java.lang.String getKeyType()

Gets the key type (one of businessKey, tModelKey, serviceKey, bindingKey).

Returns:

the key type

getErrNo

public int getErrNo()

Gets the error number.

Returns:

the error number

getErrInfo

public ErrInfo getErrInfo()

Gets information on the error.

Returns:

information on the error

visit

public java.lang.Object visit(inspireit.uddi.util.visitors.UDDIVisitor visitor)

Visits this UDDI element.

Specified by:

visit in interface inspireit.uddi.util.visitors.UDDIElement

Parameters:

visitor - The visiting UDDI object.