trunk/kerberos-codec/src/main/java/org/apache/directory/shared/kerberos/messages/TgsRep.java

/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you under the Apache License, Version 2.0 (the
 *  "License"); you may not use this file except in compliance
 *  with the License.  You may obtain a copy of the License at
 *  
 *    http://www.apache.org/licenses/LICENSE-2.0
 *  
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License. 
 *  
 */
package org.apache.directory.shared.kerberos.messages;


import java.nio.ByteBuffer;

import org.apache.directory.api.asn1.EncoderException;
import org.apache.directory.api.asn1.ber.tlv.TLV;
import org.apache.directory.shared.kerberos.KerberosConstants;
import org.apache.directory.shared.kerberos.KerberosMessageType;
import org.apache.directory.shared.kerberos.KerberosTime;
import org.apache.directory.shared.kerberos.components.KdcRep;
import org.apache.directory.shared.kerberos.components.PrincipalName;
import org.apache.directory.shared.kerberos.flags.TicketFlags;


/**
 * TGS-REP message. It's just a KDC-REP message with a message type set to 13.
 *  It will store the object described by the ASN.1 grammar :
 * <pre>
 * TGS-REP         ::= [APPLICATION 13] <KDC-REP>
 * </pre>
 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
 */
public class TgsRep extends KdcRep
{
    // Storage for computed lengths
    private int kdcRepLength;


    /**
     * Creates a new instance of TGS-REP.
     */
    public TgsRep()
    {
        super( KerberosMessageType.TGS_REP );
    }


    /**
     * Returns the end {@link KerberosTime}.
     *
     * @return The end {@link KerberosTime}.
     */
    public KerberosTime getEndTime()
    {
        return encKdcRepPart.getEndTime();
    }


    /**
     * Returns the {@link TicketFlags}.
     *
     * @return The {@link TicketFlags}.
     */
    public TicketFlags getFlags()
    {
        return encKdcRepPart.getFlags();
    }


    /**
     * Returns the nonce.
     *
     * @return The nonce.
     */
    public int getNonce()
    {
        return encKdcRepPart.getNonce();
    }


    /**
     * Returns the renew till {@link KerberosTime}.
     *
     * @return The renew till {@link KerberosTime}.
     */
    public KerberosTime getRenewTill()
    {
        return encKdcRepPart.getRenewTill();
    }


    /**
     * Returns the start {@link KerberosTime}.
     *
     * @return The start {@link KerberosTime}.
     */
    public KerberosTime getStartTime()
    {
        return encKdcRepPart.getStartTime();
    }


    /**
     * Returns the server {@link PrincipalName}.
     *
     * @return The server {@link PrincipalName}.
     */
    public PrincipalName getSName()
    {
        return encKdcRepPart.getSName();
    }


    /**
     * Compute the TGS-REP length
     * <pre>
     * TGS-REP :
     * 
     * 0x6D L1 TGS-REP message
     *  |
     *  +-->  0x30 L2 KDC-REP sequence
     * </pre>
     */
    public int computeLength()
    {
        kdcRepLength = super.computeLength();

        return 1 + TLV.getNbBytes( kdcRepLength ) + kdcRepLength;
    }


    /**
     * Encode the TGS-REP component
     * 
     * @param buffer The buffer containing the encoded result
     * @return The encoded component
     * @throws EncoderException If the encoding failed
     */
    public ByteBuffer encode( ByteBuffer buffer ) throws EncoderException
    {
        if ( buffer == null )
        {
            buffer = ByteBuffer.allocate( computeLength() );
        }

        // The TGS-REP SEQ Tag
        buffer.put( ( byte ) KerberosConstants.TGS_REP_TAG );
        buffer.put( TLV.getBytes( kdcRepLength ) );

        // The KDC-REP --------------------------------------------------------
        super.encode( buffer );

        return buffer;
    }
}