BaseOpaqueDataOption.java

/*
 * Copyright 2009-2014 Jagornet Technologies, LLC.  All Rights Reserved.
 *
 * This software is the proprietary information of Jagornet Technologies, LLC. 
 * Use is subject to license terms.
 *
 */

/*
 *   This file BaseOpaqueDataOption.java is part of Jagornet DHCP.
 *
 *   Jagornet DHCP 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.
 *
 *   Jagornet DHCP 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 Jagornet DHCP.  If not, see <http://www.gnu.org/licenses/>.
 *
 */
package com.jagornet.dhcp.option.base;

import java.io.IOException;
import java.nio.ByteBuffer;
import java.util.Arrays;

import com.jagornet.dhcp.option.DhcpComparableOption;
import com.jagornet.dhcp.option.OpaqueDataUtil;
import com.jagornet.dhcp.util.Util;
import com.jagornet.dhcp.xml.OpaqueDataOptionType;
import com.jagornet.dhcp.xml.OptionExpression;

/**
 * Title: BaseOpaqueDataOption
 * Description: The abstract base class for opaque opaqueData DHCP options.
 * 
 * @author A. Gregory Rabil
 */
public abstract class BaseOpaqueDataOption extends BaseDhcpOption implements DhcpComparableOption
{
	protected BaseOpaqueData opaqueData;
	
    /**
     * Instantiates a new opaque opaqueData option.
     */
    public BaseOpaqueDataOption()
    {
        this(null);
    }
    
    /**
     * Instantiates a new opaque opaqueData option.
     * 
     * @param opaqueDataOption the opaque opaqueData option
     */
    public BaseOpaqueDataOption(OpaqueDataOptionType opaqueDataOption)
    {
        super();
        if ((opaqueDataOption != null) && (opaqueDataOption.getOpaqueData() != null)) {
    		opaqueData = new BaseOpaqueData(opaqueDataOption.getOpaqueData());
    	}
        else {
        	opaqueData = new BaseOpaqueData();
        }
    }

	public BaseOpaqueData getOpaqueData() {
		return opaqueData;
	}

	public void setOpaqueData(BaseOpaqueData opaqueData) {
		this.opaqueData = opaqueData;
	}

	public int getLength()
    {
        return opaqueData.getLength();
    }

    /* (non-Javadoc)
     * @see com.jagornet.dhcpv6.option.Encodable#encode()
     */
    public ByteBuffer encode() throws IOException
    {
        ByteBuffer buf = super.encodeCodeAndLength();
        opaqueData.encode(buf);        
        return (ByteBuffer) buf.flip();
    }

    /* (non-Javadoc)
     * @see com.jagornet.dhcpv6.option.Decodable#decode(java.nio.ByteBuffer)
     */
    public void decode(ByteBuffer buf) throws IOException
    {
    	int len = super.decodeLength(buf); 
    	if ((len > 0) && (len <= buf.remaining())) {
            int eof = buf.position() + len;
            if (buf.position() < eof) {
            	opaqueData.decode(buf, len);
            }
        }
    }
    
    /* (non-Javadoc)
     * @see com.jagornet.dhcpv6.option.DhcpComparableOption#matches(com.jagornet.dhcp.xml.OptionExpression)
     */
    public boolean matches(OptionExpression expression)
    {
        if (expression == null)
            return false;
        if (expression.getCode() != this.getCode())
            return false;

        return OpaqueDataUtil.matches(expression, opaqueData);
    }

    /* (non-Javadoc)
     * @see java.lang.Object#equals(java.lang.Object)
     */
    @Override
    public boolean equals(Object obj)
    {
		if (this == obj)
			return true;
		if (obj == null)
			return false;
		if (getClass() != obj.getClass())
			return false;
        if (obj instanceof BaseOpaqueDataOption) {
        	BaseOpaqueDataOption that = (BaseOpaqueDataOption) obj;
        	if (that.opaqueData != null) {
	            if (opaqueData.getAscii() != null) {
	            	
	                return opaqueData.getAscii().equalsIgnoreCase(that.opaqueData.getAscii());
	            }
	            else {
	            	return Arrays.equals(opaqueData.getHex(), that.opaqueData.getHex());
	            }
        	}
        }
        return false;
    }

    /* (non-Javadoc)
     * @see java.lang.Object#toString()
     */
    public String toString()
    {
        StringBuilder sb = new StringBuilder(Util.LINE_SEPARATOR);
        sb.append(super.getName());
        sb.append(": data=");
        if(opaqueData != null)
        	sb.append(opaqueData.toString());
        return sb.toString();
    }
}