001/*
002 * Copyright 2009-2024 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2009-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) 2009-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 an add
051 * request forwarded to a backend server.
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 AddForwardAccessLogMessage
066       extends AddRequestAccessLogMessage
067{
068  /**
069   * The serial version UID for this serializable class.
070   */
071  private static final long serialVersionUID = 5311495513879603972L;
072
073
074
075  // The port of the backend server to which the request has been forwarded.
076  @Nullable private final Integer targetPort;
077
078  // The address of the backend server to which the request has been forwarded.
079  @Nullable private final String targetHost;
080
081  // The protocol used to forward the request to the backend server.
082  @Nullable private final String targetProtocol;
083
084
085
086  /**
087   * Creates a new add forward access log message from the provided message
088   * string.
089   *
090   * @param  s  The string to be parsed as an add forward access log message.
091   *
092   * @throws  LogException  If the provided string cannot be parsed as a valid
093   *                        log message.
094   */
095  public AddForwardAccessLogMessage(@NotNull final String s)
096         throws LogException
097  {
098    this(new LogMessage(s));
099  }
100
101
102
103  /**
104   * Creates a new add forward access log message from the provided log message.
105   *
106   * @param  m  The log message to be parsed as an add forward access log
107   *            message.
108   */
109  public AddForwardAccessLogMessage(@NotNull final LogMessage m)
110  {
111    super(m);
112
113    targetHost     = getNamedValue("targetHost");
114    targetPort     = getNamedValueAsInteger("targetPort");
115    targetProtocol = getNamedValue("targetProtocol");
116  }
117
118
119
120  /**
121   * Retrieves the address of the backend server to which the request has been
122   * forwarded.
123   *
124   * @return  The address of the backend server to which the request has been
125   *          forwarded, or {@code null} if it is not included in the log
126   *          message.
127   */
128  @Nullable()
129  public String getTargetHost()
130  {
131    return targetHost;
132  }
133
134
135
136  /**
137   * Retrieves the port of the backend server to which the request has been
138   * forwarded.
139   *
140   * @return  The port of the backend server to which the request has been
141   *          forwarded, or {@code null} if it is not included in the log
142   *          message.
143   */
144  @Nullable()
145  public Integer getTargetPort()
146  {
147    return targetPort;
148  }
149
150
151
152  /**
153   * Retrieves the protocol used to forward the request to the backend server.
154   *
155   * @return  The protocol used to forward the request to the backend server, or
156   *          {@code null} if it is not included in the log message.
157   */
158  @Nullable()
159  public String getTargetProtocol()
160  {
161    return targetProtocol;
162  }
163
164
165
166  /**
167   * {@inheritDoc}
168   */
169  @Override()
170  @NotNull()
171  public AccessLogMessageType getMessageType()
172  {
173    return AccessLogMessageType.FORWARD;
174  }
175}