//
// Copyright (c) 2005 PortWise AB. All rights reserved.
//
// This software is the confidential and proprietary information of
// PortWise AB. ("Confidential Information"). You shall not disclose
// such Confidential Information and shall use it only in accordance
// with the terms of the agreement you entered into with PortWise AB.
//
// Warning: This computer program is protected by copyright law and
// international treaties. Unauthorized reproduction or distribution
// of this program, or any portion of it, may result in severe civil
// and criminal penalties, and will be prosecuted to the maximum
// extent possible under law.
//

package com.portwise.xpi.epi.plugins.mac;

/**
 * This class defines what properties the plug-in is using. The class also defines the display order
 * of the properties used.
 * 

 * This plug-in will verify a clients MAC address. The properties used by the plug-in is a default
 * error message, a checkbox that defines if we should use an error message defined by the
 * administrator or an error message compiled by the plug-in itself. The final property the plug-in
 * is using is a string defining what MAC addresses are valid for this access rule.
 * 
 * @author PortWise AB
 */
public interface AssessMACPluginProperties
{
    /**
     * The string definition of the property holding the string defining what MAC addresses that are
     * valid.
     */
    static final String   MAC_ADDRESSES            = "mac-addresses";

    /**
     * A string definition of the property holding the variable that defines if the plug-in should
     * use an error message defined by the administrator or if the plug-in should compile an error
     * message.
     */
    static final String   USE_DEFAULT_MESSAGE      = "use-default-message";

    /** A string definition of the property holding a default error message for the plug-in. */
    static final String   DEFAULT_MESSAGE          = "default-message";


    /**
     * The identifier for the property holding the string defining what MAC addresses that are
     * valid.
     */
    static final int      ENUM_MAC_ADDRESSES       = 1;

    /**
     * The identifier for the property holding the variable that defines if the plug-in should use
     * an error message defined by the administrator or if the plug-in should compile an error
     * message.
     */
    static final int      ENUM_USE_DEFAULT_MESSAGE = 2;

    /** The identifier of the property holding a default error message for the plug-in */
    static final int      ENUM_DEFAULT_MESSAGE     = 3;


    /** Array with property keys in order of presentation. */
    static final String[] PROPERTY_KEYS            = {
        MAC_ADDRESSES, USE_DEFAULT_MESSAGE, DEFAULT_MESSAGE
                                                   };

    /**
     * Array with property enumeration for mapping one property to a given id. Used for switch
     * statements in code, instead of using .equals() for all strings.
     */
    static final int[]    PROPERTY_ENUMS           = {
        ENUM_MAC_ADDRESSES, ENUM_USE_DEFAULT_MESSAGE, ENUM_DEFAULT_MESSAGE
                                                   };
}