001/*
002 * Copyright 2022 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2022 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) 2022 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.v2.json;
037
038
039
040import java.util.List;
041
042import com.unboundid.ldap.sdk.unboundidds.logs.AccessLogMessageType;
043import com.unboundid.ldap.sdk.unboundidds.logs.LogException;
044import com.unboundid.ldap.sdk.unboundidds.logs.v2.
045            ModifyAssuranceCompletedAccessLogMessage;
046import com.unboundid.util.NotMutable;
047import com.unboundid.util.NotNull;
048import com.unboundid.util.Nullable;
049import com.unboundid.util.ThreadSafety;
050import com.unboundid.util.ThreadSafetyLevel;
051import com.unboundid.util.json.JSONObject;
052
053
054
055/**
056 * This class provides a data structure that holds information about a
057 * JSON-formatted modify assurance completed access log message.
058 * <BR>
059 * <BLOCKQUOTE>
060 *   <B>NOTE:</B>  This class, and other classes within the
061 *   {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only
062 *   supported for use against Ping Identity, UnboundID, and
063 *   Nokia/Alcatel-Lucent 8661 server products.  These classes provide support
064 *   for proprietary functionality or for external specifications that are not
065 *   considered stable or mature enough to be guaranteed to work in an
066 *   interoperable way with other types of LDAP servers.
067 * </BLOCKQUOTE>
068 */
069@NotMutable()
070@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
071public final class JSONModifyAssuranceCompletedAccessLogMessage
072       extends JSONModifyResultAccessLogMessage
073       implements ModifyAssuranceCompletedAccessLogMessage
074{
075  /**
076   * The serial version UID for this serializable class.
077   */
078  private static final long serialVersionUID = -7689554443848526274L;
079
080
081
082  // The assurance complete helper for this access log message.
083  @NotNull private final JSONAssuranceCompletedAccessLogMessageHelper
084       assuranceCompletedHelper;
085
086
087
088  /**
089   * Creates a new JSON modify assurance completed access log message from the
090   * provided JSON object.
091   *
092   * @param  jsonObject  The JSON object that contains an encoded representation
093   *                     of this log message.  It must not be {@code null}.
094   *
095   * @throws  LogException  If the provided JSON object cannot be parsed as a
096   *                        valid log message.
097   */
098  public JSONModifyAssuranceCompletedAccessLogMessage(
099              @NotNull final JSONObject jsonObject)
100         throws LogException
101  {
102    super(jsonObject);
103
104    assuranceCompletedHelper =
105         new JSONAssuranceCompletedAccessLogMessageHelper(this);
106  }
107
108
109
110  /**
111   * {@inheritDoc}
112   */
113  @Override()
114  @NotNull()
115  public AccessLogMessageType getMessageType()
116  {
117    return AccessLogMessageType.ASSURANCE_COMPLETE;
118  }
119
120
121
122  /**
123   * {@inheritDoc}
124   */
125  @Override()
126  @Nullable()
127  public Boolean getLocalAssuranceSatisfied()
128  {
129    return assuranceCompletedHelper.getLocalAssuranceSatisfied();
130  }
131
132
133
134  /**
135   * {@inheritDoc}
136   */
137  @Override()
138  @Nullable()
139  public Boolean getRemoteAssuranceSatisfied()
140  {
141    return assuranceCompletedHelper.getRemoteAssuranceSatisfied();
142  }
143
144
145
146  /**
147   * Retrieves the list of server results.
148   *
149   * @return  The list of server results, or an empty list if it was not
150   *          included in the log message.
151   */
152  @NotNull()
153  public List<JSONAssuredReplicationServerResult> getServerResults()
154  {
155    return assuranceCompletedHelper.getServerResults();
156  }
157}