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