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.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 * cancelRequestValue ::= SEQUENCE {
032 *        cancelID        MessageID
033 *                        -- MessageID is as defined in [RFC2251]
034 * }
035 *
036 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
037 */
038public class CancelRequestImpl extends AbstractExtendedRequest implements CancelRequest
039{
040    /** The cancelId of the request to be canceled */
041    private int cancelId;
042
043
044    /**
045     * Creates a new instance of CancelRequest.
046     *
047     * @param messageId the message id
048     * @param cancelId the message id of the request to cancel
049     */
050    public CancelRequestImpl( int messageId, int cancelId )
051    {
052        super( messageId );
053        setRequestName( EXTENSION_OID );
054
055        this.cancelId = cancelId;
056    }
057
058
059    /**
060     * Creates a new instance of CancelRequest.
061     */
062    public CancelRequestImpl()
063    {
064        setRequestName( EXTENSION_OID );
065    }
066
067
068    @Override
069    public int getCancelId()
070    {
071        return cancelId;
072    }
073
074
075    @Override
076    public void setCancelId( int cancelId )
077    {
078        this.cancelId = cancelId;
079    }
080
081
082    @Override
083    public CancelResponse getResultResponse()
084    {
085        if ( getResponse() == null )
086        {
087            setResponse( new CancelResponseImpl( cancelId ) );
088        }
089
090        return ( CancelResponse ) getResponse();
091    }
092}