com.crystaldecisions.sdk.exception
Class SDKLogonException

java.lang.Object
  extended by AbstractException
      extended by com.crystaldecisions.sdk.exception.SDKException
          extended by com.crystaldecisions.sdk.exception.SDKLogonException

public class SDKLogonException
extends SDKException


Nested Class Summary
 
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
 
Constructor Summary
SDKLogonException(java.lang.String cms, java.lang.Throwable cause)
           
 
Method Summary
 java.lang.String getErrorCodeString()
          Returns the error code of this Exception.
 java.util.List getErrorMessagesFromCMS(java.util.Locale locale)
          Returns the error messages from the CMS
 java.lang.String getMessage(java.util.Locale locale)
           
 java.lang.String toString()
           
 
Methods inherited from class com.crystaldecisions.sdk.exception.SDKException
map, map, map, map
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SDKLogonException

public SDKLogonException(java.lang.String cms,
                         java.lang.Throwable cause)
Method Detail

toString

public java.lang.String toString()

getMessage

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

getErrorCodeString

public java.lang.String getErrorCodeString()
Returns the error code of this Exception. If it cannot be retrieved, returns the error from the cause.


getErrorMessagesFromCMS

public java.util.List getErrorMessagesFromCMS(java.util.Locale locale)
Returns the error messages from the CMS

Parameters:
locale - the locale that the error messages should be formatted in
Returns:
null if the error_cms<port>.log could not be found empty list if error_cms<port>.log could not be read or extended error information is off the list of errors