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