001/*
002 * Copyright 2022-2023 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2022-2023 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-2023 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;
037
038
039
040import com.unboundid.util.NotExtensible;
041import com.unboundid.util.Nullable;
042import com.unboundid.util.ThreadSafety;
043import com.unboundid.util.ThreadSafetyLevel;
044
045
046
047/**
048 * This class provides a data structure that holds information about a connect
049 * access log message.
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@NotExtensible()
062@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_THREADSAFE)
063public interface ConnectAccessLogMessage
064       extends AccessLogMessage
065{
066  /**
067   * Retrieves the source address for the client connection.
068   *
069   * @return  The source address for the client connection, or {@code null} if
070   *          it is not included in the log message.
071   */
072  @Nullable()
073  String getSourceAddress();
074
075
076
077  /**
078   * Retrieves the source port for the client connection.
079   *
080   * @return  The source port for the client connection, or {@code null} if
081   *          it is not included in the log message.
082   */
083  @Nullable()
084  Integer getSourcePort();
085
086
087
088  /**
089   * Retrieves the server address to which the client connection is established.
090   *
091   * @return  The server address to which the client connection is established,
092   *          or {@code null} if it is not included in the log message.
093   */
094  @Nullable()
095  String getTargetAddress();
096
097
098
099  /**
100   * Retrieves the target port for the client connection.
101   *
102   * @return  The target port for the client connection, or {@code null} if
103   *          it is not included in the log message.
104   */
105  @Nullable()
106  Integer getTargetPort();
107
108
109
110  /**
111   * Retrieves the name of the protocol the client is using to communicate with
112   * the Directory Server.
113   *
114   * @return  The name of the protocol the client is using to communicate with
115   *          the Directory Server, or {@code null} if it is not included in the
116   *          log message.
117   */
118  @Nullable()
119  String getProtocolName();
120
121
122
123  /**
124   * Retrieves the name of the client connection policy that was selected for
125   * the client connection.
126   *
127   * @return  The name of the client connection policy that was selected for the
128   *          client connection, or {@code null} if it is not included in the
129   *          log message.
130   */
131  @Nullable()
132  String getClientConnectionPolicy();
133}