gurux.dlms.objects.IGXDLMSBase Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gurux.dlms Show documentation
gurux.dlms.java package is used to communicate with DLMS devices.
The newest version!
//
// --------------------------------------------------------------------------
//  Gurux Ltd
// 
//
//
// Filename:        $HeadURL$
//
// Version:         $Revision$,
//                  $Date$
//                  $Author$
//
// Copyright (c) Gurux Ltd
//
//---------------------------------------------------------------------------
//
//  DESCRIPTION
//
// This file is a part of Gurux Device Framework.
//
// Gurux Device Framework is Open Source 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; version 2 of the License.
// Gurux Device Framework 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.
//
// More information of Gurux products: https://www.gurux.org
//
// This code is licensed under the GNU General Public License v2. 
// Full text may be retrieved at http://www.gnu.org/licenses/gpl-2.0.txt
//---------------------------------------------------------------------------

package gurux.dlms.objects;

import java.security.InvalidAlgorithmParameterException;
import java.security.InvalidKeyException;
import java.security.SignatureException;

import javax.crypto.BadPaddingException;
import javax.crypto.IllegalBlockSizeException;
import javax.crypto.NoSuchPaddingException;
import javax.xml.stream.XMLStreamException;

import gurux.dlms.GXDLMSSettings;
import gurux.dlms.ValueEventArgs;

public interface IGXDLMSBase {

	/**
	 * Returns collection of attributes to read. If attribute is static and already
	 * read or device is returned HW error it is not returned.
	 * 
	 * @param all All are attributes get.
	 * @return Collection of attributes to read.
	 */
	int[] getAttributeIndexToRead(boolean all);

	/**
	 * @return Amount of attributes.
	 */
	int getAttributeCount();

	/**
	 * @return Amount of methods.
	 */
	int getMethodCount();

	/**
	 * @return Returns names of attribute indexes.
	 */
	String[] getNames();

	/**
	 * 
	 * @return Returns names of method indexes.
	 */
	String[] getMethodNames();

	/**
	 * Returns value of given attribute.
	 * 
	 * @param settings DLMS settings.
	 * @param e        Get parameter.
	 * @return Returned value.
	 */
	Object getValue(GXDLMSSettings settings, ValueEventArgs e);

	/**
	 * Set value of given attribute.
	 * 
	 * @param settings DLMS settings.
	 * @param e        Set parameter.
	 */
	void setValue(GXDLMSSettings settings, ValueEventArgs e);

	/**
	 * Server calls invoke method.
	 * 
	 * @param settings Server settings.
	 * @param e        Invoke parameter.
	 * @return Reply for the client.
	 * @throws NoSuchPaddingException             No such padding exception.
	 * @throws InvalidAlgorithmParameterException Invalid algorithm parameter
	 *                                            exception.
	 * @throws InvalidKeyException                Invalid key exception.
	 * @throws BadPaddingException                Bad padding exception.
	 * @throws SignatureException                 Signature exception.
	 * @throws IllegalBlockSizeException          Illegal block size exception.
	 */
	byte[] invoke(GXDLMSSettings settings, ValueEventArgs e) throws InvalidKeyException, NoSuchPaddingException,
			InvalidAlgorithmParameterException, IllegalBlockSizeException, BadPaddingException, SignatureException;

	/**
	 * Load object content from XML.
	 * 
	 * @param reader XML reader.
	 * @throws XMLStreamException XML stream exception.
	 */
	void load(GXXmlReader reader) throws XMLStreamException;

	/**
	 * Save object content to XML.
	 * 
	 * @param writer XML writer.
	 * @throws XMLStreamException XML stream exception.
	 */
	void save(GXXmlWriter writer) throws XMLStreamException;

	/**
	 * Handle actions after Load.
	 * 
	 * @param reader XML reader.
	 */
	void postLoad(GXXmlReader reader);
}