1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 *
19 */
20 package org.apache.directory.api.ldap.codec.decorators;
21
22
23 import org.apache.directory.api.ldap.codec.api.LdapApiService;
24 import org.apache.directory.api.ldap.model.message.AbandonListener;
25 import org.apache.directory.api.ldap.model.message.AbandonableRequest;
26
27
28 /**
29 * A decorator for the LdapResultResponse message
30 *
31 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
32 */
33 public abstract class AbandonableRequestDecorator<M extends AbandonableResultResponseRequest>
34 extends ResultResponseRequestDecorator<M>
35 implements AbandonableRequest
36 {
37 /**
38 * Makes Request a MessageDecorator.
39 *
40 * @param decoratedMessage the decorated message
41 */
42 public AbandonableRequestDecorator( LdapApiService codec, M decoratedMessage )
43 {
44 super( codec, decoratedMessage );
45 }
46
47
48 /**
49 * Gets the decorated AbandonableRequest.
50 *
51 * @return The decorated {@link AbandonableRequest}
52 */
53 public AbandonableRequest getAbandonableRequest()
54 {
55 return getDecorated();
56 }
57
58
59 /**
60 * {@inheritDoc}
61 */
62 public void abandon()
63 {
64 getAbandonableRequest().abandon();
65 }
66
67
68 /**
69 * {@inheritDoc}
70 */
71 public boolean isAbandoned()
72 {
73 return getAbandonableRequest().isAbandoned();
74 }
75
76
77 /**
78 * {@inheritDoc}
79 */
80 public AbandonableRequest addAbandonListener( AbandonListener listener )
81 {
82 getAbandonableRequest().addAbandonListener( listener );
83
84 return this;
85 }
86 }