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