001/* 002 * Copyright 2011-2024 Ping Identity Corporation 003 * All Rights Reserved. 004 */ 005/* 006 * Copyright 2011-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) 2011-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.listener; 037 038 039 040import java.util.List; 041 042import com.unboundid.asn1.ASN1OctetString; 043import com.unboundid.ldap.sdk.BindResult; 044import com.unboundid.ldap.sdk.Control; 045import com.unboundid.ldap.sdk.DN; 046import com.unboundid.util.Extensible; 047import com.unboundid.util.NotNull; 048import com.unboundid.util.Nullable; 049import com.unboundid.util.ThreadSafety; 050import com.unboundid.util.ThreadSafetyLevel; 051 052 053 054/** 055 * This class defines an API that may be used to provide support for a specified 056 * SASL mechanism in the in-memory directory server. 057 */ 058@Extensible() 059@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE) 060public abstract class InMemorySASLBindHandler 061{ 062 /** 063 * Retrieves the name of the SASL mechanism supported by this bind handler. 064 * 065 * @return The name of the SASL mechanism supported by this bind handler. 066 */ 067 @NotNull() 068 public abstract String getSASLMechanismName(); 069 070 071 072 /** 073 * Performs the appropriate processing for a SASL bind request with the 074 * provided information. 075 * <BR><BR> 076 * If the bind processing is successful, then this method should also call 077 * {@link InMemoryRequestHandler#setAuthenticatedDN(DN)} on the provided 078 * request handler instance to set the identity of the authenticated user. 079 * <BR><BR> 080 * If the associated SASL mechanism requires multiple stages of processing 081 * and it is necessary to store and retrieve state information to use in other 082 * stages of the bind processing, then the map returned by the 083 * {@link InMemoryRequestHandler#getConnectionState()} method should be used 084 * for this purpose. 085 * 086 * @param handler The in-memory request handler that accepted the bind 087 * request. 088 * @param messageID The message ID for the LDAP message that the client 089 * used to send the request. 090 * @param bindDN The bind DN provided by the client. 091 * @param credentials The SASL credentials provided by the client, or 092 * {@code null} if there were none. 093 * @param controls The request controls provided by the client. 094 * 095 * @return The result that should be returned to the client in response to 096 * the provided request. 097 */ 098 @NotNull() 099 public abstract BindResult processSASLBind( 100 @NotNull InMemoryRequestHandler handler, 101 int messageID, @NotNull DN bindDN, 102 @Nullable ASN1OctetString credentials, 103 @NotNull List<Control> controls); 104 105 106 107 /** 108 * Retrieves a string representation of this SASL bind handler. 109 * 110 * @return A string representation of this SASL bind handler. 111 */ 112 @Override() 113 @NotNull() 114 public String toString() 115 { 116 return "InMemorySASLBindHandler(mechanismName='" + getSASLMechanismName() + 117 ')'; 118 } 119}