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     */
020    package org.apache.directory.shared.ldap.message;
021    
022    
023    /**
024     * The base request message class.
025     * 
026     * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
027     * @version $Rev: 764131 $
028     */
029    public class InternalAbstractRequest extends InternalAbstractMessage implements InternalRequest
030    {
031        static final long serialVersionUID = -4511116249089399040L;
032    
033        /** Flag indicating whether or not this request returns a response. */
034        private final boolean hasResponse;
035    
036    
037        /**
038         * Subclasses must provide these parameters via a super constructor call.
039         * 
040         * @param id
041         *            the sequential message identifier
042         * @param type
043         *            the request type enum
044         * @param hasResponse
045         *            flag indicating if this request generates a response
046         */
047        protected InternalAbstractRequest(final int id, final MessageTypeEnum type, boolean hasResponse)
048        {
049            super( id, type );
050    
051            this.hasResponse = hasResponse;
052        }
053    
054    
055        /**
056         * Indicator flag used to determine whether or not this type of request
057         * produces a reply.
058         * 
059         * @return true if any reply is generated, false if no response is generated
060         */
061        public boolean hasResponse()
062        {
063            return hasResponse;
064        }
065        
066        /**
067         * @see Object#hashCode()
068         * @return the instance's hash code 
069         */
070        public int hashCode()
071        {
072            int hash = 37;
073            hash = hash*17 + (hasResponse ? 0 : 1 );
074            hash = hash*17 + super.hashCode();
075            
076            return hash;
077        }
078    }