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.shared.ldap.codec.decorators;
021
022
023import org.apache.directory.shared.ldap.codec.api.LdapApiService;
024import org.apache.directory.shared.ldap.model.message.AbandonListener;
025import org.apache.directory.shared.ldap.model.message.AbandonableRequest;
026import org.apache.directory.shared.ldap.model.message.MessageTypeEnum;
027import org.apache.directory.shared.ldap.model.message.ResultResponse;
028import org.apache.directory.shared.ldap.model.message.SingleReplyRequest;
029
030
031/**
032 * A decorator for the LdapResultResponse message
033 *
034 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
035 */
036public abstract class SingleReplyRequestDecorator<M extends SingleReplyRequest<R>, R extends ResultResponse> 
037    extends ResultResponseRequestDecorator<M,R> implements SingleReplyRequest<R>, AbandonableRequest
038{
039    /**
040     * Makes Request a MessageDecorator.
041     *
042     * @param decoratedMessage the decorated message
043     */
044    public SingleReplyRequestDecorator( LdapApiService codec, M decoratedMessage )
045    {
046        super( codec, decoratedMessage );
047    }
048
049    
050    /**
051     * {@inheritDoc}
052     */
053    public MessageTypeEnum getResponseType()
054    {
055        return getDecorated().getResponseType();
056    }
057
058
059    public void abandon()
060    {
061        ( ( AbandonableRequest ) getDecorated() ).abandon();
062    }
063
064
065    public boolean isAbandoned()
066    {
067        return ( ( AbandonableRequest ) getDecorated() ).isAbandoned();
068    }
069
070
071    public AbandonableRequest addAbandonListener( AbandonListener listener )
072    {
073        ( ( AbandonableRequest ) getDecorated() ).addAbandonListener( listener );
074        
075        return this;
076    }
077}