com.novell.ldap.LDAPAttribute Maven / Gradle / Ivy

Note: If attrBytes represents a string it should be UTF-8 encoded. * * @throws IllegalArgumentException if attrName or attrBytes is null */ public LDAPAttribute( String attrName, byte[] attrBytes ) { this( attrName ); if( attrBytes == null) { throw new IllegalArgumentException("Attribute value cannot be null"); } // Make our own copy of the byte array to prevent app from changing it byte[] tmp = new byte[attrBytes.length]; System.arraycopy( attrBytes, 0, tmp, 0, attrBytes.length ); this.add( tmp); return; } /** * Constructs an attribute with a single string value. * * @param attrName Name of the attribute.

* @param attrString Value of the attribute as a string. * * @throws IllegalArgumentException if attrName or attrString is null */ public LDAPAttribute(String attrName, String attrString) { this( attrName ); if( attrString == null) { throw new IllegalArgumentException("Attribute value cannot be null"); } try { this.add( attrString.getBytes( "UTF-8" ) ); } catch( UnsupportedEncodingException e ){ throw new RuntimeException( e.toString()); } return; } /** * Constructs an attribute with an array of string values. * * @param attrName Name of the attribute.

* @param attrStrings Array of values as strings. * * @throws IllegalArgumentException if attrName, attrStrings, or a member * of attrStrings is null */ public LDAPAttribute(String attrName, String[] attrStrings) { this( attrName ); if( attrStrings == null) { throw new IllegalArgumentException("Attribute values array cannot be null"); } for( int i = 0, u = attrStrings.length; i < u; i++) { try { if( attrStrings[ i ] == null) { throw new IllegalArgumentException("Attribute value " + "at array index " + i + " cannot be null"); } this.add( attrStrings[ i ].getBytes( "UTF-8" ) ); } catch( UnsupportedEncodingException e ){ throw new RuntimeException( e.toString()); } } return; } /** * Returns a clone of this LDAPAttribute. * * @return clone of this LDAPAttribute. */ public Object clone() { try { Object newObj = super.clone(); if( values != null) { System.arraycopy( this.values, 0, ((LDAPAttribute)newObj).values, 0, this.values.length); } return newObj; } catch( CloneNotSupportedException ce) { throw new RuntimeException("Internal error, cannot create clone"); } } /** * Adds a string value to the attribute. * * @param attrString Value of the attribute as a String. * * @throws IllegalArgumentException if attrString is null */ public void addValue(String attrString) { if( attrString == null) { throw new IllegalArgumentException("Attribute value cannot be null"); } try { this.add( attrString.getBytes( "UTF-8" ) ); } catch( UnsupportedEncodingException ue ) { throw new RuntimeException( ue.toString()); } return; } /** * Adds a byte-formatted value to the attribute. * * @param attrBytes Value of the attribute as raw bytes. * *

Note: If attrBytes represents a string it should be UTF-8 encoded. * * @throws IllegalArgumentException if attrBytes is null */ public void addValue(byte[] attrBytes) { if( attrBytes == null) { throw new IllegalArgumentException("Attribute value cannot be null"); } this.add(attrBytes); return; } /** * Adds a base64 encoded value to the attribute. * The value will be decoded and stored as bytes. String * data encoded as a base64 value must be UTF-8 characters. * * @param attrString The base64 value of the attribute as a String. * * @throws IllegalArgumentException if attrString is null */ public void addBase64Value(String attrString) { if( attrString == null) { throw new IllegalArgumentException("Attribute value cannot be null"); } this.add( Base64.decode(attrString)); return; } /** * Adds a base64 encoded value to the attribute. * The value will be decoded and stored as bytes. Character * data encoded as a base64 value must be UTF-8 characters. * * @param attrString The base64 value of the attribute as a StringBuffer. * @param start The start index of base64 encoded part, inclusive. * @param end The end index of base encoded part, exclusive. * * @throws IllegalArgumentException if attrString is null */ public void addBase64Value(StringBuffer attrString, int start, int end) { if( attrString == null) { throw new IllegalArgumentException("Attribute value cannot be null"); } this.add( Base64.decode(attrString, start, end)); return; } /** * Adds a base64 encoded value to the attribute. * The value will be decoded and stored as bytes. Character * data encoded as a base64 value must be UTF-8 characters. * * @param attrChars The base64 value of the attribute as an array of * characters. * * @throws IllegalArgumentException if attrString is null */ public void addBase64Value(char[] attrChars) { if( attrChars == null) { throw new IllegalArgumentException("Attribute value cannot be null"); } this.add( Base64.decode(attrChars)); return; } /** * Adds a URL, indicating a file or other resource that contains * the value of the attribute. * * @param url String value of a URL pointing to the resource containing * the value of the attribute. * * @throws IllegalArgumentException if url is null */ public void addURLValue(String url) throws MalformedURLException, IOException { if( url == null) { throw new IllegalArgumentException("Attribute URL cannot be null"); } addURLValue( new URL( url)); return; } /** * Adds a URL, indicating a file or other resource that contains * the value of the attribute. * * @param url A URL class pointing to the resource containing the value * of the attribute. * * @throws IllegalArgumentException if url is null */ public void addURLValue(URL url) throws MalformedURLException, IOException { // Class to encapsulate the data bytes and the length class URLData { private int length; private byte[] data; private URLData(byte[] data, int length) { this.length = length; this.data = data; return; } private int getLength() { return length; } private byte[] getData() { return data; } } if( url == null) { throw new IllegalArgumentException("Attribute URL cannot be null"); } try { // Get InputStream from the URL InputStream in = url.openStream(); // Read the bytes into buffers and store the them in an arraylist ArrayList bufs = new ArrayList(); byte[] buf = new byte[4096]; int len, totalLength = 0; while( (len = in.read(buf,0, 4096)) != -1) { bufs.add( new URLData(buf, len)); buf = new byte[4096]; totalLength += len; } /* * Now that the length is known, allocate an array to hold all * the bytes of data and copy the data to that array, store * it in this LDAPAttribute */ byte[] data = new byte[totalLength]; int offset = 0; // for( int i=0; i < bufs.size(); i++) { URLData b = (URLData)bufs.get(i); len = b.getLength(); System.arraycopy( b.getData(), 0, data, offset, len); offset += len; } this.add( data); } catch( UnsupportedEncodingException ue ) { throw new RuntimeException( ue.toString()); } return; } /** * Returns an enumerator for the values of the attribute in byte format. * * @return The values of the attribute in byte format. *

Note: All string values will be UTF-8 encoded. To decode use the * String constructor. Example: new String( byteArray, "UTF-8" ); */ public Enumeration getByteValues() { return new ArrayEnumeration( getByteValueArray()); } /** * Returns an enumerator for the string values of an attribute. * * @return The string values of an attribute. */ public Enumeration getStringValues() { return new ArrayEnumeration( getStringValueArray()); } /** * Returns the values of the attribute as an array of bytes. * * @return The values as an array of bytes or an empty array if there are * no values. */ public byte[][] getByteValueArray() { if( null == this.values ) return new byte[ 0 ][]; int size = this.values.length; byte[][] bva = new byte[ size ][]; // Deep copy so application cannot change values for( int i = 0, u = size; i < u; i++) { bva[i] = new byte[((byte[])values[i]).length]; System.arraycopy( this.values[i], 0, bva[i], 0, bva[i].length ); } return bva; } /** * Returns the values of the attribute as an array of strings. * * @return The values as an array of strings or an empty array if there are * no values */ public String[] getStringValueArray() { if( null == this.values ) return new String[ 0 ]; int size = values.length; String[] sva = new String[ size ]; for( int j = 0; j < size; j++ ) { try { sva[ j ] = new String( (byte[])values[ j ], "UTF-8" ); } catch( UnsupportedEncodingException uee ) { // Exception should NEVER get thrown but just in case it does ... throw new RuntimeException( uee.toString()); } } return sva; } /** * Returns the the first value of the attribute as a String. * * @return The UTF-8 encodedString value of the attribute's * value. If the value wasn't a UTF-8 encoded String * to begin with the value of the returned String is * non deterministic. * *

If this attribute has more than one value the * first value is converted to a UTF-8 encoded String * and returned. It should be noted, that the directory may * return attribute values in any order, so that the first * value may vary from one call to another. * *

If the attribute has no values null is returned */ public String getStringValue() { String rval = null; if( this.values != null) { try { rval = new String( (byte[])this.values[ 0 ], "UTF-8" ); } catch( UnsupportedEncodingException use ) { throw new RuntimeException( use.toString()); } } return rval; } /** * Returns the the first value of the attribute as a byte array. * * @return The binary value of this attribute or * null if this attribute doesn't have a value. * *

If the attribute has no values null is returned */ public byte[] getByteValue() { byte[] bva = null; if( this.values != null) { // Deep copy so app can't change the value bva = new byte[((byte[])values[0]).length]; System.arraycopy( this.values[0], 0, bva, 0, bva.length ); } return bva; } /** * Returns the language subtype of the attribute, if any. * *

For example, if the attribute name is cn;lang-ja;phonetic, * this method returns the string, lang-ja.