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