Package com.unboundid.directory.sdk.ds.types

Class PassThroughAuthenticationResult

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Map<java.lang.String,​java.lang.Object> getCustomLogElements()
      Retrieves a map containing name-value pairs for custom elements that should be included in the bind result access log message.
      java.lang.String getDiagnosticMessageForClient()
      Retrieves a diagnostic message that should be included in the response to the client.
      java.lang.String getRemoteUserIdentifier()
      Retrieves an identifier for the user's account in the external service.
      PassThroughAuthenticationResultCode getResultCode()
      Retrieves a result code that provides a general classification for the result of the pass-through authentication attempt.
      void setCustomLogElement​(java.lang.String name, java.lang.Object value)
      Sets a custom name-value pair that should be included in the bind result access log message.
      void setDiagnosticMessageForClient​(java.lang.String diagnosticMessageForClient)
      Sets a diagnostic message that should be included in the response to the client.
      void setRemoteUserIdentifier​(java.lang.String remoteUserIdentifier)
      Sets an identifier for the user's account in the external service.
      java.lang.String toString()
      Retrieves a string representation of this pass-through authentication result.
      void toString​(java.lang.StringBuilder buffer)
      Appends a string representation of this pass-through authentication result to the provided buffer.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • PassThroughAuthenticationResult

        public PassThroughAuthenticationResult​(@NotNull
                                       PassThroughAuthenticationResultCode resultCode)
        Creates a new pass-through authentication result with the provided result code.
        Parameters:
        resultCode - A result code that provides a general classification for the result of the pass-through authentication attempt. It must not be null.

    • Method Detail

      • getResultCode

        @NotNull
public PassThroughAuthenticationResultCode getResultCode()
        Retrieves a result code that provides a general classification for the result of the pass-through authentication attempt.
        Returns:
        A result code that provides a general classification for the result of the pass-through authentication attempt.

      • getRemoteUserIdentifier

        @Nullable
public java.lang.String getRemoteUserIdentifier()
        Retrieves an identifier for the user's account in the external service.
        Returns:
        An identifier for the user's account in the external service, or null if the user could not be identified or no identifier is available.

      • setRemoteUserIdentifier

        public void setRemoteUserIdentifier​(@Nullable
                                    java.lang.String remoteUserIdentifier)
        Sets an identifier for the user's account in the external service.
        Parameters:
        remoteUserIdentifier - An identifier for the user's account in the external service. It may be null if the user could not be identified or if no identifier is available.

      • getDiagnosticMessageForClient

        @Nullable
public java.lang.String getDiagnosticMessageForClient()
        Retrieves a diagnostic message that should be included in the response to the client. If provided, it will also be included in the bind result access log message.
        Returns:
        A diagnostic message that should be included in the response to the client, or null if there should be no client-side diagnostic message.

      • setDiagnosticMessageForClient

        public void setDiagnosticMessageForClient​(@Nullable
                                          java.lang.String diagnosticMessageForClient)
        Sets a diagnostic message that should be included in the response to the client. If provided, it will also be included in the bind result access log message.
        Parameters:
        diagnosticMessageForClient - A diagnostic message that should be included in the response to the client. It may be null if no client diagnostic message should be used.

      • getCustomLogElements

        @NotNull
public java.util.Map<java.lang.String,​java.lang.Object> getCustomLogElements()
        Retrieves a map containing name-value pairs for custom elements that should be included in the bind result access log message.
        Returns:
        A map containing name-value pairs for custom elements that should be included in the bind result access log message. It will not be null but may be empty.

      • setCustomLogElement

        public void setCustomLogElement​(@NotNull
                                java.lang.String name,
                                @Nullable
                                java.lang.Object value)
        Sets a custom name-value pair that should be included in the bind result access log message.
        Parameters:
        name - The name for the log element. It must not be null.
        value - The value for the log element. It may be null if any existing log element with the provided name should be removed.

      • toString

        @NotNull
public java.lang.String toString()
        Retrieves a string representation of this pass-through authentication result.
        Overrides:
        toString in class java.lang.Object
        Returns:
        A string representation of this pass-through authentication result.

      • toString

        public void toString​(@NotNull
                     java.lang.StringBuilder buffer)
        Appends a string representation of this pass-through authentication result to the provided buffer.
        Parameters:
        buffer - The buffer to which the string representation should be appended. It must not be null.