001/* 002 * CDDL HEADER START 003 * 004 * The contents of this file are subject to the terms of the 005 * Common Development and Distribution License, Version 1.0 only 006 * (the "License"). You may not use this file except in compliance 007 * with the License. 008 * 009 * You can obtain a copy of the license at 010 * docs/licenses/cddl.txt 011 * or http://www.opensource.org/licenses/cddl1.php. 012 * See the License for the specific language governing permissions 013 * and limitations under the License. 014 * 015 * When distributing Covered Code, include this CDDL HEADER in each 016 * file and include the License file at 017 * docs/licenses/cddl.txt. If applicable, 018 * add the following below this CDDL HEADER, with the fields enclosed 019 * by brackets "[]" replaced with your own identifying information: 020 * Portions Copyright [yyyy] [name of copyright owner] 021 * 022 * CDDL HEADER END 023 * 024 * 025 * Copyright 2010-2021 Ping Identity Corporation 026 */ 027package com.unboundid.directory.sdk.common.types; 028 029 030 031import com.unboundid.ldap.sdk.IntermediateResponse; 032import com.unboundid.ldap.sdk.LDAPException; 033import com.unboundid.util.NotExtensible; 034import com.unboundid.util.ThreadSafety; 035import com.unboundid.util.ThreadSafetyLevel; 036 037 038 039/** 040 * This interface defines a set of methods that may be used to obtain 041 * information about an operation that is actively being processed and for which 042 * the final response has not yet been sent. 043 */ 044@NotExtensible() 045@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE) 046public interface ActiveOperationContext 047 extends OperationContext 048{ 049 /** 050 * Attempts to send an intermediate response message to the client. 051 * 052 * @param r The intermediate response to be sent. It must not be 053 * {@code null}. 054 * 055 * @throws LDAPException If a problem occurs while attempting to send the 056 * intermediate response message and processing on the 057 * associated operation should be aborted. 058 */ 059 void sendIntermediateResponse(final IntermediateResponse r) 060 throws LDAPException; 061 062 063 064 /** 065 * Sets an attachment for the associated operation. 066 * 067 * @param name The name of the attachment to set. It must not be 068 * {@code null}. 069 * @param value The value to set for the attachment. It may be {@code null} 070 * if any existing attachment with the specified name should be 071 * removed. 072 */ 073 void setAttachment(final String name, final Object value); 074 075 076 077 /** 078 * Indicates whether the requester has the specified privilege, optionally 079 * including it in the set of used privileges for the operation. The set of 080 * defined privileges may be found in the privilege-list.html and 081 * privilege-list.csv files in the server docs directory. 082 * 083 * @param privilegeName The name of the privilege for which to make the 084 * determination. It must not be {@code null}. 085 * @param markUsed Indicates whether to include the specified privilege 086 * in the set of privileges that were used in the 087 * course of processing the operation. This is only 088 * applicable if the requester has the specified 089 * privilege. 090 * 091 * @return {@code true} if the requester has the specified privilege, or 092 * {@code false} if not. 093 * 094 * @throws LDAPException If the specified privilege is not defined in the 095 * server, or if a problem is encountered while trying 096 * to make the determination. 097 */ 098 boolean hasPrivilege(final String privilegeName, final boolean markUsed) 099 throws LDAPException; 100 101 102 103 /** 104 * Ensures that the requester has the specified privilege. If the requester 105 * has the specified privilege, then the set of privileges used in the course 106 * of processing the operation will be updated to include the specified 107 * privilege. If the specifies privilege is defined in the server but the 108 * requested user does not have it, then it will be added to the set of 109 * missing privileges for the operation. 110 * <BR><BR> 111 * The set of defined privileges may be found in the privilege-list.html and 112 * privilege-list.csv files in the server docs directory. 113 * 114 * @param privilegeName The name of the privilege to require. It must not 115 * be {@code null}. 116 * 117 * @throws LDAPException If the specified privilege is not defined in the 118 * server, if the requester does not have that 119 * privilege, or a problem is encountered while trying 120 * to make the determination. 121 */ 122 void requirePrivilege(final String privilegeName) 123 throws LDAPException; 124}