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