001/* 002 * Copyright 2012-2020 Ping Identity Corporation 003 * All Rights Reserved. 004 */ 005/* 006 * Copyright 2012-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 form of 049 * security negotiation performed on a client connection. 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 SecurityNegotiationAccessLogMessage 064 extends AccessLogMessage 065{ 066 /** 067 * The serial version UID for this serializable class. 068 */ 069 private static final long serialVersionUID = -8588250275523891216L; 070 071 072 073 // The negotiated cipher suite. 074 private final String cipher; 075 076 // The negotiated protocol. 077 private final String protocol; 078 079 080 081 /** 082 * Creates a new security negotiation access log message from the provided 083 * message string. 084 * 085 * @param s The string to be parsed as a security negotiation access log 086 * message. 087 * 088 * @throws LogException If the provided string cannot be parsed as a valid 089 * log message. 090 */ 091 public SecurityNegotiationAccessLogMessage(final String s) 092 throws LogException 093 { 094 this(new LogMessage(s)); 095 } 096 097 098 099 /** 100 * Creates a new security negotiation log message from the provided log 101 * message. 102 * 103 * @param m The log message to be parsed as a connect access log message. 104 */ 105 public SecurityNegotiationAccessLogMessage(final LogMessage m) 106 { 107 super(m); 108 109 protocol = getNamedValue("protocol"); 110 cipher = getNamedValue("cipher"); 111 } 112 113 114 115 /** 116 * Retrieves the name of the security protocol that was negotiated. 117 * 118 * @return The name of the security protocol that was negotiated. 119 */ 120 public String getProtocol() 121 { 122 return protocol; 123 } 124 125 126 127 /** 128 * Retrieves the name of the cipher suite that was negotiated. 129 * 130 * @return The name of the cipher suite that was negotiated. 131 */ 132 public String getCipher() 133 { 134 return cipher; 135 } 136 137 138 139 /** 140 * {@inheritDoc} 141 */ 142 @Override() 143 public AccessLogMessageType getMessageType() 144 { 145 return AccessLogMessageType.SECURITY_NEGOTIATION; 146 } 147}