com.crystaldecisions.sdk.exception
Class SDKServerException

java.lang.Object
  AbstractException
      com.crystaldecisions.sdk.exception.SDKException
          com.crystaldecisions.sdk.exception.SDKServerException

Direct Known Subclasses:

SDKServerException.UnknownTrustedAuthUserException

public class SDKServerException
extends SDKException

This class defines an exception thrown due to a server error.

Nested Class Summary

static class

SDKServerException.UnknownTrustedAuthUserException

Nested classes/interfaces inherited from class com.crystaldecisions.sdk.exception.SDKException

SDKException.AlreadyIndexing, SDKException.AmbiguousDestinationUpdate, SDKException.ApplicationObjectCUIDNotSet, SDKException.AuditBatchTooLarge, SDKException.AuditDetailUnsettableError, SDKException.AuditFailure, SDKException.AuditLevelError, SDKException.AuditServiceDisabled, SDKException.CertificateGenerationError, SDKException.CMSDatabaseUnavailable, SDKException.CMSQueryParseException, SDKException.CollectionSizeMismatch, SDKException.CommitError, SDKException.CompromiseWrongKeyState, SDKException.ConfidentialChannelFailed, SDKException.ConfidentialChannelMandatory, SDKException.ConfigurationError, SDKException.ContradictingValues, SDKException.CORBASystem, SDKException.CORBAUser, SDKException.DifferentDeployment, SDKException.DifferentEnterpriseVersion, SDKException.DuplicateDestinationStaticDocument, SDKException.DuplicateEntry, SDKException.DuplicateFormatInfo, SDKException.EmptyQuery, SDKException.EncryptionError, SDKException.EndOfFile, SDKException.ErrorCode, SDKException.EventTypeDisabled, SDKException.EventTypeNotSupported, SDKException.ExceptionWrapper, SDKException.ExpectedOneOfError, SDKException.FailedIndexingTaskException, SDKException.FailedToBuildAxisService, SDKException.FailedToCreateDoc, SDKException.FailToReadFile, SDKException.FailToReadWholeFile, SDKException.FileCommitError, SDKException.FileCopyError, SDKException.FileEncryptionKeyGenerationFailed, SDKException.FileEncryptionStreamFailure, SDKException.FileNotFound, SDKException.FileRead, SDKException.FileReaderError, SDKException.FileRemoveError, SDKException.FileTooLarge, SDKException.FileWrite, SDKException.FileWriterError, SDKException.GenericFileStoreError, SDKException.HanaAuthenticationConfigError, SDKException.HotBackupInvalidValue, SDKException.IndexingFailure, SDKException.IndexNotReady, SDKException.IndexWriteException, SDKException.InfoObjectFileCommitError, SDKException.InstanceNumberError, SDKException.InvalidArg, SDKException.InvalidCMSQuery, SDKException.InvalidCMSSyntax, SDKException.InvalidCopyMode, SDKException.InvalidDestinationDocument, SDKException.InvalidDestinationFormat, SDKException.InvalidDestinationStaticDocument, SDKException.InvalidEventDetail, SDKException.InvalidEventDetailValue, SDKException.InvalidEventType, SDKException.InvalidEventValues, SDKException.InvalidFileError, SDKException.InvalidFilesStructure, SDKException.InvalidHostSpecification, SDKException.InvalidLocale, SDKException.InvalidLogonToken, SDKException.InvalidNewPropertyValueNonNegativeOnly, SDKException.InvalidObjectID, SDKException.InvalidOperation, SDKException.InvalidOperationOnEncryptedFile, SDKException.InvalidPagingIndex, SDKException.InvalidPortError, SDKException.InvalidPublicationConfiguration, SDKException.InvalidRightKind, SDKException.InvalidSearch, SDKException.InvalidType, SDKException.LengthOutOfRange, SDKException.LocaleNotSet, SDKException.MissingEdge, SDKException.MissingProcessingInfo, SDKException.MissingSessionInfo, SDKException.MultipleDocumentKinds, SDKException.MultiplePublicationDocumentsNotSupported, SDKException.NativeError, SDKException.NoRight, SDKException.NoRightChildren, SDKException.NoSearcher, SDKException.NotActiveKeyState, SDKException.NotImplemented, SDKException.ObjectNotFound, SDKException.OCAFramework, SDKException.OperationNotAvailableInThisEnterpriseVersion, SDKException.OriginalObjectHasChanged, SDKException.OutOfRange, SDKException.PageServerError, SDKException.PJSServerShutDown, SDKException.PluginCategory, SDKException.PluginInitialization, SDKException.PluginNotFound, SDKException.PluginNotFoundAtCMS, SDKException.PropagationNotPossible, SDKException.PropertyNotFound, SDKException.PropertyReadOnly, SDKException.PublishingNotSupported, SDKException.PVLNotSet, SDKException.RekeyWrongKeyState, SDKException.ResumeWrongKeyState, SDKException.RightsAdmin, SDKException.SameDeployment, SDKException.SAMLAssertionGenerationFailure, SDKException.SAMLMissingSPRequiredUserProperty, SDKException.SAMLServiceProviderNotFoundByHostAndPort, SDKException.SAMLSLORequestGenerationFailure, SDKException.SAMLTestConnectionFailure, SDKException.SAMLTestConnectionMustBeAdministrator, SDKException.SDKServerExceptionWrapper, SDKException.SearchServiceNotReady, SDKException.SecurityCommitError, SDKException.SecurityError, SDKException.Serialization, SDKException.SerializationError, SDKException.ServerAdminError, SDKException.ServiceAdminError, SDKException.ServiceContainerInUse, SDKException.ServiceDisabled, SDKException.ServiceFailure, SDKException.ServiceInUse, SDKException.ServiceNotFound, SDKException.ServiceNotSupported, SDKException.SignatureGenerationFailure, SDKException.StreamRead, SDKException.StreamSeekError, SDKException.StreamWorkIntegrationConfigError, SDKException.StreamWorkIntegrationDisabled, SDKException.StreamWrite, SDKException.SuspendWrongKeyState, SDKException.TimeOut, SDKException.TrustedPrincipalConfigError, SDKException.Unexpected, SDKException.UnexpectedValue, SDKException.UnsupportedEnterpriseVersion, SDKException.URIFormat, SDKException.VISISessionAcquiringException, SDKException.WinADNotSupported

Method Summary

java.lang.String	constructErrorMessage(java.util.ResourceBundle bundle, java.util.Locale locale, java.lang.String strID)
java.lang.String	getDetail() Deprecated. As of version 12.0. Use the SDKServerException.getDetailMessage(Locale locale) method instead.
java.lang.String	getDetailMessage(java.util.Locale locale) Returns the detailed error message used for diagnosis.
int	getErrorCode() Deprecated. As of version 12.0. Use the SDKServerException.getErrorCodeString() method instead.
java.lang.String	getErrorCodeString() Returns the exception code string of this exception.
int	getFailedObjectID() Return the ID of the object which caused the failure in an IInfoStore.commit operation.
java.lang.String	getMessage(java.util.Locale locale) Returns the localized error message for this throwable object.
static SDKException	map(oca_abuse e) Map an oca_abuse exception to the appropriate SDKServerException.

Methods inherited from class com.crystaldecisions.sdk.exception.SDKException

map, map, map

Methods inherited from class java.lang.Object

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

Method Detail

map

public static SDKException map(oca_abuse e)

Map an oca_abuse exception to the appropriate SDKServerException.

Parameters:

e - The oca_abuse exception to be mapped.

getErrorCode

public int getErrorCode()

Deprecated. As of version 12.0. Use the SDKServerException.getErrorCodeString() method instead.

Returns the server error code retrieved from server exception generated on server side. To retrieve the SDK server exception code that this error code is mapped to, use the getExceptionCode method.

Returns:

An int containing the server error code.

getErrorCodeString

public java.lang.String getErrorCodeString()

Returns the exception code string of this exception.

Refer to the "BI Platform Servers (FWB) Error Messages" section in the Error Message Explained guide for a complete list of all BusinessObjects Enterprise server error codes.

Returns:

The exception code string.

getFailedObjectID

public int getFailedObjectID()

Return the ID of the object which caused the failure in an IInfoStore.commit operation.

Returns:

The ID of the failed object or 0 if not applicable.

getMessage

public java.lang.String getMessage(java.util.Locale locale)

Returns the localized error message for this throwable object. This implementation of the getMessage method builds up the message string using the server's message description.

Parameters:

locale - The locale-specific properties that the message string will use.

Returns:

A String containing the error message string of this Throwable object if it was created with an error message string or null if it was created without an error message string.

getDetail

public java.lang.String getDetail()

Deprecated. As of version 12.0. Use the SDKServerException.getDetailMessage(Locale locale) method instead.

Returns the detailed error message used for diagnosis. The string will contain the message, and nested exceptions if applicable.

Returns:

The detail string.

getDetailMessage

public java.lang.String getDetailMessage(java.util.Locale locale)

Returns the detailed error message used for diagnosis. The string will contain the message, and nested exceptions if applicable.

Returns:

The detail string.

constructErrorMessage

public java.lang.String constructErrorMessage(java.util.ResourceBundle bundle,
                                              java.util.Locale locale,
                                              java.lang.String strID)