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 * https://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.extras.extended.cancel;
21
22
23 import org.apache.directory.api.ldap.model.message.OpaqueExtendedRequest;
24
25
26 /**
27 * Implement the extended Cancel Request as described in RFC 3909.
28 *
29 * It's grammar is :
30 *
31 * <pre>
32 * cancelRequestValue ::= SEQUENCE {
33 * cancelID MessageID
34 * -- MessageID is as defined in [RFC2251]
35 * }
36 * </pre>
37 *
38 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
39 */
40 public class CancelRequestImpl extends OpaqueExtendedRequest implements CancelRequest
41 {
42 /** The cancelId of the request to be canceled */
43 private int cancelId;
44
45 /**
46 * Creates a new instance of CancelRequest.
47 *
48 * @param messageId the message id
49 * @param cancelId the message id of the request to cancel
50 */
51 public CancelRequestImpl( int messageId, int cancelId )
52 {
53 super( messageId );
54 setRequestName( EXTENSION_OID );
55
56 this.cancelId = cancelId;
57 }
58
59
60 /**
61 * Creates a new instance of CancelRequest.
62 */
63 public CancelRequestImpl()
64 {
65 setRequestName( EXTENSION_OID );
66 }
67
68
69 /**
70 * {@inheritDoc}
71 */
72 @Override
73 public int getCancelId()
74 {
75 return cancelId;
76 }
77
78
79 /**
80 * {@inheritDoc}
81 */
82 @Override
83 public void setCancelId( int cancelId )
84 {
85 this.cancelId = cancelId;
86 }
87
88
89 /**
90 * {@inheritDoc}
91 */
92 @Override
93 public CancelResponse getResultResponse()
94 {
95 if ( getResponse() == null )
96 {
97 setResponse( new CancelResponseImpl( cancelId ) );
98 }
99
100 return ( CancelResponse ) getResponse();
101 }
102 }