001/* 002 * Copyright 2013-2020 Ping Identity Corporation 003 * All Rights Reserved. 004 */ 005/* 006 * Copyright 2013-2020 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) 2015-2020 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.ThreadSafety; 042import com.unboundid.util.ThreadSafetyLevel; 043 044 045 046/** 047 * This class provides a data structure that holds information about a log 048 * message that may appear in the Directory Server access log about the result 049 * of replication assurance processing for a modify operation. 050 * <BR> 051 * <BLOCKQUOTE> 052 * <B>NOTE:</B> This class, and other classes within the 053 * {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only 054 * supported for use against Ping Identity, UnboundID, and 055 * Nokia/Alcatel-Lucent 8661 server products. These classes provide support 056 * for proprietary functionality or for external specifications that are not 057 * considered stable or mature enough to be guaranteed to work in an 058 * interoperable way with other types of LDAP servers. 059 * </BLOCKQUOTE> 060 */ 061@NotMutable() 062@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE) 063public final class ModifyAssuranceCompletedAccessLogMessage 064 extends ModifyResultAccessLogMessage 065{ 066 /** 067 * The serial version UID for this serializable class. 068 */ 069 private static final long serialVersionUID = 1982817962245777787L; 070 071 072 073 // Indicates whether the local assurance requirement was satisfied. 074 private final Boolean localAssuranceSatisfied; 075 076 // Indicates whether the remote assurance requirement was satisfied. 077 private final Boolean remoteAssuranceSatisfied; 078 079 // A string with information about the per-server assurance results. 080 private final String serverAssuranceResults; 081 082 083 084 /** 085 * Creates a new modify assurance complete access log message from the 086 * provided message string. 087 * 088 * @param s The string to be parsed as an modify assurance complete access 089 * log message. 090 * 091 * @throws LogException If the provided string cannot be parsed as a valid 092 * log message. 093 */ 094 public ModifyAssuranceCompletedAccessLogMessage(final String s) 095 throws LogException 096 { 097 this(new LogMessage(s)); 098 } 099 100 101 102 /** 103 * Creates a new modify assurance complete access log message from the 104 * provided message string. 105 * 106 * @param m The log message to be parsed as an modify assurance complete 107 * access log message. 108 */ 109 public ModifyAssuranceCompletedAccessLogMessage(final LogMessage m) 110 { 111 super(m); 112 113 localAssuranceSatisfied = getNamedValueAsBoolean("localAssuranceSatisfied"); 114 remoteAssuranceSatisfied = 115 getNamedValueAsBoolean("remoteAssuranceSatisfied"); 116 serverAssuranceResults = getNamedValue("serverAssuranceResults"); 117 } 118 119 120 121 /** 122 * Indicates whether the local assurance requirement was satisfied. 123 * 124 * @return {@code true} if the local assurance requirement was satisfied, 125 * {@code false} if the local assurance requirement was not 126 * satisfied, or {@code null} if it was not included in the log 127 * message. 128 */ 129 public Boolean getLocalAssuranceSatisfied() 130 { 131 return localAssuranceSatisfied; 132 } 133 134 135 136 /** 137 * Indicates whether the remote assurance requirement was satisfied. 138 * 139 * @return {@code true} if the remote assurance requirement was satisfied, 140 * {@code false} if the remote assurance requirement was not 141 * satisfied, or {@code null} if it was not included in the log 142 * message. 143 */ 144 public Boolean getRemoteAssuranceSatisfied() 145 { 146 return remoteAssuranceSatisfied; 147 } 148 149 150 151 /** 152 * Retrieves information about the assurance processing performed by 153 * individual servers in the replication environment. 154 * 155 * @return Information about the assurance processing performed by 156 * individual servers in the replication environment, or 157 * {@code null} if it was not included in the log message. 158 */ 159 public String getServerAssuranceResults() 160 { 161 return serverAssuranceResults; 162 } 163 164 165 166 /** 167 * {@inheritDoc} 168 */ 169 @Override() 170 public AccessLogMessageType getMessageType() 171 { 172 return AccessLogMessageType.ASSURANCE_COMPLETE; 173 } 174}