/*
 * Copyright 2022-2024 Ping Identity Corporation
 * All Rights Reserved.
 */
/*
 * Copyright 2022-2024 Ping Identity Corporation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
/*
 * Copyright (C) 2022-2024 Ping Identity Corporation
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License (GPLv2 only)
 * or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, see <http://www.gnu.org/licenses>.
 */
package com.unboundid.ldap.sdk.unboundidds.logs.v2.text;



import java.util.List;
import java.util.Set;

import com.unboundid.ldap.sdk.ResultCode;
import com.unboundid.ldap.sdk.unboundidds.logs.AccessLogMessageType;
import com.unboundid.ldap.sdk.unboundidds.logs.LogException;
import com.unboundid.ldap.sdk.unboundidds.logs.v2.BindResultAccessLogMessage;
import com.unboundid.util.NotMutable;
import com.unboundid.util.NotNull;
import com.unboundid.util.Nullable;
import com.unboundid.util.ThreadSafety;
import com.unboundid.util.ThreadSafetyLevel;



/**
 * This class provides a data structure that holds information about a
 * text-formatted bind result access log message.
 * <BR>
 * <BLOCKQUOTE>
 *   <B>NOTE:</B>  This class, and other classes within the
 *   {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only
 *   supported for use against Ping Identity, UnboundID, and
 *   Nokia/Alcatel-Lucent 8661 server products.  These classes provide support
 *   for proprietary functionality or for external specifications that are not
 *   considered stable or mature enough to be guaranteed to work in an
 *   interoperable way with other types of LDAP servers.
 * </BLOCKQUOTE>
 */
@NotMutable()
@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
public final class TextFormattedBindResultAccessLogMessage
       extends TextFormattedBindRequestAccessLogMessage
       implements BindResultAccessLogMessage
{
  /**
   * The serial version UID for this serializable class.
   */
  private static final long serialVersionUID = 3250258313916133793L;



  // Indicates whether a retired password was used for the bind operation.
  @Nullable private final Boolean retiredPasswordUsed;

  // The authentication failure ID for this access log message.
  @Nullable private final Long authenticationFailureID;

  // The authentication DN for this access log message.
  @Nullable private final String authenticationDN;

  // The authentication failure message for this access log message.
  @Nullable private final String authenticationFailureMessage;

  // The authentication failure name for this access log message.
  @Nullable private final String authenticationFailureName;

  // The authorization DN for this access log message.
  @Nullable private final String authorizationDN;

  // The client connection policy name for this access log message.
  @Nullable private final String clientConnectionPolicy;

  // The forward helper for this access log message.
  @NotNull private final TextFormattedForwardAccessLogMessageHelper
       forwardHelper;

  // The result helper for this access log message.
  @NotNull private final TextFormattedResultAccessLogMessageHelper
       resultHelper;



  /**
   * Creates a new text-formatted bind result access log message from the
   * provided message string.
   *
   * @param  logMessageString  The string representation of this log message.
   *                           It must not be {@code null}.
   *
   * @throws  LogException  If the provided string cannot be parsed as a valid
   *                        log message.
   */
  public TextFormattedBindResultAccessLogMessage(
              @NotNull final String logMessageString)
         throws LogException
  {
    this(new TextFormattedLogMessage(logMessageString));
  }



  /**
   * Creates a new text-formatted bind result access log message from the
   * provided message.
   *
   * @param  logMessage  The log message to use to create this bind result
   *                     access log message.  It must not be {@code null}.
   */
  TextFormattedBindResultAccessLogMessage(
       @NotNull final TextFormattedLogMessage logMessage)
  {
    super(logMessage);

    authenticationDN =
         getString(TextFormattedAccessLogFields.BIND_AUTHENTICATION_DN);
    authorizationDN =
         getString(TextFormattedAccessLogFields.BIND_AUTHORIZATION_DN);
    retiredPasswordUsed = getBooleanNoThrow(
         TextFormattedAccessLogFields.BIND_RETIRED_PASSWORD_USED);
    clientConnectionPolicy =
         getString(TextFormattedAccessLogFields.CLIENT_CONNECTION_POLICY);
    authenticationFailureID = getLongNoThrow(
         TextFormattedAccessLogFields.BIND_AUTHENTICATION_FAILURE_ID);
    authenticationFailureName = getString(
         TextFormattedAccessLogFields.BIND_AUTHENTICATION_FAILURE_NAME);
    authenticationFailureMessage = getString(
         TextFormattedAccessLogFields.BIND_AUTHENTICATION_FAILURE_REASON);

    resultHelper = new TextFormattedResultAccessLogMessageHelper(this);
    forwardHelper = new TextFormattedForwardAccessLogMessageHelper(this);
  }



  /**
   * {@inheritDoc}
   */
  @Override()
  @NotNull()
  public AccessLogMessageType getMessageType()
  {
    return AccessLogMessageType.RESULT;
  }



  /**
   * {@inheritDoc}
   */
  @Override()
  @Nullable()
  public ResultCode getResultCode()
  {
    return resultHelper.getResultCode();
  }



  /**
   * {@inheritDoc}
   */
  @Override()
  @Nullable()
  public String getDiagnosticMessage()
  {
    return resultHelper.getDiagnosticMessage();
  }



  /**
   * {@inheritDoc}
   */
  @Override()
  @Nullable()
  public String getAdditionalInformation()
  {
    return resultHelper.getAdditionalInformation();
  }



  /**
   * {@inheritDoc}
   */
  @Override()
  @Nullable()
  public String getMatchedDN()
  {
    return resultHelper.getMatchedDN();
  }



  /**
   * {@inheritDoc}
   */
  @Override()
  @NotNull()
  public List<String> getReferralURLs()
  {
    return resultHelper.getReferralURLs();
  }



  /**
   * {@inheritDoc}
   */
  @Override()
  @Nullable()
  public Double getProcessingTimeMillis()
  {
    return resultHelper.getProcessingTimeMillis();
  }



  /**
   * {@inheritDoc}
   */
  @Override()
  @Nullable()
  public Double getWorkQueueWaitTimeMillis()
  {
    return resultHelper.getWorkQueueWaitTimeMillis();
  }



  /**
   * {@inheritDoc}
   */
  @Override()
  @NotNull()
  public Set<String> getResponseControlOIDs()
  {
    return resultHelper.getResponseControlOIDs();
  }



  /**
   * {@inheritDoc}
   */
  @Override()
  @Nullable()
  public Long getIntermediateResponsesReturned()
  {
    return resultHelper.getIntermediateResponsesReturned();
  }



  /**
   * {@inheritDoc}
   */
  @Override()
  @NotNull()
  public List<String> getServersAccessed()
  {
    return resultHelper.getServersAccessed();
  }



  /**
   * {@inheritDoc}
   */
  @Override()
  @Nullable()
  public Boolean getUncachedDataAccessed()
  {
    return resultHelper.getUncachedDataAccessed();
  }



  /**
   * {@inheritDoc}
   */
  @Override()
  @NotNull()
  public Set<String> getUsedPrivileges()
  {
    return resultHelper.getUsedPrivileges();
  }



  /**
   * {@inheritDoc}
   */
  @Override()
  @NotNull()
  public Set<String> getPreAuthorizationUsedPrivileges()
  {
    return resultHelper.getPreAuthorizationUsedPrivileges();
  }



  /**
   * {@inheritDoc}
   */
  @Override()
  @NotNull()
  public Set<String> getMissingPrivileges()
  {
    return resultHelper.getMissingPrivileges();
  }



  /**
   * Retrieves a string representation of an intermediate client response
   * control included in the log message.
   *
   * @return  A string representation of an intermediate client response control
   *          included in the log message, or {@code null} if there is none.
   */
  @Nullable()
  public String getIntermediateClientResponseControl()
  {
    return resultHelper.getIntermediateClientResponseControl();
  }



  /**
   * {@inheritDoc}
   */
  @Override()
  @Nullable()
  public String getTargetHost()
  {
    return forwardHelper.getTargetHost();
  }



  /**
   * {@inheritDoc}
   */
  @Override()
  @Nullable()
  public Integer getTargetPort()
  {
    return forwardHelper.getTargetPort();
  }



  /**
   * {@inheritDoc}
   */
  @Override()
  @Nullable()
  public String getTargetProtocol()
  {
    return forwardHelper.getTargetProtocol();
  }



  /**
   * {@inheritDoc}
   */
  @Override()
  @Nullable()
  public String getAuthenticationDN()
  {
    return authenticationDN;
  }



  /**
   * {@inheritDoc}
   */
  @Override()
  @Nullable()
  public String getAuthorizationDN()
  {
    return authorizationDN;
  }



  /**
   * {@inheritDoc}
   */
  @Override()
  @Nullable()
  public Long getAuthenticationFailureID()
  {
    return authenticationFailureID;
  }



  /**
   * {@inheritDoc}
   */
  @Override()
  @Nullable()
  public String getAuthenticationFailureName()
  {
    return authenticationFailureName;
  }



  /**
   * {@inheritDoc}
   */
  @Override()
  @Nullable()
  public String getAuthenticationFailureMessage()
  {
    return authenticationFailureMessage;
  }



  /**
   * {@inheritDoc}
   */
  @Override()
  @Nullable()
  public Boolean getRetiredPasswordUsed()
  {
    return retiredPasswordUsed;
  }



  /**
   * {@inheritDoc}
   */
  @Override()
  @Nullable()
  public String getClientConnectionPolicy()
  {
    return clientConnectionPolicy;
  }
}