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