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