kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/PrincipalNameType.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.server.kerberos.shared.messages.value;


import java.util.Arrays;
import java.util.Collections;
import java.util.List;


/**
 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
 * @version $Rev$, $Date$
 */
public final class PrincipalNameType implements Comparable<PrincipalNameType>
{
    /**
     * Constant for the "Name type not known" principal name type.
     */
    public static final PrincipalNameType KRB_NT_UNKNOWN = new PrincipalNameType( 0, "Name type not known." );

    /**
     * Constant for the "Just the name of the principal as in DCE, or for users" principal name type.
     */
    public static final PrincipalNameType KRB_NT_PRINCIPAL = new PrincipalNameType( 1,
        "Just the name of the principal as in DCE, or for users." );

    /**
     * Constant for the "Service and other unique instance (krbtgt)" principal name type.
     */
    public static final PrincipalNameType KRB_NT_SRV_INST = new PrincipalNameType( 2,
        "Service and other unique instance (krbtgt)." );

    /**
     * Constant for the "Service with host name as instance (telnet, rcommands)" principal name type.
     */
    public static final PrincipalNameType KRB_NT_SRV_HST = new PrincipalNameType( 3,
        "Service with host name as instance (telnet, rcommands)." );

    /**
     * Constant for the "Service with host as remaining components" principal name type.
     */
    public static final PrincipalNameType KRB_NT_SRV_XHST = new PrincipalNameType( 4,
        "Service with host as remaining components." );

    /**
     * Constant for the "Unique ID" principal name type.
     */
    public static final PrincipalNameType KRB_NT_UID = new PrincipalNameType( 5, "Unique ID." );

    /**
     * Constant for the "Encoded X.509 Distinguished name [RFC2253]" principal name type.
     */
    public static final PrincipalNameType KRB_NT_X500_PRINCIPAL = new PrincipalNameType( 6,
        "Encoded X.509 Distinguished name [RFC2253]." );

    /**
     * Constant for the "Name in form of SMTP email name (e.g., user@example.com)" principal name type.
     */
    public static final PrincipalNameType KRB_NT_SMTP_NAME = new PrincipalNameType( 7,
        "Name in form of SMTP email name (e.g., user@example.com)." );

    /**
     * Constant for the "Enterprise name; may be mapped to principal name" principal name type.
     */
    public static final PrincipalNameType KRB_NT_ENTERPRISE = new PrincipalNameType( 10,
        "Enterprise name; may be mapped to principal name." );

    /**
     * Array for building a List of VALUES.
     */
    private static final PrincipalNameType[] values =
        { KRB_NT_UNKNOWN, KRB_NT_PRINCIPAL, KRB_NT_SRV_INST, KRB_NT_SRV_HST, KRB_NT_SRV_XHST, KRB_NT_UID,
            KRB_NT_X500_PRINCIPAL, KRB_NT_SMTP_NAME, KRB_NT_ENTERPRISE };

    /**
     * A List of all the principal name type constants.
     */
    public static final List<PrincipalNameType> VALUES = Collections.unmodifiableList( Arrays.asList( values ) );

    /**
     * The name of the principal name type.
     */
    private final String name;

    /**
     * The value/code for the principal name type.
     */
    private final int ordinal;


    /**
     * Private constructor prevents construction outside of this class.
     */
    private PrincipalNameType( int ordinal, String name )
    {
        this.ordinal = ordinal;
        this.name = name;
    }


    /**
     * Returns the principal name type when specified by its ordinal.
     *
     * @param type
     * @return The principal name type.
     */
    public static PrincipalNameType getTypeByOrdinal( int type )
    {
        for ( int ii = 0; ii < values.length; ii++ )
        {
            if ( values[ii].ordinal == type )
            {
                return values[ii];
            }
        }

        return KRB_NT_UNKNOWN;
    }


    /**
     * Returns the number associated with this principal name type.
     *
     * @return The principal name type ordinal.
     */
    public int getOrdinal()
    {
        return ordinal;
    }


    public int compareTo( PrincipalNameType that )
    {
        return ordinal - that.ordinal;
    }


    public String toString()
    {
        return name + " (" + ordinal + ")";
    }
}