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