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.decorators;
021
022
023import java.nio.BufferOverflowException;
024import java.nio.ByteBuffer;
025
026import org.apache.directory.api.asn1.EncoderException;
027import org.apache.directory.api.asn1.ber.tlv.TLV;
028import org.apache.directory.api.i18n.I18n;
029import org.apache.directory.api.ldap.codec.api.LdapApiService;
030import org.apache.directory.api.ldap.codec.api.LdapConstants;
031import org.apache.directory.api.ldap.model.message.CompareResponse;
032
033
034/**
035 * A decorator for the CompareResponse message
036 *
037 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
038 */
039public class CompareResponseDecorator extends ResponseDecorator<CompareResponse>
040    implements CompareResponse
041{
042    /** The encoded compareResponse length */
043    private int compareResponseLength;
044
045
046    /**
047     * Makes a CompareResponse a MessageDecorator.
048     *
049     * @param decoratedMessage the decorated CompareResponse
050     */
051    public CompareResponseDecorator( LdapApiService codec, CompareResponse decoratedMessage )
052    {
053        super( codec, decoratedMessage );
054    }
055
056
057    /**
058     * Stores the encoded length for the CompareResponse
059     * @param compareResponseLength The encoded length
060     */
061    public void setCompareResponseLength( int compareResponseLength )
062    {
063        this.compareResponseLength = compareResponseLength;
064    }
065
066
067    /**
068     * @return The encoded CompareResponse's length
069     */
070    public int getCompareResponseLength()
071    {
072        return compareResponseLength;
073    }
074
075
076    //-------------------------------------------------------------------------
077    // The CompareResponse methods
078    //-------------------------------------------------------------------------
079
080    /**
081     * {@inheritDoc}
082     */
083    public boolean isTrue()
084    {
085        return getDecorated().isTrue();
086    }
087
088
089    //-------------------------------------------------------------------------
090    // The Decorator methods
091    //-------------------------------------------------------------------------
092
093    /**
094     * Compute the CompareResponse length 
095     * 
096     * CompareResponse :
097     * 
098     * 0x6F L1
099     *  |
100     *  +--> LdapResult
101     * 
102     * L1 = Length(LdapResult)
103     * 
104     * Length(CompareResponse) = Length(0x6F) + Length(L1) + L1
105     */
106    public int computeLength()
107    {
108        int compareResponseLength = ( ( LdapResultDecorator ) getLdapResult() ).computeLength();
109
110        setCompareResponseLength( compareResponseLength );
111
112        return 1 + TLV.getNbBytes( compareResponseLength ) + compareResponseLength;
113    }
114
115
116    /**
117     * Encode the CompareResponse message to a PDU.
118     * 
119     * @param buffer The buffer where to put the PDU
120     */
121    public ByteBuffer encode( ByteBuffer buffer )
122        throws EncoderException
123    {
124        try
125        {
126            // The CompareResponse Tag
127            buffer.put( LdapConstants.COMPARE_RESPONSE_TAG );
128            buffer.put( TLV.getBytes( getCompareResponseLength() ) );
129
130            // The LdapResult
131            ( ( LdapResultDecorator ) getLdapResult() ).encode( buffer );
132        }
133        catch ( BufferOverflowException boe )
134        {
135            throw new EncoderException( I18n.err( I18n.ERR_04005 ) );
136        }
137
138        return buffer;
139    }
140}