1/*
2 * Copyright (c) 2003, 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
26package javax.naming.ldap;
27
28/**
29 * This class provides a basic implementation of the {@code Control}
30 * interface. It represents an LDAPv3 Control as defined in
31 * <a href="http://www.ietf.org/rfc/rfc2251.txt">RFC 2251</a>.
32 *
33 * @since 1.5
34 * @author Vincent Ryan
35 */
36public 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 = -4233907508771791687L;
60
61    /**
62     * Constructs a non-critical control.
63     *
64     * @param   id      The control's object identifier string.
65     *
66     */
67    public BasicControl(String id) {
68        this.id = id;
69    }
70
71    /**
72     * Constructs a control using the supplied arguments.
73     *
74     * @param   id              The control's object identifier string.
75     * @param   criticality     The control's criticality.
76     * @param   value           The control's ASN.1 BER encoded value.
77     *                          It is not cloned - any changes to value
78     *                          will affect the contents of the control.
79     *                          It may be null.
80     */
81    public BasicControl(String id, boolean criticality, byte[] value) {
82        this.id = id;
83        this.criticality = criticality;
84        this.value = value;
85    }
86
87    /**
88     * Retrieves the control's object identifier string.
89     *
90     * @return The non-null object identifier string.
91     */
92    public String getID() {
93        return id;
94    }
95
96    /**
97     * Determines the control's criticality.
98     *
99     * @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}
118