Initial public commit of OpenDS Directory Server source code.

opends

28.11.2006 eda79366f0bdacebb6fca64c8e472538c9b16798

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License, Version 1.0 only
 * (the "License").  You may not use this file except in compliance
 * with the License.
 *
 * You can obtain a copy of the license at
 * trunk/opends/resource/legal-notices/OpenDS.LICENSE
 * or https://OpenDS.dev.java.net/OpenDS.LICENSE.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at
 * trunk/opends/resource/legal-notices/OpenDS.LICENSE.  If applicable,
 * add the following below this CDDL HEADER, with the fields enclosed
 * by brackets "[]" replaced with your own identifying * information:
 *      Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 *
 *
 *      Portions Copyright 2006 Sun Microsystems, Inc.
 */
package org.opends.server.api.plugin;
 
 
 
import static org.opends.server.loggers.Debug.*;
 
 
 
/**
 * This class defines a data structure that holds information about
 * the result of processing by a post-disconnect plugin.
 */
public class PostDisconnectPluginResult
{
  /**
   * The fully-qualified name of this class for debugging purposes.
   */
  private static final String CLASS_NAME =
       "org.opends.server.api.plugin.PostDisconnectPluginResult";
 
 
 
  // Indicates whether any further post-disconnect plugins should be
  // invoked for this connection.
  private boolean continuePluginProcessing;
 
 
 
  /**
   * Creates a new post-connect plugin result with the default
   * settings.  In this case, it will indicate that the further
   * post-disconnect plugin processing should be allowed.
   */
  public PostDisconnectPluginResult()
  {
    assert debugConstructor(CLASS_NAME);
 
    this.continuePluginProcessing = true;
  }
 
 
 
  /**
   * Creates a new post-disconnect plugin result with the provided
   * information.
   *
   * @param  continuePluginProcessing  Indicates whether any further
   *                                   post-disconnect plugins should
   *                                   be invoked for this connection.
   */
  public PostDisconnectPluginResult(boolean continuePluginProcessing)
  {
    assert debugConstructor(CLASS_NAME,
                            String.valueOf(continuePluginProcessing));
 
    this.continuePluginProcessing = continuePluginProcessing;
  }
 
 
 
  /**
   * Indicates whether any further post-disconnect plugins should be
   * invoked for this connection.
   *
   * @return  <CODE>true</CODE> if any further post-disconnect plugins
   *          should be invoked for this connection, or
   *          <CODE>false</CODE> if not.
   */
  public boolean continuePluginProcessing()
  {
    assert debugEnter(CLASS_NAME, "continuePluginProcessing");
 
    return continuePluginProcessing;
  }
 
 
 
  /**
   * Specifies whether any further post-disconnect plugins should be
   * invoked for this connection.
   *
   * @param  continuePluginProcessing  Specifies whether any further
   *                                   post-disconnect plugins should
   *                                   be invoked for this connection.
   */
  public void setContinuePluginProcessing(
                   boolean continuePluginProcessing)
  {
    assert debugEnter(CLASS_NAME, "setContinuePluginProcessing",
                      String.valueOf(continuePluginProcessing));
 
    this.continuePluginProcessing = continuePluginProcessing;
  }
 
 
 
  /**
   * Retrieves a string representation of this post-connect plugin
   * result.
   *
   * @return  A string representation of this post-connect plugin
   *          result.
   */
  public String toString()
  {
    assert debugEnter(CLASS_NAME, "toString");
 
    StringBuilder buffer = new StringBuilder();
    toString(buffer);
    return buffer.toString();
  }
 
 
 
  /**
   * Appends a string representation of this post-connect plugin
   * result to the provided buffer.
   *
   * @param  buffer  The buffer to which the information should be
   *                 appended.
   */
  public void toString(StringBuilder buffer)
  {
    assert debugEnter(CLASS_NAME, "toString",
                      "java.lang.StringBuilder");
 
    buffer.append("PostDisconnectPluginResult(" +
                  "continuePluginProcessing=");
    buffer.append(continuePluginProcessing);
    buffer.append(")");
  }
}