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.whoAmI;
021
022
023import java.io.PrintWriter;
024import java.io.StringWriter;
025import java.nio.ByteBuffer;
026
027import org.apache.directory.api.asn1.DecoderException;
028import org.apache.directory.api.asn1.ber.Asn1Decoder;
029import org.apache.directory.api.ldap.codec.api.ExtendedOperationFactory;
030import org.apache.directory.api.ldap.codec.api.ExtendedResponseDecorator;
031import org.apache.directory.api.ldap.codec.api.LdapApiService;
032import org.apache.directory.api.ldap.extras.extended.whoAmI.WhoAmIRequest;
033import org.apache.directory.api.ldap.extras.extended.whoAmI.WhoAmIRequestImpl;
034import org.apache.directory.api.ldap.extras.extended.whoAmI.WhoAmIResponse;
035import org.apache.directory.api.ldap.extras.extended.whoAmI.WhoAmIResponseImpl;
036import org.apache.directory.api.ldap.model.message.ExtendedRequest;
037import org.apache.directory.api.ldap.model.message.ExtendedResponse;
038import org.apache.directory.api.ldap.model.message.ResultCodeEnum;
039
040
041/**
042 * An {@link ExtendedOperationFactory} for creating WhoAmI extended request response 
043 * pairs.
044 *
045 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
046 */
047public class WhoAmIFactory implements ExtendedOperationFactory
048{
049    private LdapApiService codec;
050
051
052    /**
053     * Creates a new instance of WhoAmIFactory.
054     *
055     * @param codec The codec for this factory.
056     */
057    public WhoAmIFactory( LdapApiService codec )
058    {
059        this.codec = codec;
060    }
061
062
063    /**
064     * {@inheritDoc}
065     */
066    @Override
067    public String getOid()
068    {
069        return WhoAmIRequest.EXTENSION_OID;
070    }
071
072
073    /**
074     * {@inheritDoc}
075     */
076    @Override
077    public WhoAmIResponse newResponse( byte[] encodedValue ) throws DecoderException
078    {
079        WhoAmIResponseDecorator response = new WhoAmIResponseDecorator( codec,
080            new WhoAmIResponseImpl() );
081        response.setResponseValue( encodedValue );
082        return response;
083    }
084
085
086    /**
087     * {@inheritDoc}
088     */
089    @Override
090    public WhoAmIRequest newRequest( byte[] value )
091    {
092        WhoAmIRequestDecorator req = new WhoAmIRequestDecorator( codec, new WhoAmIRequestImpl() );
093
094        if ( value != null )
095        {
096            req.setRequestValue( value );
097        }
098
099        return req;
100    }
101
102
103    /**
104     * {@inheritDoc}
105     */
106    @Override
107    public WhoAmIRequestDecorator decorate( ExtendedRequest modelRequest )
108    {
109        if ( modelRequest instanceof WhoAmIRequestDecorator )
110        {
111            return ( WhoAmIRequestDecorator ) modelRequest;
112        }
113
114        return new WhoAmIRequestDecorator( codec, ( WhoAmIRequest ) modelRequest );
115    }
116
117
118    /**
119     * {@inheritDoc}
120     */
121    @Override
122    public WhoAmIResponseDecorator decorate( ExtendedResponse decoratedResponse )
123    {
124        if ( decoratedResponse instanceof WhoAmIResponseDecorator )
125        {
126            return ( WhoAmIResponseDecorator ) decoratedResponse;
127        }
128
129        if ( decoratedResponse instanceof WhoAmIResponse )
130        {
131            return new WhoAmIResponseDecorator( codec, ( WhoAmIResponse ) decoratedResponse );
132        }
133
134        // It's an opaque extended operation
135        @SuppressWarnings("unchecked")
136        ExtendedResponseDecorator<ExtendedResponse> response = ( ExtendedResponseDecorator<ExtendedResponse> ) decoratedResponse;
137
138        // Decode the response, as it's an opaque operation
139        Asn1Decoder decoder = new Asn1Decoder();
140
141        byte[] value = response.getResponseValue();
142        ByteBuffer buffer = ByteBuffer.wrap( value );
143
144        WhoAmIResponseContainer container = new WhoAmIResponseContainer();
145        WhoAmIResponse whoAmIResponse = null;
146
147        try
148        {
149            decoder.decode( buffer, container );
150
151            whoAmIResponse = container.getWhoAmIResponse();
152
153            // Now, update the created response with what we got from the extendedResponse
154            whoAmIResponse.getLdapResult().setResultCode( response.getLdapResult().getResultCode() );
155            whoAmIResponse.getLdapResult().setDiagnosticMessage( response.getLdapResult().getDiagnosticMessage() );
156            whoAmIResponse.getLdapResult().setMatchedDn( response.getLdapResult().getMatchedDn() );
157            whoAmIResponse.getLdapResult().setReferral( response.getLdapResult().getReferral() );
158        }
159        catch ( DecoderException de )
160        {
161            StringWriter sw = new StringWriter();
162            de.printStackTrace( new PrintWriter( sw ) );
163            String stackTrace = sw.toString();
164
165            // Error while decoding the value. 
166            whoAmIResponse = new WhoAmIResponseImpl(
167                decoratedResponse.getMessageId(),
168                ResultCodeEnum.OPERATIONS_ERROR,
169                stackTrace );
170        }
171
172        return new WhoAmIResponseDecorator( codec, whoAmIResponse );
173    }
174}