1 /* 2 * Copyright (c) 1999, 2013, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26 package com.sun.jndi.ldap; 27 28 import javax.naming.ldap.*; 29 30 /** 31 * This class provides a basic implementation of the {@code Control} 32 * interface. It represents an LDAPv3 Control as defined in RFC-2251. 33 * 34 * @author Vincent Ryan 35 */ 36 public class BasicControl implements Control { 37 38 /** 39 * The control's object identifier string. 40 * 41 * @serial 42 */ 43 protected String id; 44 45 /** 46 * The control's criticality. 47 * 48 * @serial 49 */ 50 protected boolean criticality = false; // default 51 52 /** 53 * The control's ASN.1 BER encoded value. 54 * 55 * @serial 56 */ 57 protected byte[] value = null; 58 59 private static final long serialVersionUID = -5914033725246428413L; 60 61 /** 62 * Constructs a new instance of BasicControl. 63 * It is a non-critical control. 64 * 65 * @param id The control's object identifier string. 66 * 67 */ 68 public BasicControl(String id) { 69 this.id = id; 70 } 71 72 /** 73 * Constructs a new instance of BasicControl. 74 * 75 * @param id The control's object identifier string. 76 * @param criticality The control's criticality. 77 * @param value The control's ASN.1 BER encoded value. 78 * May be null. 79 */ 80 public BasicControl(String id, boolean criticality, byte[] value) { 81 this.id = id; 82 this.criticality = criticality; 83 if (value != null) { 84 this.value = value.clone(); 85 } 86 } 87 88 /** 89 * Retrieves the control's object identifier string. 90 * 91 * @return The non-null object identifier string. 92 */ 93 public String getID() { 94 return id; 95 } 96 97 /** 98 * Determines the control's criticality. 99 * 100 * @return true if the control is critical; false otherwise. 101 */ 102 public boolean isCritical() { 103 return criticality; 104 } 105 106 /** 107 * Retrieves the control's ASN.1 BER encoded value. 108 * The result is the raw BER bytes including the tag and length of 109 * the control's value. It does not include the control's object 110 * identifier string or criticality. 111 * 112 * @return A possibly null byte array representing the control's 113 * ASN.1 BER encoded value. 114 */ 115 public byte[] getEncodedValue() { 116 return value == null ? null : value.clone(); 117 } 118 }