001 /*
002 * Copyright 2003 Sun Microsystems, Inc. All Rights Reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation. Sun designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Sun in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022 * CA 95054 USA or visit www.sun.com if you need additional information or
023 * have any questions.
024 */
025
026 package javax.naming.ldap;
027
028 /**
029 * This class provides a basic implementation of the <tt>Control</tt>
030 * interface. It represents an LDAPv3 Control as defined in
031 * <a href="http://www.ietf.org/rfc/rfc2251.txt">RFC 2251</a>.
032 *
033 * @since 1.5
034 * @author Vincent Ryan
035 */
036 public class BasicControl implements Control {
037
038 /**
039 * The control's object identifier string.
040 *
041 * @serial
042 */
043 protected String id;
044
045 /**
046 * The control's criticality.
047 *
048 * @serial
049 */
050 protected boolean criticality = false; // default
051
052 /**
053 * The control's ASN.1 BER encoded value.
054 *
055 * @serial
056 */
057 protected byte[] value = null;
058
059 private static final long serialVersionUID = -4233907508771791687L;
060
061 /**
062 * Constructs a non-critical control.
063 *
064 * @param id The control's object identifier string.
065 *
066 */
067 public BasicControl(String id) {
068 this .id = id;
069 }
070
071 /**
072 * Constructs a control using the supplied arguments.
073 *
074 * @param id The control's object identifier string.
075 * @param criticality The control's criticality.
076 * @param value The control's ASN.1 BER encoded value.
077 * It is not cloned - any changes to value
078 * will affect the contents of the control.
079 * It may be null.
080 */
081 public BasicControl(String id, boolean criticality, byte[] value) {
082 this .id = id;
083 this .criticality = criticality;
084 this .value = value;
085 }
086
087 /**
088 * Retrieves the control's object identifier string.
089 *
090 * @return The non-null object identifier string.
091 */
092 public String getID() {
093 return id;
094 }
095
096 /**
097 * Determines the control's criticality.
098 *
099 * @return true if the control is critical; false otherwise.
100 */
101 public boolean isCritical() {
102 return criticality;
103 }
104
105 /**
106 * Retrieves the control's ASN.1 BER encoded value.
107 * The result includes the BER tag and length for the control's value but
108 * does not include the control's object identifier and criticality setting.
109 *
110 * @return A possibly null byte array representing the control's
111 * ASN.1 BER encoded value. It is not cloned - any changes to the
112 * returned value will affect the contents of the control.
113 */
114 public byte[] getEncodedValue() {
115 return value;
116 }
117 }
|