001/*
002 * Copyright 2013-2024 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2013-2024 Ping Identity Corporation
007 *
008 * Licensed under the Apache License, Version 2.0 (the "License");
009 * you may not use this file except in compliance with the License.
010 * You may obtain a copy of the License at
011 *
012 *    http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing, software
015 * distributed under the License is distributed on an "AS IS" BASIS,
016 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
017 * See the License for the specific language governing permissions and
018 * limitations under the License.
019 */
020/*
021 * Copyright (C) 2013-2024 Ping Identity Corporation
022 *
023 * This program is free software; you can redistribute it and/or modify
024 * it under the terms of the GNU General Public License (GPLv2 only)
025 * or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
026 * as published by the Free Software Foundation.
027 *
028 * This program is distributed in the hope that it will be useful,
029 * but WITHOUT ANY WARRANTY; without even the implied warranty of
030 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
031 * GNU General Public License for more details.
032 *
033 * You should have received a copy of the GNU General Public License
034 * along with this program; if not, see <http://www.gnu.org/licenses>.
035 */
036package com.unboundid.ldap.sdk.unboundidds.logs;
037
038
039
040import com.unboundid.util.NotMutable;
041import com.unboundid.util.NotNull;
042import com.unboundid.util.Nullable;
043import com.unboundid.util.ThreadSafety;
044import com.unboundid.util.ThreadSafetyLevel;
045
046
047
048/**
049 * This class provides a data structure that holds information about a log
050 * message that may appear in the Directory Server access log about the result
051 * of replication assurance processing for a modify operation.
052 * <BR>
053 * <BLOCKQUOTE>
054 *   <B>NOTE:</B>  This class, and other classes within the
055 *   {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only
056 *   supported for use against Ping Identity, UnboundID, and
057 *   Nokia/Alcatel-Lucent 8661 server products.  These classes provide support
058 *   for proprietary functionality or for external specifications that are not
059 *   considered stable or mature enough to be guaranteed to work in an
060 *   interoperable way with other types of LDAP servers.
061 * </BLOCKQUOTE>
062 */
063@NotMutable()
064@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
065public final class ModifyAssuranceCompletedAccessLogMessage
066       extends ModifyResultAccessLogMessage
067{
068  /**
069   * The serial version UID for this serializable class.
070   */
071  private static final long serialVersionUID = 1982817962245777787L;
072
073
074
075  // Indicates whether the local assurance requirement was satisfied.
076  @Nullable private final Boolean localAssuranceSatisfied;
077
078  // Indicates whether the remote assurance requirement was satisfied.
079  @Nullable private final Boolean remoteAssuranceSatisfied;
080
081  // A string with information about the per-server assurance results.
082  @Nullable private final String serverAssuranceResults;
083
084
085
086  /**
087   * Creates a new modify assurance complete access log message from the
088   * provided message string.
089   *
090   * @param  s  The string to be parsed as an modify assurance complete access
091   *            log message.
092   *
093   * @throws  LogException  If the provided string cannot be parsed as a valid
094   *                        log message.
095   */
096  public ModifyAssuranceCompletedAccessLogMessage(@NotNull final String s)
097         throws LogException
098  {
099    this(new LogMessage(s));
100  }
101
102
103
104  /**
105   * Creates a new modify assurance complete access log message from the
106   * provided message string.
107   *
108   * @param  m  The log message to be parsed as an modify assurance complete
109   *            access log message.
110   */
111  public ModifyAssuranceCompletedAccessLogMessage(@NotNull final LogMessage m)
112  {
113    super(m);
114
115    localAssuranceSatisfied = getNamedValueAsBoolean("localAssuranceSatisfied");
116    remoteAssuranceSatisfied =
117         getNamedValueAsBoolean("remoteAssuranceSatisfied");
118    serverAssuranceResults = getNamedValue("serverAssuranceResults");
119  }
120
121
122
123  /**
124   * Indicates whether the local assurance requirement was satisfied.
125   *
126   * @return  {@code true} if the local assurance requirement was satisfied,
127   *          {@code false} if the local assurance requirement was not
128   *          satisfied, or {@code null} if it was not included in the log
129   *          message.
130   */
131  @Nullable()
132  public Boolean getLocalAssuranceSatisfied()
133  {
134    return localAssuranceSatisfied;
135  }
136
137
138
139  /**
140   * Indicates whether the remote assurance requirement was satisfied.
141   *
142   * @return  {@code true} if the remote assurance requirement was satisfied,
143   *          {@code false} if the remote assurance requirement was not
144   *          satisfied, or {@code null} if it was not included in the log
145   *          message.
146   */
147  @Nullable()
148  public Boolean getRemoteAssuranceSatisfied()
149  {
150    return remoteAssuranceSatisfied;
151  }
152
153
154
155  /**
156   * Retrieves information about the assurance processing performed by
157   * individual servers in the replication environment.
158   *
159   * @return  Information about the assurance processing performed by
160   *          individual servers in the replication environment, or
161   *          {@code null} if it was not included in the log message.
162   */
163  @Nullable()
164  public String getServerAssuranceResults()
165  {
166    return serverAssuranceResults;
167  }
168
169
170
171  /**
172   * {@inheritDoc}
173   */
174  @Override()
175  @NotNull()
176  public AccessLogMessageType getMessageType()
177  {
178    return AccessLogMessageType.ASSURANCE_COMPLETE;
179  }
180}