Package com.spotfire.ws.pub

Class UserDirectoryServiceException

  • All Implemented Interfaces:
    java.io.Serializable
    @WebFault(faultBean="com.spotfire.ws.pub.FaultInfo",
          targetNamespace="http://spotfire.tibco.com/ws/pub/2013/03/faults.xsd")
public final class UserDirectoryServiceException
extends java.lang.Exception
    Exception thrown by the UserDirectoryService.

    Error codes that may be returned:

    • Client.NoSuchPrincipal - No principal with the given name exist
    • Client.PrincipalAlreadyExists - A principal with the specified name already exists, may be returned when creating or renaming a user or group
    • Client.InvalidArgument - One of the arguments is invalid
    • Client.Unauthorized - The caller doesn't have sufficient privileges for the action
    • Client.UnsupportedOperation - The User Directory does not support the attempted operation with its current configuration
    • Server.InternalError - An internal server error (for example a database connection error) occurred
    • Server.TransientError - An internal server error that is likely to be transient occurred, the request may be retried
    Note: Additional error codes may be added in future releases, client implementors should be prepared for this.
    Since:
    5.5
    See Also:
    Serialized Form

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      FaultInfo getFaultInfo()
      Returns a bean that contains additional information about the exception.

      • Methods inherited from class java.lang.Throwable

        addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • UserDirectoryServiceException

        public UserDirectoryServiceException​(java.lang.String message,
                                     FaultInfo faultInfo)
        Creates a new instance.
        Parameters:
        message - a detail message
        faultInfo - the fault info

      • UserDirectoryServiceException

        public UserDirectoryServiceException​(java.lang.String message,
                                     FaultInfo faultInfo,
                                     java.lang.Throwable cause)
        Creates a new instance.
        Parameters:
        message - a detail message
        faultInfo - the fault info
        cause - the cause

    • Method Detail

      • getFaultInfo

        public FaultInfo getFaultInfo()
        Returns a bean that contains additional information about the exception.
        Returns:
        a bean that contains additional information about the exception.