SnmpModuleIdentity.java

/*
 * Mibble MIB Parser (www.mibble.org)
 *
 * See LICENSE.txt for licensing information.
 *
 * Copyright (c) 2004-2017 Per Cederberg. All rights reserved.
 */

package net.percederberg.mibble.snmp;

import java.util.ArrayList;

import net.percederberg.mibble.MibException;
import net.percederberg.mibble.MibLoaderLog;
import net.percederberg.mibble.MibSymbol;
import net.percederberg.mibble.MibType;
import net.percederberg.mibble.MibValue;
import net.percederberg.mibble.MibValueSymbol;
import net.percederberg.mibble.value.ObjectIdentifierValue;

/**
 * The SNMP module identity macro type. This macro type was added
 * to SMIv2 and is defined in RFC 2578.
 *
 * @see <a href="http://www.ietf.org/rfc/rfc2578.txt">RFC 2578 (SNMPv2-SMI)</a>
 *
 * @author   Per Cederberg
 * @version  2.10
 * @since    2.0
 */
public class SnmpModuleIdentity extends SnmpType {

    /**
     * The last updated date.
     */
    private String lastUpdated;

    /**
     * The organization name.
     */
    private String organization;

    /**
     * The organization contact information.
     */
    private String contactInfo;

    /**
     * The list of SNMP revision objects.
     */
    private ArrayList<SnmpRevision> revisions;

    /**
     * Creates a new SNMP module identity.
     *
     * @param lastUpdated    the last updated date
     * @param organization   the organization name
     * @param contactInfo    the organization contact information
     * @param description    the module description
     * @param revisions      the list of module revisions
     */
    public SnmpModuleIdentity(String lastUpdated,
                              String organization,
                              String contactInfo,
                              String description,
                              ArrayList<SnmpRevision> revisions) {

        super("MODULE-IDENTITY", description);
        this.lastUpdated = lastUpdated;
        this.organization = organization;
        this.contactInfo = contactInfo;
        this.revisions = revisions;
    }

    /**
     * Initializes the MIB type. This will remove all levels of
     * indirection present, such as references to types or values. No
     * information is lost by this operation. This method may modify
     * this object as a side-effect, and will return the basic
     * type.<p>
     *
     * <strong>NOTE:</strong> This is an internal method that should
     * only be called by the MIB loader.
     *
     * @param symbol         the MIB symbol containing this type
     * @param log            the MIB loader log
     *
     * @return the basic MIB type
     *
     * @throws MibException if an error was encountered during the
     *             initialization
     *
     * @since 2.2
     */
    public MibType initialize(MibSymbol symbol, MibLoaderLog log)
        throws MibException {

        if (!(symbol instanceof MibValueSymbol)) {
            throw new MibException(symbol.getFileRef(),
                                   "only values can have the " +
                                   getName() + " type");
        }
        for (SnmpRevision rev : revisions) {
            rev.initialize(log);
        }
        return this;
    }

    /**
     * Checks if the specified value is compatible with this type. A
     * value is compatible if and only if it is an object identifier
     * value.
     *
     * @param value          the value to check
     *
     * @return true if the value is compatible, or
     *         false otherwise
     */
    public boolean isCompatible(MibValue value) {
        return value instanceof ObjectIdentifierValue;
    }

    /**
     * Returns the last updated date.
     *
     * @return the last updated date
     */
    public String getLastUpdated() {
        return lastUpdated;
    }

    /**
     * Returns the organization name.
     *
     * @return the organization name
     */
    public String getOrganization() {
        return organization;
    }

    /**
     * Returns the organization contact information. Any unneeded
     * indentation will be removed from the text, and it also
     * replaces all tab characters with 8 spaces.
     *
     * @return the organization contact information
     *
     * @see #getUnformattedContactInfo()
     */
    public String getContactInfo() {
        return removeIndent(contactInfo);
    }

    /**
     * Returns the unformatted organization contact information. This
     * method returns the original MIB file content, without removing
     * unneeded indentation or similar.
     *
     * @return the unformatted organization contact information.
     *
     * @see #getContactInfo()
     *
     * @since 2.6
     */
    public String getUnformattedContactInfo() {
        return contactInfo;
    }

    /**
     * Returns a list of all the SNMP module revisions. The returned
     * list will consist of SnmpRevision instances.
     *
     * @return a list of all the SNMP module revisions
     *
     * @see SnmpRevision
     */
    public ArrayList<SnmpRevision> getRevisions() {
        return revisions;
    }

    /**
     * Returns a string representation of this object.
     *
     * @return a string representation of this object
     */
    public String toString() {
        StringBuilder buffer = new StringBuilder();
        buffer.append(super.toString());
        buffer.append(" (");
        buffer.append("\n  Last Updated: ");
        buffer.append(lastUpdated);
        buffer.append("\n  Organization: ");
        buffer.append(organization);
        buffer.append("\n  Contact Info: ");
        buffer.append(contactInfo);
        buffer.append("\n  Description: ");
        buffer.append(getDescription("               "));
        for (SnmpRevision rev : revisions) {
            buffer.append("\n  Revision: ");
            buffer.append(rev);
        }
        buffer.append("\n)");
        return buffer.toString();
    }
}