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 *    https://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.codec.factory;
021
022import org.apache.directory.api.asn1.ber.tlv.BerValue;
023import org.apache.directory.api.asn1.util.Asn1Buffer;
024import org.apache.directory.api.ldap.codec.api.LdapApiService;
025import org.apache.directory.api.ldap.codec.api.LdapCodecConstants;
026import org.apache.directory.api.ldap.model.message.Message;
027import org.apache.directory.api.ldap.model.message.Referral;
028import org.apache.directory.api.ldap.model.message.SearchResultReference;
029
030/**
031 * The SearchResultReference factory.
032 *
033 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
034 */
035public final class SearchResultReferenceFactory extends ResponseFactory
036{
037    /** The static instance */
038    public static final SearchResultReferenceFactory INSTANCE = new SearchResultReferenceFactory();
039
040    private SearchResultReferenceFactory()
041    {
042        super();
043    }
044
045
046    /**
047     * Encode the SearchResultReference message to a PDU.
048     * <br>
049     * SearchResultReference :
050     * <pre>
051     * 0x73 LL
052     *   0x04 LL reference
053     *   [0x04 LL reference]*
054     * </pre>
055     *
056     * @param buffer The buffer where to put the PDU
057     * @param message the SearchResultReference to encode
058     */
059    @Override
060    public void encodeReverse( LdapApiService codec, Asn1Buffer buffer, Message message )
061    {
062        int start = buffer.getPos();
063
064        SearchResultReference searchResultReference = ( SearchResultReference ) message;
065
066        // The referrals, if any
067        Referral referral = searchResultReference.getReferral();
068
069        if ( referral != null )
070        {
071            // Each referral
072            encodeReferralUrls( buffer, referral.getLdapUrls().iterator() );
073        }
074
075        // The SearchResultEntry tag
076        BerValue.encodeSequence( buffer, LdapCodecConstants.SEARCH_RESULT_REFERENCE_TAG, start );
077    }
078}