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