gurux.dlms.objects.GXDLMSScriptTable 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
Show all versions of gurux.dlms Show documentation
gurux.dlms.java package is used to communicate with DLMS devices.
//
// --------------------------------------------------------------------------
// 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.NoSuchAlgorithmException;
import java.security.SignatureException;
import java.util.ArrayList;
import java.util.List;
import javax.crypto.BadPaddingException;
import javax.crypto.IllegalBlockSizeException;
import javax.crypto.NoSuchPaddingException;
import javax.xml.stream.XMLStreamException;
import gurux.dlms.GXByteBuffer;
import gurux.dlms.GXDLMSClient;
import gurux.dlms.GXDLMSConverter;
import gurux.dlms.GXDLMSSettings;
import gurux.dlms.ValueEventArgs;
import gurux.dlms.enums.DataType;
import gurux.dlms.enums.ErrorCode;
import gurux.dlms.enums.ObjectType;
import gurux.dlms.internal.GXCommon;
import gurux.dlms.objects.enums.ScriptActionType;
/**
* Online help:
* https://www.gurux.fi/Gurux.DLMS.Objects.GXDLMSScriptTable
*/
public class GXDLMSScriptTable extends GXDLMSObject implements IGXDLMSBase {
private List scripts;
/**
* Constructor.
*/
public GXDLMSScriptTable() {
this(null, 0);
}
/**
* Constructor.
*
* @param ln
* Logical Name of the object.
*/
public GXDLMSScriptTable(final String ln) {
this(ln, 0);
}
/**
* Constructor.
*
* @param ln
* Logical Name of the object.
* @param sn
* Short Name of the object.
*/
public GXDLMSScriptTable(final String ln, final int sn) {
super(ObjectType.SCRIPT_TABLE, ln, sn);
scripts = new ArrayList();
}
public final List getScripts() {
return scripts;
}
@Override
public final Object[] getValues() {
return new Object[] { getLogicalName(), getScripts() };
}
/*
* Returns collection of attributes to read. If attribute is static and
* already read or device is returned HW error it is not returned.
*/
@Override
public final int[] getAttributeIndexToRead(final boolean all) {
java.util.ArrayList attributes =
new java.util.ArrayList();
// LN is static and read only once.
if (all || getLogicalName() == null
|| getLogicalName().compareTo("") == 0) {
attributes.add(1);
}
// Scripts
if (all || !isRead(2)) {
attributes.add(2);
}
return GXDLMSObjectHelpers.toIntArray(attributes);
}
/*
* Returns amount of attributes.
*/
@Override
public final int getAttributeCount() {
return 2;
}
/*
* Returns amount of methods.
*/
@Override
public final int getMethodCount() {
return 1;
}
@Override
public final DataType getDataType(final int index) {
if (index == 1) {
return DataType.OCTET_STRING;
}
if (index == 2) {
return DataType.ARRAY;
}
throw new IllegalArgumentException(
"getDataType failed. Invalid attribute index.");
}
/*
* Returns value of given attribute.
*/
@SuppressWarnings("deprecation")
@Override
public final Object getValue(final GXDLMSSettings settings,
final ValueEventArgs e) {
if (e.getIndex() == 1) {
return GXCommon.logicalNameToBytes(getLogicalName());
}
if (e.getIndex() == 2) {
int cnt = scripts.size();
GXByteBuffer data = new GXByteBuffer();
data.setUInt8(DataType.ARRAY.getValue());
// Add count
GXCommon.setObjectCount(cnt, data);
for (GXDLMSScript it : scripts) {
data.setUInt8(DataType.STRUCTURE.getValue());
// Count
data.setUInt8(2);
// Script_identifier:
GXCommon.setData(settings, data, DataType.UINT16, it.getId());
data.setUInt8(DataType.ARRAY.getValue());
// Count
data.setUInt8(it.getActions().size());
for (GXDLMSScriptAction a : it.getActions()) {
data.setUInt8(DataType.STRUCTURE.getValue());
data.setUInt8(5);
// service_id
GXCommon.setData(settings, data, DataType.ENUM,
a.getType().ordinal());
if (a.getTarget() == null) {
// class_id
GXCommon.setData(settings, data, DataType.UINT16,
a.getObjectType().getValue());
// logical_name
GXCommon.setData(settings, data, DataType.OCTET_STRING,
GXCommon.logicalNameToBytes(
a.getLogicalName()));
} else {
// class_id
GXCommon.setData(settings, data, DataType.UINT16,
a.getTarget().getObjectType().getValue());
// logical_name
GXCommon.setData(settings, data, DataType.OCTET_STRING,
GXCommon.logicalNameToBytes(
a.getTarget().getLogicalName()));
}
// index
GXCommon.setData(settings, data, DataType.INT8,
a.getIndex());
// parameter
GXCommon.setData(settings, data, a.getParameterType(),
a.getParameter());
}
}
return data.array();
}
e.setError(ErrorCode.READ_WRITE_DENIED);
return null;
}
/*
* Set value of given attribute.
*/
@Override
public final void setValue(final GXDLMSSettings settings,
final ValueEventArgs e) {
if (e.getIndex() == 1) {
setLogicalName(GXCommon.toLogicalName(e.getValue()));
} else if (e.getIndex() == 2) {
scripts.clear();
// Fix Xemex bug here.
// Xemex meters do not return array as they shoul be according
// standard.
if (e.getValue() instanceof List
&& !((List) e.getValue()).isEmpty()) {
if (((List) e.getValue()).get(0) instanceof List) {
for (Object item : (List) e.getValue()) {
GXDLMSScript script = new GXDLMSScript();
script.setId(
((Number) ((List) item).get(0)).intValue());
scripts.add(script);
for (Object tmp : (List) ((List) item).get(1)) {
List arr = (List) tmp;
GXDLMSScriptAction it = new GXDLMSScriptAction();
int val = ((Number) arr.get(0)).intValue();
ScriptActionType type = ScriptActionType.NONE;
// Some Iskra meters return -1 here.
// It is not standard value.
if (val > 0) {
type = ScriptActionType.values()[val];
}
it.setType(type);
ObjectType ot = ObjectType
.forValue(((Number) arr.get(1)).intValue());
String ln =
GXCommon.toLogicalName((byte[]) arr.get(2));
GXDLMSObject t =
settings.getObjects().findByLN(ot, ln);
if (t == null) {
t = GXDLMSClient.createObject(ot);
t.setLogicalName(ln);
}
it.setTarget(t);
it.setIndex(((Number) arr.get(3)).intValue());
Object param = arr.get(4);
it.setParameter(param,
GXDLMSConverter.getDLMSDataType(param));
script.getActions().add(it);
}
}
} else {
// Read Xemex meter here.
GXDLMSScript script = new GXDLMSScript();
script.setId(((Number) ((List) e.getValue()).get(0))
.intValue());
List arr = (List) ((List) e.getValue()).get(1);
GXDLMSScriptAction it = new GXDLMSScriptAction();
ScriptActionType type = ScriptActionType
.values()[((Number) arr.get(0)).intValue() - 1];
it.setType(type);
ObjectType ot = ObjectType
.forValue(((Number) arr.get(1)).intValue());
String ln = GXCommon.toLogicalName((byte[]) arr.get(2));
GXDLMSObject t = settings.getObjects().findByLN(ot, ln);
if (t == null) {
t = GXDLMSClient.createObject(ot);
t.setLogicalName(ln);
}
it.setTarget(t);
it.setIndex(((Number) arr.get(3)).intValue());
it.setParameter(((List) arr).get(4), DataType.NONE);
script.getActions().add(it);
}
}
} else {
e.setError(ErrorCode.READ_WRITE_DENIED);
}
}
/**
* Executes the script specified in parameter data.
*
* @param client
* DLMS client.
* @param script
* Executed script.
* @return Action bytes.
* @throws NoSuchPaddingException
* No such padding exception.
* @throws NoSuchAlgorithmException
* No such algorithm exception.
* @throws InvalidAlgorithmParameterException
* Invalid algorithm parameter exception.
* @throws InvalidKeyException
* Invalid key exception.
* @throws BadPaddingException
* Bad padding exception.
* @throws IllegalBlockSizeException
* Illegal block size exception.
* @throws SignatureException
* Signature exception.
*/
public final byte[][] execute(final GXDLMSClient client,
final GXDLMSScript script)
throws InvalidKeyException, NoSuchAlgorithmException,
NoSuchPaddingException, InvalidAlgorithmParameterException,
IllegalBlockSizeException, BadPaddingException, SignatureException {
return client.method(this, 1, script.getId(), DataType.UINT16);
}
/**
* Executes the script specified in parameter data.
*
* @param client
* DLMS client.
* @param scriptId
* Executed script ID.
* @return Action bytes.
* @throws NoSuchPaddingException
* No such padding exception.
* @throws NoSuchAlgorithmException
* No such algorithm exception.
* @throws InvalidAlgorithmParameterException
* Invalid algorithm parameter exception.
* @throws InvalidKeyException
* Invalid key exception.
* @throws BadPaddingException
* Bad padding exception.
* @throws IllegalBlockSizeException
* Illegal block size exception.
* @throws SignatureException
* Signature exception.
*/
public final byte[][] execute(final GXDLMSClient client, final int scriptId)
throws InvalidKeyException, NoSuchAlgorithmException,
NoSuchPaddingException, InvalidAlgorithmParameterException,
IllegalBlockSizeException, BadPaddingException, SignatureException {
return client.method(this, 1, scriptId, DataType.UINT16);
}
@Override
public final void load(final GXXmlReader reader) throws XMLStreamException {
scripts.clear();
if (reader.isStartElement("Scripts", true)) {
while (reader.isStartElement("Script", true)) {
GXDLMSScript it = new GXDLMSScript();
scripts.add(it);
it.setId(reader.readElementContentAsInt("ID"));
if (reader.isStartElement("Actions", true)) {
while (reader.isStartElement("Action", true)) {
GXDLMSScriptAction a = new GXDLMSScriptAction();
a.setType(ScriptActionType.values()[reader
.readElementContentAsInt("Type")]);
ObjectType ot = ObjectType.forValue(
reader.readElementContentAsInt("ObjectType"));
String ln = reader.readElementContentAsString("LN");
GXDLMSObject t = reader.getObjects().findByLN(ot, ln);
if (t == null) {
t = GXDLMSClient.createObject(ot);
t.setLogicalName(ln);
}
a.setTarget(t);
a.setIndex(reader.readElementContentAsInt("Index"));
DataType dt2 = DataType.forValue(reader
.readElementContentAsInt("ParameterDataType"));
a.setParameter(reader.readElementContentAsObject(
"Parameter", null, null, 0), dt2);
it.getActions().add(a);
}
reader.readEndElement("Actions");
}
}
reader.readEndElement("Scripts");
}
}
@Override
public final void save(final GXXmlWriter writer) throws XMLStreamException {
if (scripts != null) {
writer.writeStartElement("Scripts");
for (GXDLMSScript it : scripts) {
writer.writeStartElement("Script");
writer.writeElementString("ID", it.getId());
writer.writeStartElement("Actions");
for (GXDLMSScriptAction a : it.getActions()) {
writer.writeStartElement("Action");
writer.writeElementString("Type", a.getType().ordinal());
if (a.getTarget() == null) {
writer.writeElementString("ObjectType",
ObjectType.NONE.getValue());
writer.writeElementString("LN", "0.0.0.0.0.0");
writer.writeElementString("Index", "0");
writer.writeElementString("ParameterDataType",
DataType.NONE.getValue());
writer.writeElementObject("Parameter", "");
} else {
writer.writeElementString("ObjectType",
a.getTarget().getObjectType().getValue());
writer.writeElementString("LN",
a.getTarget().getLogicalName());
writer.writeElementString("Index", a.getIndex());
writer.writeElementString("ParameterDataType",
a.getParameterType().getValue());
writer.writeElementObject("Parameter",
a.getParameter());
}
writer.writeEndElement();
}
writer.writeEndElement();
writer.writeEndElement();
}
writer.writeEndElement();
}
}
@Override
public final void postLoad(final GXXmlReader reader) {
// Not needed for this object.
}
@Override
public String[] getNames() {
return new String[] { "Logical Name", "Scripts" };
}
@Override
public String[] getMethodNames() {
return new String[] { "Execute" };
}
}