com.veraxsystems.vxipmi.coding.commands.sdr.GetSdrRepositoryInfo 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!
/*
 * GetSdrRepositoryInfo.java 
 * Created on 2011-08-03
 *
 * 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.commands.sdr;

import com.veraxsystems.vxipmi.coding.commands.CommandCodes;
import com.veraxsystems.vxipmi.coding.commands.IpmiCommandCoder;
import com.veraxsystems.vxipmi.coding.commands.IpmiVersion;
import com.veraxsystems.vxipmi.coding.commands.ResponseData;
import com.veraxsystems.vxipmi.coding.payload.CompletionCode;
import com.veraxsystems.vxipmi.coding.payload.IpmiPayload;
import com.veraxsystems.vxipmi.coding.payload.lan.IPMIException;
import com.veraxsystems.vxipmi.coding.payload.lan.IpmiLanRequest;
import com.veraxsystems.vxipmi.coding.payload.lan.IpmiLanResponse;
import com.veraxsystems.vxipmi.coding.payload.lan.NetworkFunction;
import com.veraxsystems.vxipmi.coding.protocol.AuthenticationType;
import com.veraxsystems.vxipmi.coding.protocol.IpmiMessage;
import com.veraxsystems.vxipmi.coding.security.CipherSuite;
import com.veraxsystems.vxipmi.common.TypeConverter;

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

/**
 * A wrapper class for Get SDR Repository Info Command. 

 * This command returns the SDR command version for the SDR Repository. It also
 * returns a timestamp for when the last ADD, DELETE, or CLEAR occurred.
 */
public class GetSdrRepositoryInfo extends IpmiCommandCoder {

    /**
     * Initiates GetSdrRepositoryInfo for both encoding and decoding.
     *
     * @param version
     *            IPMI version of the command.
     * @param cipherSuite
     *            {@link CipherSuite} containing authentication,
     *            confidentiality and integrity algorithms for this session.
     * @param authenticationType
     *            Type of authentication used. Must be RMCPPlus for IPMI v2.0.
     */
    public GetSdrRepositoryInfo(IpmiVersion version, CipherSuite cipherSuite,
            AuthenticationType authenticationType) {
        super(version, cipherSuite, authenticationType);
    }

    @Override
    public byte getCommandCode() {
        return CommandCodes.GET_SDR_REPOSITORY_INFO;
    }

    @Override
    public NetworkFunction getNetworkFunction() {
        return NetworkFunction.StorageRequest;
    }

    @Override
    protected IpmiPayload preparePayload(int sequenceNumber)
            throws NoSuchAlgorithmException, InvalidKeyException {
        return new IpmiLanRequest(getNetworkFunction(), getCommandCode(), null,
                TypeConverter.intToByte(sequenceNumber));
    }

    @Override
    public ResponseData getResponseData(IpmiMessage message) throws IPMIException, NoSuchAlgorithmException, InvalidKeyException {
        if (!isCommandResponse(message)) {
            throw new IllegalArgumentException(
                    "This is not a response for Get SDR Repository Info command");
        }
        if (!(message.getPayload() instanceof IpmiLanResponse)) {
            throw new IllegalArgumentException("Invalid response payload");
        }
        if (((IpmiLanResponse) message.getPayload()).getCompletionCode() != CompletionCode.Ok) {
            throw new IPMIException(
                    ((IpmiLanResponse) message.getPayload())
                            .getCompletionCode());
        }

        byte[] raw = message.getPayload().getIpmiCommandData();

        if (raw == null || raw.length != 14) {
            throw new IllegalArgumentException(
                    "Invalid response payload length");
        }

        GetSdrRepositoryInfoResponseData responseData = new GetSdrRepositoryInfoResponseData();

        responseData.setSdrVersion(TypeConverter
                .littleEndianBcdByteToInt(raw[0]));

        byte[] buffer = new byte[4];

        buffer[0] = raw[1];
        buffer[1] = raw[2];
        buffer[2] = 0;
        buffer[3] = 0;

        responseData.setRecordCount(TypeConverter
                .littleEndianByteArrayToInt(buffer));

        System.arraycopy(raw, 5, buffer, 0, 4);

        responseData.setAddTimestamp(TypeConverter
                .littleEndianByteArrayToInt(buffer));

        System.arraycopy(raw, 9, buffer, 0, 4);

        responseData.setDelTimestamp(TypeConverter
                .littleEndianByteArrayToInt(buffer));

        responseData
                .setReserveSupported((TypeConverter.byteToInt(raw[13]) & 0x2) != 0);

        return responseData;
    }

}