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 a
051 * connection that has been established.
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 ConnectAccessLogMessage
066       extends AccessLogMessage
067{
068  /**
069   * The serial version UID for this serializable class.
070   */
071  private static final long serialVersionUID = 4254346309071273212L;
072
073
074
075  // The name of the client connection policy selected for the client.
076  @Nullable private final String clientConnectionPolicy;
077
078  // The name of the protocol used by the client.
079  @Nullable private final String protocolName;
080
081  // The source address for the client connection.
082  @Nullable private final String sourceAddress;
083
084  // The server address to which the client connection is established.
085  @Nullable private final String targetAddress;
086
087
088
089  /**
090   * Creates a new connect access log message from the provided message string.
091   *
092   * @param  s  The string to be parsed as a connect access log message.
093   *
094   * @throws  LogException  If the provided string cannot be parsed as a valid
095   *                        log message.
096   */
097  public ConnectAccessLogMessage(@NotNull final String s)
098         throws LogException
099  {
100    this(new LogMessage(s));
101  }
102
103
104
105  /**
106   * Creates a new connect access log message from the provided log message.
107   *
108   * @param  m  The log message to be parsed as a connect access log message.
109   */
110  public ConnectAccessLogMessage(@NotNull final LogMessage m)
111  {
112    super(m);
113
114    sourceAddress          = getNamedValue("from");
115    targetAddress          = getNamedValue("to");
116    protocolName           = getNamedValue("protocol");
117    clientConnectionPolicy = getNamedValue("clientConnectionPolicy");
118  }
119
120
121
122  /**
123   * Retrieves the source address for the client connection.
124   *
125   * @return  The source address for the client connection, or {@code null} if
126   *          it is not included in the log message.
127   */
128  @Nullable()
129  public String getSourceAddress()
130  {
131    return sourceAddress;
132  }
133
134
135
136  /**
137   * Retrieves the server address to which the client connection is established.
138   *
139   * @return  The server address to which the client connection is established,
140   *          or {@code null} if it is not included in the log message.
141   */
142  @Nullable()
143  public String getTargetAddress()
144  {
145    return targetAddress;
146  }
147
148
149
150  /**
151   * Retrieves the name of the protocol the client is using to communicate with
152   * the Directory Server.
153   *
154   * @return  The name of the protocol the client is using to communicate with
155   *          the Directory Server, or {@code null} if it is not included in the
156   *          log message.
157   */
158  @Nullable()
159  public String getProtocolName()
160  {
161    return protocolName;
162  }
163
164
165
166  /**
167   * Retrieves the name of the client connection policy that was selected for
168   * the client connection.
169   *
170   * @return  The name of the client connection policy that was selected for the
171   *          client connection, or {@code null} if it is not included in the
172   *          log message.
173   */
174  @Nullable()
175  public String getClientConnectionPolicy()
176  {
177    return clientConnectionPolicy;
178  }
179
180
181
182  /**
183   * {@inheritDoc}
184   */
185  @Override()
186  @NotNull()
187  public AccessLogMessageType getMessageType()
188  {
189    return AccessLogMessageType.CONNECT;
190  }
191}