001/*
002 * Copyright 2009-2020 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2009-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 a bind
049 * request that was forwarded to a backend server but did not complete
050 * successfully.
051 * <BR>
052 * <BLOCKQUOTE>
053 *   <B>NOTE:</B>  This class, and other classes within the
054 *   {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only
055 *   supported for use against Ping Identity, UnboundID, and
056 *   Nokia/Alcatel-Lucent 8661 server products.  These classes provide support
057 *   for proprietary functionality or for external specifications that are not
058 *   considered stable or mature enough to be guaranteed to work in an
059 *   interoperable way with other types of LDAP servers.
060 * </BLOCKQUOTE>
061 */
062@NotMutable()
063@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
064public final class BindForwardFailedAccessLogMessage
065       extends BindRequestAccessLogMessage
066{
067  /**
068   * The serial version UID for this serializable class.
069   */
070  private static final long serialVersionUID = 7263735957370555432L;
071
072
073
074  // The numeric result code for the failure.
075  private final Integer resultCode;
076
077  // The port of the backend server to which the request has been forwarded.
078  private final Integer targetPort;
079
080  // The diagnostic message for the failure.
081  private final String message;
082
083  // The address of the backend server to which the request has been forwarded.
084  private final String targetHost;
085
086  // The protocol used to forward the request to the backend server.
087  private final String targetProtocol;
088
089
090
091  /**
092   * Creates a new bind forward failed access log message from the provided
093   * message string.
094   *
095   * @param  s  The string to be parsed as a bind forward failed access log
096   *            message.
097   *
098   * @throws  LogException  If the provided string cannot be parsed as a valid
099   *                        log message.
100   */
101  public BindForwardFailedAccessLogMessage(final String s)
102         throws LogException
103  {
104    this(new LogMessage(s));
105  }
106
107
108
109  /**
110   * Creates a new bind forward failed access log message from the provided log
111   * message.
112   *
113   * @param  m  The log message to be parsed as a bind forward failed access log
114   *            message.
115   */
116  public BindForwardFailedAccessLogMessage(final LogMessage m)
117  {
118    super(m);
119
120    targetHost     = getNamedValue("targetHost");
121    targetPort     = getNamedValueAsInteger("targetPort");
122    targetProtocol = getNamedValue("targetProtocol");
123    resultCode     = getNamedValueAsInteger("resultCode");
124    message        = getNamedValue("message");
125  }
126
127
128
129  /**
130   * Retrieves the address of the backend server to which the request has been
131   * forwarded.
132   *
133   * @return  The address of the backend server to which the request has been
134   *          forwarded, or {@code null} if it is not included in the log
135   *          message.
136   */
137  public String getTargetHost()
138  {
139    return targetHost;
140  }
141
142
143
144  /**
145   * Retrieves the port of the backend server to which the request has been
146   * forwarded.
147   *
148   * @return  The port of the backend server to which the request has been
149   *          forwarded, or {@code null} if it is not included in the log
150   *          message.
151   */
152  public Integer getTargetPort()
153  {
154    return targetPort;
155  }
156
157
158
159  /**
160   * Retrieves the protocol used to forward the request to the backend server.
161   *
162   * @return  The protocol used to forward the request to the backend server, or
163   *          {@code null} if it is not included in the log message.
164   */
165  public String getTargetProtocol()
166  {
167    return targetProtocol;
168  }
169
170
171
172  /**
173   * Retrieves the result code received for the forwarded operation.
174   *
175   * @return  The result code received for the forwarded operation, or
176   *          {@code null} if it is not included in the log message.
177   */
178  public Integer getResultCode()
179  {
180    return resultCode;
181  }
182
183
184
185  /**
186   * Retrieves the diagnostic message received for the forwarded operation.
187   *
188   * @return  The diagnostic message received for the forwarded operation, or
189   *          {@code null} if it is not included in the log message.
190   */
191  public String getDiagnosticMessage()
192  {
193    return message;
194  }
195
196
197
198  /**
199   * {@inheritDoc}
200   */
201  @Override()
202  public AccessLogMessageType getMessageType()
203  {
204    return AccessLogMessageType.FORWARD_FAILED;
205  }
206}