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    public WhoAmIFactory( LdapApiService codec )
053    {
054        this.codec = codec;
055    }
056
057
058    /**
059     * {@inheritDoc}
060     */
061    public String getOid()
062    {
063        return WhoAmIRequest.EXTENSION_OID;
064    }
065
066
067    /**
068     * {@inheritDoc}
069     */
070    public WhoAmIResponse newResponse( byte[] encodedValue ) throws DecoderException
071    {
072        WhoAmIResponseDecorator response = new WhoAmIResponseDecorator( codec,
073            new WhoAmIResponseImpl() );
074        response.setResponseValue( encodedValue );
075        return response;
076    }
077
078
079    /**
080     * {@inheritDoc}
081     */
082    public WhoAmIRequest newRequest( byte[] value )
083    {
084        WhoAmIRequestDecorator req = new WhoAmIRequestDecorator( codec, new WhoAmIRequestImpl() );
085
086        if ( value != null )
087        {
088            req.setRequestValue( value );
089        }
090
091        return req;
092    }
093
094
095    /**
096     * {@inheritDoc}
097     */
098    public WhoAmIRequestDecorator decorate( ExtendedRequest modelRequest )
099    {
100        if ( modelRequest instanceof WhoAmIRequestDecorator )
101        {
102            return ( WhoAmIRequestDecorator ) modelRequest;
103        }
104
105        return new WhoAmIRequestDecorator( codec, ( WhoAmIRequest ) modelRequest );
106    }
107
108
109    /**
110     * {@inheritDoc}
111     */
112    public WhoAmIResponseDecorator decorate( ExtendedResponse decoratedResponse )
113    {
114        if ( decoratedResponse instanceof WhoAmIResponseDecorator )
115        {
116            return ( WhoAmIResponseDecorator ) decoratedResponse;
117        }
118
119        if ( decoratedResponse instanceof WhoAmIResponse )
120        {
121            return new WhoAmIResponseDecorator( codec, ( WhoAmIResponse ) decoratedResponse );
122        }
123
124        // It's an opaque extended operation
125        @SuppressWarnings("unchecked")
126        ExtendedResponseDecorator<ExtendedResponse> response = ( ExtendedResponseDecorator<ExtendedResponse> ) decoratedResponse;
127
128        // Decode the response, as it's an opaque operation
129        Asn1Decoder decoder = new Asn1Decoder();
130
131        byte[] value = response.getResponseValue();
132        ByteBuffer buffer = ByteBuffer.wrap( value );
133
134        WhoAmIResponseContainer container = new WhoAmIResponseContainer();
135        WhoAmIResponse whoAmIResponse = null;
136
137        try
138        {
139            decoder.decode( buffer, container );
140
141            whoAmIResponse = container.getWhoAmIResponse();
142
143            // Now, update the created response with what we got from the extendedResponse
144            whoAmIResponse.getLdapResult().setResultCode( response.getLdapResult().getResultCode() );
145            whoAmIResponse.getLdapResult().setDiagnosticMessage( response.getLdapResult().getDiagnosticMessage() );
146            whoAmIResponse.getLdapResult().setMatchedDn( response.getLdapResult().getMatchedDn() );
147            whoAmIResponse.getLdapResult().setReferral( response.getLdapResult().getReferral() );
148        }
149        catch ( DecoderException de )
150        {
151            StringWriter sw = new StringWriter();
152            de.printStackTrace( new PrintWriter( sw ) );
153            String stackTrace = sw.toString();
154
155            // Error while decoding the value. 
156            whoAmIResponse = new WhoAmIResponseImpl(
157                decoratedResponse.getMessageId(),
158                ResultCodeEnum.OPERATIONS_ERROR,
159                stackTrace );
160        }
161
162        WhoAmIResponseDecorator decorated = new WhoAmIResponseDecorator( codec, whoAmIResponse );
163
164        return decorated;
165    }
166}