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