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.extras.controls.ppolicy_impl;
021
022
023import org.apache.directory.api.asn1.DecoderException;
024import org.apache.directory.api.asn1.ber.tlv.BerValue;
025import org.apache.directory.api.asn1.util.Asn1Buffer;
026import org.apache.directory.api.ldap.codec.api.AbstractControlFactory;
027import org.apache.directory.api.ldap.codec.api.ControlFactory;
028import org.apache.directory.api.ldap.codec.api.LdapApiService;
029import org.apache.directory.api.ldap.extras.controls.ppolicy.PasswordPolicyResponse;
030import org.apache.directory.api.ldap.extras.controls.ppolicy.PasswordPolicyResponseImpl;
031import org.apache.directory.api.ldap.model.message.Control;
032
033
034/**
035 * A {@link ControlFactory} which creates {@link PasswordPolicyResponse} controls.
036 *
037 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
038 * @version $Rev$, $Date$
039 */
040public class PasswordPolicyResponseFactory extends AbstractControlFactory<PasswordPolicyResponse>
041{
042    /**
043     * Creates a new instance of PasswordPolicyResponseFactory.
044     *
045     * @param codec The LDAP Service to use
046     */
047    public PasswordPolicyResponseFactory( LdapApiService codec )
048    {
049        super( codec, PasswordPolicyResponse.OID );
050    }
051
052
053    /**
054     * {@inheritDoc}
055     */
056    @Override
057    public PasswordPolicyResponse newControl()
058    {
059        return new PasswordPolicyResponseImpl();
060    }
061
062
063    /**
064     * {@inheritDoc}
065     */
066    @Override
067    public void encodeValue( Asn1Buffer buffer, Control control )
068    {
069        int start = buffer.getPos();
070        PasswordPolicyResponse ppResponse = ( PasswordPolicyResponse ) control;
071        
072        if ( ( ppResponse.getTimeBeforeExpiration() >= 0 ) || ( ppResponse.getGraceAuthNRemaining() >= 0 ) 
073            || ( ppResponse.getPasswordPolicyError() != null ) )
074        {
075            if ( ppResponse.getPasswordPolicyError() != null )
076            {
077                BerValue.encodeEnumerated( 
078                    buffer,
079                    ( byte ) PasswordPolicyTags.PPOLICY_ERROR_TAG.getValue(),
080                    ppResponse.getPasswordPolicyError().getValue() );
081            }
082
083            boolean warning = false;
084            int startWarning = buffer.getPos();
085
086            if ( ppResponse.getGraceAuthNRemaining() >= 0 )
087            {
088                BerValue.encodeInteger( buffer, 
089                    ( byte ) PasswordPolicyTags.GRACE_AUTHNS_REMAINING_TAG.getValue(),
090                    ppResponse.getGraceAuthNRemaining() );
091                
092                warning = true;
093            }
094            else if ( ppResponse.getTimeBeforeExpiration() >= 0 )
095            {
096                BerValue.encodeInteger( buffer, 
097                    ( byte ) PasswordPolicyTags.TIME_BEFORE_EXPIRATION_TAG.getValue(),
098                    ppResponse.getTimeBeforeExpiration() );
099                
100                warning = true;
101            }
102            
103            if ( warning )
104            {
105                BerValue.encodeSequence( buffer, 
106                    ( byte ) PasswordPolicyTags.PPOLICY_WARNING_TAG.getValue(), startWarning );
107            }
108        }
109        
110        // The sequence
111        BerValue.encodeSequence( buffer, start );
112    }
113
114
115    /**
116     * {@inheritDoc}
117     */
118    @Override
119    public void decodeValue( Control control, byte[] controlBytes ) throws DecoderException
120    {
121        decodeValue( new PasswordPolicyResponseContainer( control ), control, controlBytes );
122    }
123}