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