com.veraxsystems.vxipmi.coding.Decoder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of vxIPMI Show documentation
The newest version!
/*
 * Decoder.java 
 * Created on 2011-07-21
 *
 * Copyright (c) Verax Systems 2011.
 * All rights reserved.
 *
 * This software is furnished under a license. Use, duplication,
 * disclosure and all other uses are restricted to the rights
 * specified in the written license agreement.
 */
package com.veraxsystems.vxipmi.coding;

import com.veraxsystems.vxipmi.coding.commands.ResponseData;
import com.veraxsystems.vxipmi.coding.payload.CompletionCode;
import com.veraxsystems.vxipmi.coding.payload.lan.IPMIException;
import com.veraxsystems.vxipmi.coding.protocol.decoder.IpmiDecoder;
import com.veraxsystems.vxipmi.coding.protocol.decoder.PlainCommandv20Decoder;
import com.veraxsystems.vxipmi.coding.protocol.decoder.Protocolv15Decoder;
import com.veraxsystems.vxipmi.coding.protocol.decoder.Protocolv20Decoder;
import com.veraxsystems.vxipmi.coding.rmcp.RmcpDecoder;

import java.security.InvalidKeyException;
import java.security.NoSuchAlgorithmException;

/**
 * Decodes RMCP packet into {@link ResponseData}.
 */
public final class Decoder {

    /**
     * Decodes raw data into {@link ResponseData} - a wrapper class for
     * message-specific response data.
     *
     * @param data
     *            raw RMCP packet to be decoded
     * @param protocolDecoder
     *            instance of {@link IpmiDecoder} class for decoding of the
     *            IPMI session header and (if present) IPMI LAN packet. If IPMI
     *            LAN packet is present, {@link Protocolv15Decoder} or
     *            {@link Protocolv20Decoder} should be used (depending on IPMI
     *            protocol version used). Otherwise,
     *            {@link PlainCommandv20Decoder} should be used.
     * @param payloadCoder
     *            instance of {@link PayloadCoder} class used for wrapping
     *            payload into message-dependent {@link ResponseData} object.
     * @return {@link ResponseData}
     * @throws IPMIException
     *             when request to the server fails.
     * @see CompletionCode
     * @throws IllegalArgumentException
     *             when data is corrupted
     * @throws NoSuchAlgorithmException
     *             when authentication, confidentiality or integrity algorithm
     *             fails.
     * @throws InvalidKeyException
     *             when creating of the authentication algorithm key fails
     */
    public static ResponseData decode(byte[] data, IpmiDecoder protocolDecoder,
            PayloadCoder payloadCoder) throws IPMIException, NoSuchAlgorithmException, InvalidKeyException {
        return payloadCoder.getResponseData(protocolDecoder.decode(RmcpDecoder
                .decode(data)));
    }

    private Decoder() {
    }
}