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 * https://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.extras.extended.cancel; 021 022 023import org.apache.directory.api.ldap.model.message.AbstractExtendedRequest; 024 025 026/** 027 * Implement the extended Cancel Request as described in RFC 3909. 028 * 029 * It's grammar is : 030 * 031 * <pre> 032 * cancelRequestValue ::= SEQUENCE { 033 * cancelID MessageID 034 * -- MessageID is as defined in [RFC2251] 035 * } 036 * </pre> 037 * 038 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 039 */ 040public class CancelRequestImpl extends AbstractExtendedRequest implements CancelRequest 041{ 042 /** The cancelId of the request to be canceled */ 043 private int cancelId; 044 045 /** 046 * Creates a new instance of CancelRequest. 047 * 048 * @param messageId the message id 049 * @param cancelId the message id of the request to cancel 050 */ 051 public CancelRequestImpl( int messageId, int cancelId ) 052 { 053 super( messageId ); 054 setRequestName( EXTENSION_OID ); 055 056 this.cancelId = cancelId; 057 } 058 059 060 /** 061 * Creates a new instance of CancelRequest. 062 */ 063 public CancelRequestImpl() 064 { 065 setRequestName( EXTENSION_OID ); 066 } 067 068 069 /** 070 * {@inheritDoc} 071 */ 072 @Override 073 public int getCancelId() 074 { 075 return cancelId; 076 } 077 078 079 /** 080 * {@inheritDoc} 081 */ 082 @Override 083 public void setCancelId( int cancelId ) 084 { 085 this.cancelId = cancelId; 086 } 087 088 089 /** 090 * {@inheritDoc} 091 */ 092 @Override 093 public CancelResponse getResultResponse() 094 { 095 if ( getResponse() == null ) 096 { 097 setResponse( new CancelResponseImpl( cancelId ) ); 098 } 099 100 return ( CancelResponse ) getResponse(); 101 } 102}