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.ads_impl.cancel;
021
022
023import org.apache.directory.api.asn1.DecoderException;
024import org.apache.directory.api.ldap.codec.api.ExtendedOperationFactory;
025import org.apache.directory.api.ldap.codec.api.LdapApiService;
026import org.apache.directory.api.ldap.extras.extended.cancel.CancelRequest;
027import org.apache.directory.api.ldap.extras.extended.cancel.CancelRequestImpl;
028import org.apache.directory.api.ldap.extras.extended.cancel.CancelResponse;
029import org.apache.directory.api.ldap.extras.extended.cancel.CancelResponseImpl;
030import org.apache.directory.api.ldap.model.message.ExtendedRequest;
031import org.apache.directory.api.ldap.model.message.ExtendedResponse;
032
033
034/**
035 * An {@link ExtendedOperationFactory} for creating cancel extended request response 
036 * pairs.
037 *
038 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
039 */
040public class CancelFactory implements ExtendedOperationFactory
041{
042    private LdapApiService codec;
043
044
045    /**
046     * Creates a new instance of CancelFactory.
047     *
048     * @param codec The codec for this factory.
049     */
050    public CancelFactory( LdapApiService codec )
051    {
052        this.codec = codec;
053    }
054
055
056    /**
057     * {@inheritDoc}
058     */
059    @Override
060    public String getOid()
061    {
062        return CancelRequest.EXTENSION_OID;
063    }
064
065
066    /**
067     * {@inheritDoc}
068     */
069    @Override
070    public CancelResponse newResponse( byte[] encodedValue ) throws DecoderException
071    {
072        CancelResponseDecorator response = new CancelResponseDecorator( codec, new CancelResponseImpl() );
073        response.setResponseValue( encodedValue );
074
075        return response;
076    }
077
078
079    /**
080     * {@inheritDoc}
081     */
082    @Override
083    public CancelRequest newRequest( byte[] value )
084    {
085        CancelRequestDecorator req = new CancelRequestDecorator( codec, new CancelRequestImpl() );
086        req.setRequestValue( value );
087
088        return req;
089    }
090
091
092    /**
093     * {@inheritDoc}
094     */
095    @Override
096    public CancelRequestDecorator decorate( ExtendedRequest modelRequest )
097    {
098        if ( modelRequest instanceof CancelRequestDecorator )
099        {
100            return ( CancelRequestDecorator ) modelRequest;
101        }
102
103        return new CancelRequestDecorator( codec, ( CancelRequest ) modelRequest );
104    }
105
106
107    /**
108     * {@inheritDoc}
109     */
110    @Override
111    public CancelResponseDecorator decorate( ExtendedResponse decoratedMessage )
112    {
113        if ( decoratedMessage instanceof CancelResponseDecorator )
114        {
115            return ( CancelResponseDecorator ) decoratedMessage;
116        }
117
118        return new CancelResponseDecorator( codec, ( CancelResponse ) decoratedMessage );
119    }
120}