001/* 002 * Licensed to the Apache Software Foundation (ASF) under one 003 * or more contributor license agreements. See the NOTICE file 004 * distributed with this work for additional information 005 * regarding copyright ownership. The ASF licenses this file 006 * to you under the Apache License, Version 2.0 (the 007 * "License"); you may not use this file except in compliance 008 * with the License. You may obtain a copy of the License at 009 * 010 * http://www.apache.org/licenses/LICENSE-2.0 011 * 012 * Unless required by applicable law or agreed to in writing, 013 * software distributed under the License is distributed on an 014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 015 * KIND, either express or implied. See the License for the 016 * specific language governing permissions and limitations 017 * under the License. 018 * 019 */ 020package org.apache.directory.api.ldap.codec.controls.sort; 021 022 023import org.apache.directory.api.asn1.DecoderException; 024import org.apache.directory.api.asn1.ber.tlv.BerValue; 025import org.apache.directory.api.asn1.util.Asn1Buffer; 026import org.apache.directory.api.ldap.codec.api.AbstractControlFactory; 027import org.apache.directory.api.ldap.codec.api.ControlFactory; 028import org.apache.directory.api.ldap.codec.api.LdapApiService; 029import org.apache.directory.api.ldap.model.message.Control; 030import org.apache.directory.api.ldap.model.message.controls.SortResponse; 031import org.apache.directory.api.ldap.model.message.controls.SortResponseImpl; 032import org.apache.directory.api.util.Strings; 033 034 035/** 036 * A {@link ControlFactory} for SortResponseControl. 037 * 038 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 039 * @version $Rev$, $Date$ 040 */ 041public class SortResponseFactory extends AbstractControlFactory<SortResponse> 042{ 043 /** ASN.1 BER tag for the AttriubteType */ 044 public static final int ATTRIBUTE_TYPE_TAG = 0x80; 045 046 /** 047 * Creates a new instance of SortResponseFactory. 048 * 049 * @param codec The LDAP codec. 050 */ 051 public SortResponseFactory( LdapApiService codec ) 052 { 053 super( codec, SortResponse.OID ); 054 } 055 056 057 /** 058 * {@inheritDoc} 059 */ 060 @Override 061 public SortResponse newControl() 062 { 063 return new SortResponseImpl(); 064 } 065 066 067 /** 068 * {@inheritDoc} 069 */ 070 @Override 071 public void encodeValue( Asn1Buffer buffer, Control control ) 072 { 073 SortResponse sortResponse = ( SortResponse ) control; 074 075 int start = buffer.getPos(); 076 077 // The attributeType, if any 078 if ( sortResponse.getAttributeName() != null ) 079 { 080 BerValue.encodeOctetString( buffer, ( byte ) ATTRIBUTE_TYPE_TAG, 081 Strings.getBytesUtf8Ascii( sortResponse.getAttributeName() ) ); 082 } 083 084 // The sortResult 085 BerValue.encodeEnumerated( buffer, sortResponse.getSortResult().getVal() ); 086 087 // The overall sequence 088 BerValue.encodeSequence( buffer, start ); 089 } 090 091 092 /** 093 * {@inheritDoc} 094 */ 095 @Override 096 public void decodeValue( Control control, byte[] controlBytes ) throws DecoderException 097 { 098 decodeValue( new SortResponseContainer( control ), control, controlBytes ); 099 } 100}