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-2014 UnboundID Corp. 026 */ 027 package com.unboundid.directory.sdk.common.types; 028 029 030 031 import com.unboundid.ldap.sdk.IntermediateResponse; 032 import com.unboundid.ldap.sdk.LDAPException; 033 import com.unboundid.util.NotExtensible; 034 import com.unboundid.util.ThreadSafety; 035 import 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) 046 public 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 }