SDKException (SAP BusinessObjects Business Intelligence Platform Java SDK)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.crystaldecisions.sdk.exception
Class SDKException

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

Direct Known Subclasses:: SDKBatchException, 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.DuplicateEntry, SDKException.EmptyQuery, SDKException.EncryptionError, SDKException.EndOfFile, SDKException.EventTypeDisabled, SDKException.EventTypeNotSupported, SDKException.ExceptionWrapper, SDKException.FailedIndexingTaskException, SDKException.FailedToBuildAxisService, SDKException.FailedToCreateDoc, SDKException.FailToReadFile, SDKException.FailToReadWholeFile, SDKException.FileCopyError, SDKException.FileEncryptionKeyGenerationFailed, SDKException.FileEncryptionStreamFailure, SDKException.FileNotFound, SDKException.FileRead, SDKException.FileReaderError, SDKException.FileRemoveError, SDKException.FileTooLarge, SDKException.FileWrite, SDKException.FileWriterError, SDKException.GenericFileStoreError, SDKException.HotBackupInvalidValue, SDKException.IndexingFailure, SDKException.IndexNotReady, SDKException.IndexWriteException, SDKException.InvalidArg, SDKException.InvalidCMSQuery, SDKException.InvalidCMSSyntax, SDKException.InvalidCopyMode, SDKException.InvalidEventDetail, SDKException.InvalidEventDetailValue, SDKException.InvalidEventType, SDKException.InvalidEventValues, SDKException.InvalidFileError, SDKException.InvalidFilesStructure, SDKException.InvalidLocale, SDKException.InvalidLogonToken, SDKException.InvalidNewPropertyValueNonNegativeOnly, SDKException.InvalidObjectID, SDKException.InvalidOperation, SDKException.InvalidOperationOnEncryptedFile, SDKException.InvalidPagingIndex, SDKException.InvalidPublicationConfiguration, SDKException.InvalidRightKind, SDKException.InvalidSearch, SDKException.InvalidType, SDKException.MissingEdge, SDKException.MissingSessionInfo, 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.RekeyWrongKeyState, SDKException.ResumeWrongKeyState, SDKException.RightsAdmin, SDKException.SameDeployment, SDKException.SAMLAssertionGenerationFailure, SDKException.SAMLSLORequestGenerationFailure, SDKException.SDKServerExceptionWrapper, SDKException.SearchServiceNotReady, SDKException.SecurityError, 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.WinADNotSupported, SDKServerException, URIParserException

public class SDKException
extends AbstractException
extends AbstractException

All exceptions within the SDK are mapped to SDKException. The exception policy is this: Exceptions are caught at the earliest opportunity, mapped to an SDKException and optionally re-thrown. SDK methods should throw only SDKException and nothing else.

Nested Class Summary
`static class`	`SDKException.AlreadyIndexing` This exception is thrown when the Search Service encounters more than one indexing request at a time.
`static class`	`SDKException.AmbiguousDestinationUpdate` This exception is thrown when a conflict arises between using the `ISchedulingInfo.getDestination` and `ISchedulingInfo.getDestinations` methods to access and update a scheduled object's destination information.
`static class`	`SDKException.ApplicationObjectCUIDNotSet` For internal use only.
`static class`	`SDKException.AuditBatchTooLarge` This exception is thrown when a audit batch is too large.
`static class`	`SDKException.AuditDetailUnsettableError`
`static class`	`SDKException.AuditFailure` This exception is thrown when a server fails to audit an event(s).
`static class`	`SDKException.AuditLevelError`
`static class`	`SDKException.AuditServiceDisabled` This exception is thrown when the Audit service is disabled.
`static class`	`SDKException.CertificateGenerationError` This exception is the thrown when SDK failed to generate a X509 certificate
`static class`	`SDKException.CMSDatabaseUnavailable` This exception is thrown when Central Management Server (CMS) database is not available.
`static class`	`SDKException.CMSQueryParseException`
`static class`	`SDKException.CollectionSizeMismatch` Thrown when the number of keys used to upload/download a file set doesn't match the size of the file set.
`static class`	`SDKException.CommitError` This exception is the general class of exceptions produced by errors encountered when committing changes to the repository.
`static class`	`SDKException.CompromiseWrongKeyState` Thrown when a cluster key that is not in deactivated state
`static class`	`SDKException.ConfidentialChannelFailed`
`static class`	`SDKException.ConfidentialChannelMandatory`
`static class`	`SDKException.ConfigurationError` This exception is thrown when an error occurs due to an invalid system property value.
`static class`	`SDKException.ContradictingValues` This exception denotes two properties have contradicting values
`static class`	`SDKException.CORBASystem` This exception wraps a CORBA system exception generated by the transport layer.
`static class`	`SDKException.CORBAUser` This exception wraps a CORBA user exception generated by the underlying transport.
`static class`	`SDKException.DifferentDeployment` This exception is thrown when an operation does not support source and target InfoObjects from different deployments, or cluster.
`static class`	`SDKException.DifferentEnterpriseVersion` This exception is thrown when an operation does not support source and target InfoObjects from different Enterprise versions.
`static class`	`SDKException.DuplicateDestinationStaticDocument` The publication has a destination that contains a duplicate static document.
`static class`	`SDKException.DuplicateEntry` This exception is thrown when a duplicated entry is being added.
`static class`	`SDKException.DuplicateFormatInfo` The publication contains duplicate document format information.
`static class`	`SDKException.EmptyQuery` This exception is thrown when an empty query string is encountered.
`static class`	`SDKException.EncryptionError` This exception is thrown when there is a data encryption or decryption failure.
`static class`	`SDKException.EndOfFile` This exception denotes the end of a file has been reached while trying to read from the file
`static class`	`SDKException.ErrorCode`
`static class`	`SDKException.EventTypeDisabled` This exception is thrown when the auditing event type is disabled.
`static class`	`SDKException.EventTypeNotSupported` This exception is thrown when the event type is not supported.
`static class`	`SDKException.ExceptionWrapper` An exception class that can wrap other SDK exceptions.
`static class`	`SDKException.FailedIndexingTaskException` This exception is thrown when a document fails to be indexed.
`static class`	`SDKException.FailedToBuildAxisService` This exception is thrown when fail to buld Axis service.
`static class`	`SDKException.FailedToCreateDoc` This exception is thrown when Search Service failed to create a doc
`static class`	`SDKException.FailToReadFile` This exception is thrown when a file could not be read from the filePath.
`static class`	`SDKException.FailToReadWholeFile`
`static class`	`SDKException.FileCommitError` This exception thrown when there is a error committing a file to the repository.
`static class`	`SDKException.FileCopyError` This exception is thrown when a file could not be copied on one of the File Repository Servers (FRS).
`static class`	`SDKException.FileEncryptionKeyGenerationFailed` Thrown when a key could not be generated.
`static class`	`SDKException.FileEncryptionStreamFailure` Thrown when an issue encountered while encrypting/decrypting a file/stream.
`static class`	`SDKException.FileNotFound` This exception is thrown when file not found.
`static class`	`SDKException.FileRead` This exception is thrown when a file could not be read from the File Repository Servers (FRS).
`static class`	`SDKException.FileReaderError` This exception is thrown when an error is encountered during a read operation from one of the File Repository Servers (FRS).
`static class`	`SDKException.FileRemoveError` This exception is thrown when a file could not be removed from one of the File Repository Servers (FRS).
`static class`	`SDKException.FileTooLarge` This exception is thrown when a file is larger than max bytes to handle.
`static class`	`SDKException.FileWrite` This exception is thrown when a file could not be written to the File Repository Servers (FRS).
`static class`	`SDKException.FileWriterError` This exception is thrown when an error is encountered during a write operation on one of the File Repository Servers (FRS).
`static class`	`SDKException.GenericFileStoreError` This exception is thrown from file store operation
`static class`	`SDKException.HotBackupInvalidValue`
`static class`	`SDKException.IndexingFailure` This exception is thrown when an object fails to be indexed.
`static class`	`SDKException.IndexNotReady` This exception is thrown when Search Service failed to create a doc
`static class`	`SDKException.IndexWriteException` This exception is thrown when indexed content fails to write the indexing directory.
`static class`	`SDKException.InvalidArg` This exception is thrown when an invalid argument is given to a method.
`static class`	`SDKException.InvalidCMSQuery`
`static class`	`SDKException.InvalidCMSSyntax` This exception denotes the syntax of the CMS name is invalid
`static class`	`SDKException.InvalidCopyMode` This exception is thrown when an invalid copy mode is specified when copying an InfoObject.
`static class`	`SDKException.InvalidDestinationDocument` The publication contains an invalid destination document.
`static class`	`SDKException.InvalidDestinationFormat` The publication contains a destination document with invalid format information.
`static class`	`SDKException.InvalidDestinationStaticDocument` The publication has a destination that contains an invalid static document.
`static class`	`SDKException.InvalidEventDetail` This exception is thrown when trying to enable an invalid audit detail id.
`static class`	`SDKException.InvalidEventDetailValue` This exception is thrown when event detail value is invalid.
`static class`	`SDKException.InvalidEventType` This exception is thrown when trying to enable an invalid audit event id.
`static class`	`SDKException.InvalidEventValues` This exception is thrown when event values are invalid.
`static class`	`SDKException.InvalidFileError` This exception is thrown when calling the `IPublication.refreshProcessingInfo` method after a publication has been scheduled.
`static class`	`SDKException.InvalidFilesStructure` This exception is thrown when the SI_FILES bag of the infoobject has invalid structure.
`static class`	`SDKException.InvalidLocale` This exception is thrown when the locale is invalid.
`static class`	`SDKException.InvalidLogonToken` This exception is thrown when logon wth an invalid token
`static class`	`SDKException.InvalidNewPropertyValueNonNegativeOnly` This exception is thrown when passing in negative values to setter methods that accept only non-negative inputs.
`static class`	`SDKException.InvalidObjectID` This exception is thrown when the object with a particular ID (SI_ID or SI_CUID) cannot be found on the CMS.
`static class`	`SDKException.InvalidOperation` This exception is thrown when trying to perform an invalid or unsupported operation.
`static class`	`SDKException.InvalidOperationOnEncryptedFile` Thrown when the user tries to perform an invalid file operation on an encrypted file.
`static class`	`SDKException.InvalidPagingIndex` This exception is thrown when failed to get valid page indices info, paging cannot continue.
`static class`	`SDKException.InvalidPublicationConfiguration` This exception is the general class of exceptions produced by configuration errors encountered in a publication.
`static class`	`SDKException.InvalidRightKind` This exception is thrown when invalid right kind is found.
`static class`	`SDKException.InvalidSearch` This exception is thrown when a query string is encountered that cannot be parsed.
`static class`	`SDKException.InvalidType` This exception is thrown when the SDK encounters an invalid object type as input.
`static class`	`SDKException.LocaleNotSet` This exception is thrown when trying to access the Locale for a user that does not have his EnterpriseSession Locale set
`static class`	`SDKException.MissingEdge` This exception is thrown when there are missing relationships in the configuration properties of a service.
`static class`	`SDKException.MissingProcessingInfo` The publication contains a schedulable document that is missing processing information.
`static class`	`SDKException.MissingSessionInfo` This exception is thrown if the session information is incomplete
`static class`	`SDKException.MultipleDocumentKinds` This exception is thrown when a publication contains more than one kind of schedulable document.
`static class`	`SDKException.MultiplePublicationDocumentsNotSupported`
`static class`	`SDKException.NativeError` This exception is thrown when a native method call fails.
`static class`	`SDKException.NoRight` This exception is thrown when the logged on user does not have sufficient rights to perform the requested operation.
`static class`	`SDKException.NoRightChildren` This exception is thrown when the logged on user does not have sufficient rights to perform the requested operation on some of the children objects of a given object.
`static class`	`SDKException.NoSearcher` This exception is thrown during a respository search when the Search Service is updating the index.
`static class`	`SDKException.NotActiveKeyState` Thrown when an action is that must be performed on an active key is performed on an inactive key.
`static class`	`SDKException.NotImplemented` This exception is thrown when calling a method that has no implementation.
`static class`	`SDKException.ObjectNotFound` This exception is thrown when the target object cannot be found in the InfoObjects collection.
`static class`	`SDKException.OCAFramework` This exception wraps around a OCAFrameworkException.
`static class`	`SDKException.OperationNotAvailableInThisEnterpriseVersion` This exception is thrown when an operation is not supported by the version of the CMS you are connecting to.
`static class`	`SDKException.OriginalObjectHasChanged` This exception is thrown when the required object has changed since the last query.
`static class`	`SDKException.OutOfRange` This exception is thrown when an input value is out of the expected range
`static class`	`SDKException.PageServerError` This exception is thrown by the PageServerRequester when an error occurs.
`static class`	`SDKException.PJSServerShutDown` This exception is thrown when the Adaptive Processing Server is shutting down.
`static class`	`SDKException.PluginCategory` This exception is thrown when an invalid plugin category is specified.
`static class`	`SDKException.PluginInitialization` This exception is thrown when there is a problem initializing a plugin.
`static class`	`SDKException.PluginNotFound` This exception is thrown when the plugin manager cannot find the requested plugin locally.
`static class`	`SDKException.PluginNotFoundAtCMS` This exception is thrown when the plugin type is unknown at the CMS.
`static class`	`SDKException.PropagationNotPossible` This exception is thrown when a server is added into an incomplete Enterprise node.
`static class`	`SDKException.PropertyNotFound` This exception is thrown when a property is not found in the IInfoObject.
`static class`	`SDKException.PropertyReadOnly` This exception is thrown when trying to modify a read-only IInfoObject property.
`static class`	`SDKException.PublishingNotSupported`
`static class`	`SDKException.PVLNotSet` This exception is thrown when trying to access the Preffered Veiwing Locale for a user that does not have his PVL set
`static class`	`SDKException.RekeyWrongKeyState` Thrown when a cluster key that is not in deactivated state
`static class`	`SDKException.ResumeWrongKeyState` Thrown when a cluster key that is not in the rekey suspended state is being resumed
`static class`	`SDKException.RightsAdmin`
`static class`	`SDKException.SameDeployment` This exception is thrown when an operation does not support source and target InfoObjects from the same deployment, or cluster.
`static class`	`SDKException.SAMLAssertionGenerationFailure`
`static class`	`SDKException.SAMLSLORequestGenerationFailure`
`static class`	`SDKException.SDKServerExceptionWrapper` An exception class that can wrap other SDK server exceptions.
`static class`	`SDKException.SearchServiceNotReady` This exception is thrown when the Search Service is not initialized properly.
`static class`	`SDKException.SecurityCommitError` This exception thrown when there is a error committing changes to the security rights of an object.
`static class`	`SDKException.SecurityError` This exception is thrown by the authentication plugins when an error occurs.
`static class`	`SDKException.Serialization` This is a wrapper for exceptions thrown during serialization.
`static class`	`SDKException.SerializationError` This exception is thrown when serialization fails on a data connection object.
`static class`	`SDKException.ServerAdminError` This exception is thrown when retrieving services from admin encounter an error.
`static class`	`SDKException.ServiceAdminError` This exception is thrown when admin service encounter an error.
`static class`	`SDKException.ServiceContainerInUse` This exception is thrown when an attempt is made to remove a service container from an install while it is in use by a server.
`static class`	`SDKException.ServiceDisabled` This exception is thrown when service is disabled
`static class`	`SDKException.ServiceFailure` This exception is thrown when a service cannot be obtained from a server.
`static class`	`SDKException.ServiceInUse` This exception is thrown when an attempt is made to remove a service from an install while it is in use by a server.
`static class`	`SDKException.ServiceNotFound` This exception is thrown when a service factory could not be loaded.
`static class`	`SDKException.ServiceNotSupported` This exception is thrown if an attempt is made to connect a service to a server and the service container connected to the server does not support this service
`static class`	`SDKException.SignatureGenerationFailure`
`static class`	`SDKException.StreamRead` This exception is thrown when a stream could not be read from the File Repository Servers (FRS).
`static class`	`SDKException.StreamSeekError` This exception is thrown while seeking to a certain position in the stream.
`static class`	`SDKException.StreamWorkIntegrationConfigError`
`static class`	`SDKException.StreamWorkIntegrationDisabled`
`static class`	`SDKException.StreamWrite` This exception is thrown when a stream could not be written to the File Repository Servers (FRS).
`static class`	`SDKException.SuspendWrongKeyState` Thrown when a cluster key that is not in the rekey in process state is being suspended
`static class`	`SDKException.TimeOut` This exception is thrown when an operation times out.
`static class`	`SDKException.TrustedPrincipalConfigError` This exception is thrown when there is an error reading the shared secret from the trusted principal configuration file.
`static class`	`SDKException.Unexpected` This exception is a catch-all for any problems that may occur which are not expected to occur under normal conditions.
`static class`	`SDKException.UnexpectedValue` This exception is thrown when an IInfoObject property contains an unexpected value.
`static class`	`SDKException.UnsupportedEnterpriseVersion` This exception is thrown when making SDK calls with an incompatible Enterprise deployment version.
`static class`	`SDKException.URIFormat` This exception is thrown when a URI query is not of the proper format.
`static class`	`SDKException.WinADNotSupported` This exception is thrown when attempting to use the `com.crystaldecisions.sdk.plugin.authentication.secwinad` plugin without Kerberos enabled.

Method Summary
`static SDKException`	`map(com.crystaldecisions.thirdparty.org.omg.CORBA.SystemException ex)` Deprecated. use specific SDKException instead such as ServiceAdminError
`static SDKException`	`map(com.crystaldecisions.thirdparty.org.omg.CORBA.UserException ex)` Deprecated. use specific SDKException instead
`static SDKException`	`map(oca_abuse ex)` Map server abuse exceptions.
`static SDKException`	`map(OCAFrameworkException ex)` Map OCA framework exceptions.

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Method Detail

map

public static SDKException map(com.crystaldecisions.thirdparty.org.omg.CORBA.SystemException ex)

Deprecated. use specific SDKException instead such as ServiceAdminError

Map CORBA System exceptions.

map

public static SDKException map(com.crystaldecisions.thirdparty.org.omg.CORBA.UserException ex)

Deprecated. use specific SDKException instead

Map CORBA User exceptions.

map

public static SDKException map(oca_abuse ex)

Map server abuse exceptions.

map

public static SDKException map(OCAFrameworkException ex)

Map OCA framework exceptions.