MatchingSnmpInterfacePolicy.java

/*******************************************************************************
 * This file is part of OpenNMS(R).
 *
 * Copyright (C) 2009-2011 The OpenNMS Group, Inc.
 * OpenNMS(R) is Copyright (C) 1999-2011 The OpenNMS Group, Inc.
 *
 * OpenNMS(R) is a registered trademark of The OpenNMS Group, Inc.
 *
 * OpenNMS(R) is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published
 * by the Free Software Foundation, either version 3 of the License,
 * or (at your option) any later version.
 *
 * OpenNMS(R) is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with OpenNMS(R).  If not, see:
 *      http://www.gnu.org/licenses/
 *
 * For more information contact:
 *     OpenNMS(R) Licensing <license@opennms.org>
 *     http://www.opennms.org/
 *     http://www.opennms.com/
 *******************************************************************************/

package org.opennms.netmgt.provision.persist.policies;


import org.opennms.core.utils.LogUtils;
import org.opennms.netmgt.model.OnmsSnmpInterface;
import org.opennms.netmgt.provision.BasePolicy;
import org.opennms.netmgt.provision.SnmpInterfacePolicy;
import org.opennms.netmgt.provision.annotations.Policy;
import org.opennms.netmgt.provision.annotations.Require;
import org.springframework.context.annotation.Scope;
import org.springframework.stereotype.Component;

@Component
/**
 * <p>MatchingSnmpInterfacePolicy class.</p>
 *
 * @author ranger
 * @version $Id: $
 */
@Scope("prototype")
@Policy("Match SNMP Interface")
public class MatchingSnmpInterfacePolicy extends BasePolicy<OnmsSnmpInterface> implements SnmpInterfacePolicy {
    
    public static enum Action { ENABLE_COLLECTION, DISABLE_COLLECTION, DO_NOT_PERSIST, ENABLE_POLLING, DISABLE_POLLING };
    
    private Action m_action = Action.DO_NOT_PERSIST;

    /**
     * <p>getAction</p>
     *
     * @return a {@link java.lang.String} object.
     */
    @Require({"ENABLE_COLLECTION", "DISABLE_COLLECTION", "DO_NOT_PERSIST", "ENABLE_POLLING", "DISABLE_POLLING"})
    public String getAction() {
        return m_action.toString();
    }
    
    /**
     * <p>setAction</p>
     *
     * @param action a {@link java.lang.String} object.
     */
    public void setAction(String action) {
        if (action != null && action.toUpperCase().equals("ENABLE_COLLECTION")) {
            m_action = Action.ENABLE_COLLECTION;
        } else if (action != null && action.toUpperCase().equals("DISABLE_COLLECTION")) {
            m_action = Action.DISABLE_COLLECTION;
        } else if (action != null && action.toUpperCase().equals("ENABLE_POLLING")) {
            m_action = Action.ENABLE_POLLING;
        } else if (action != null && action.toUpperCase().equals("DISABLE_POLLING")) {
            m_action = Action.DISABLE_POLLING;
        } else {
            m_action = Action.DO_NOT_PERSIST;
        }
    }
    
    /** {@inheritDoc} */
    @Override
    public OnmsSnmpInterface act(OnmsSnmpInterface iface) {
        switch (m_action) {
        case DO_NOT_PERSIST: 
            LogUtils.debugf(this, "NOT Persisting %s according to policy", iface);
            return null;
        case DISABLE_COLLECTION:
            iface.setCollectionEnabled(false);
            LogUtils.debugf(this, "Disabled collection for %s according to policy", iface);
            return iface;
        case ENABLE_COLLECTION:
            iface.setCollectionEnabled(true);
            LogUtils.debugf(this, "Enabled collection for %s according to policy", iface);
            return iface;
        case ENABLE_POLLING:
            iface.setPoll("P");
            LogUtils.debugf(this, "Enabled polling for %s according to policy", iface);
            return iface;
        case DISABLE_POLLING:
            iface.setPoll("N");
            LogUtils.debugf(this, "Disabled polling for %s according to policy", iface);
            return iface;
        default:
            return iface;    
        }
    }
    
    /**
     * <p>getIfDescr</p>
     *
     * @return a {@link java.lang.String} object.
     */
    public String getIfDescr() {
        return getCriteria("ifDescr");
    }

    /**
     * <p>setIfDescr</p>
     *
     * @param ifDescr a {@link java.lang.String} object.
     */
    public void setIfDescr(String ifDescr) {
        putCriteria("ifDescr", ifDescr);
    }

    /**
     * <p>getIfName</p>
     *
     * @return a {@link java.lang.String} object.
     */
    public String getIfName() {
        return getCriteria("ifName");
    }

    /**
     * <p>setIfName</p>
     *
     * @param ifName a {@link java.lang.String} object.
     */
    public void setIfName(String ifName) {
        putCriteria("ifName", ifName);
    }

    /**
     * <p>getIfType</p>
     *
     * @return a {@link java.lang.String} object.
     */
    public String getIfType() {
        return getCriteria("ifType");
    }

    /**
     * <p>setIfType</p>
     *
     * @param ifType a {@link java.lang.String} object.
     */
    public void setIfType(String ifType) {
        putCriteria("ifType", ifType);
    }

    /**
     * <p>getPhysAddr</p>
     *
     * @return a {@link java.lang.String} object.
     */
    public String getPhysAddr() {
        return getCriteria("physAddr");
    }

    /**
     * <p>setPhysAddr</p>
     *
     * @param physAddr a {@link java.lang.String} object.
     */
    public void setPhysAddr(String physAddr) {
        putCriteria("physAddr", physAddr);
    }

    /**
     * <p>getIfIndex</p>
     *
     * @return a {@link java.lang.String} object.
     */
    public String getIfIndex() {
        return getCriteria("ifIndex");
    }

    /**
     * <p>setIfIndex</p>
     *
     * @param ifIndex a {@link java.lang.String} object.
     */
    public void setIfIndex(String ifIndex) {
        putCriteria("ifIndex", ifIndex);
    }

    /**
     * <p>getIfSpeed</p>
     *
     * @return a {@link java.lang.String} object.
     */
    public String getIfSpeed() {
        return getCriteria("ifSpeed");
    }

    /**
     * <p>setIfSpeed</p>
     *
     * @param ifSpeed a {@link java.lang.String} object.
     */
    public void setIfSpeed(String ifSpeed) {
        putCriteria("ifSpeed", ifSpeed);
    }

    /**
     * <p>getIfAdminStatus</p>
     *
     * @return a {@link java.lang.String} object.
     */
    public String getIfAdminStatus() {
        return getCriteria("ifAdminStatus");
    }

    /**
     * <p>setIfAdminStatus</p>
     *
     * @param ifAdminStatus a {@link java.lang.String} object.
     */
    public void setIfAdminStatus(String ifAdminStatus) {
        putCriteria("ifAdminStatus", ifAdminStatus);
    }

    /**
     * <p>getIfOperStatus</p>
     *
     * @return a {@link java.lang.String} object.
     */
    public String getIfOperStatus() {
        return getCriteria("ifOperStatus");
    }

    /**
     * <p>setIfOperStatus</p>
     *
     * @param ifOperStatus a {@link java.lang.String} object.
     */
    public void setIfOperStatus(String ifOperStatus) {
        putCriteria("ifOperStatus", ifOperStatus);
    }

    /**
     * <p>getIfAlias</p>
     *
     * @return a {@link java.lang.String} object.
     */
    public String getIfAlias() {
        return getCriteria("ifAlias");
    }

    /**
     * <p>setIfAlias</p>
     *
     * @param ifAlias a {@link java.lang.String} object.
     */
    public void setIfAlias(String ifAlias) {
        putCriteria("ifAlias", ifAlias);
    }
    
    
}