gurux.dlms.objects.GXDLMSIp4Setup 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.net.InetAddress;
import java.net.UnknownHostException;
import java.util.ArrayList;
import java.util.List;
import javax.xml.stream.XMLStreamException;
import gurux.dlms.GXByteBuffer;
import gurux.dlms.GXDLMSSettings;
import gurux.dlms.GXDLMSTranslator;
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.Ip4SetupIpOptionType;
/**
* Online help:
* https://www.gurux.fi/Gurux.DLMS.Objects.GXDLMSIp4Setup
*/
public class GXDLMSIp4Setup extends GXDLMSObject implements IGXDLMSBase {
private String dataLinkLayerReference;
private InetAddress ipAddress;
private InetAddress[] multicastIPAddress;
private GXDLMSIp4SetupIpOption[] ipOptions;
private String subnetMask;
private InetAddress gatewayIPAddress;
private boolean useDHCP;
private InetAddress primaryDNSAddress;
private InetAddress secondaryDNSAddress;
/**
* Constructor.
*/
public GXDLMSIp4Setup() {
this("0.0.25.1.0.255");
}
/**
* Constructor.
*
* @param ln Logical Name of the object.
*/
public GXDLMSIp4Setup(final String ln) {
this(ln, 0);
}
/**
* Constructor.
*
* @param ln Logical Name of the object.
* @param sn Short Name of the object.
*/
public GXDLMSIp4Setup(final String ln, final int sn) {
super(ObjectType.IP4_SETUP, ln, sn);
}
public final String getDataLinkLayerReference() {
return dataLinkLayerReference;
}
public final void setDataLinkLayerReference(final String value) {
dataLinkLayerReference = value;
}
public final InetAddress getIPAddress() {
return ipAddress;
}
public final void setIPAddress(final InetAddress value) {
ipAddress = value;
}
public final InetAddress[] getMulticastIPAddress() {
return multicastIPAddress;
}
public final void setMulticastIPAddress(final InetAddress[] value) {
multicastIPAddress = value;
}
public final GXDLMSIp4SetupIpOption[] getIPOptions() {
return ipOptions;
}
public final void setIPOptions(final GXDLMSIp4SetupIpOption[] value) {
ipOptions = value;
}
public final String getSubnetMask() {
return subnetMask;
}
public final void setSubnetMask(final String value) {
subnetMask = value;
}
public final InetAddress getGatewayIPAddress() {
return gatewayIPAddress;
}
public final void setGatewayIPAddress(final InetAddress value) {
gatewayIPAddress = value;
}
public final boolean getUseDHCP() {
return useDHCP;
}
public final void setUseDHCP(final boolean value) {
useDHCP = value;
}
public final InetAddress getPrimaryDNSAddress() {
return primaryDNSAddress;
}
public final void setPrimaryDNSAddress(final InetAddress value) {
primaryDNSAddress = value;
}
public final InetAddress getSecondaryDNSAddress() {
return secondaryDNSAddress;
}
public final void setSecondaryDNSAddress(final InetAddress value) {
secondaryDNSAddress = value;
}
@Override
public final Object[] getValues() {
return new Object[] { getLogicalName(), getDataLinkLayerReference(), getIPAddress(), getMulticastIPAddress(),
getIPOptions(), getSubnetMask(), getGatewayIPAddress(), getUseDHCP(), getPrimaryDNSAddress(),
getSecondaryDNSAddress() };
}
/*
* 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);
}
// DataLinkLayerReference
if (all || !isRead(2)) {
attributes.add(2);
}
// IPAddress
if (all || canRead(3)) {
attributes.add(3);
}
// MulticastIPAddress
if (all || canRead(4)) {
attributes.add(4);
}
// IPOptions
if (all || canRead(5)) {
attributes.add(5);
}
// SubnetMask
if (all || canRead(6)) {
attributes.add(6);
}
// GatewayIPAddress
if (all || canRead(7)) {
attributes.add(7);
}
// UseDHCP
if (all || !isRead(8)) {
attributes.add(8);
}
// PrimaryDNSAddress
if (all || canRead(9)) {
attributes.add(9);
}
// SecondaryDNSAddress
if (all || canRead(10)) {
attributes.add(10);
}
return GXDLMSObjectHelpers.toIntArray(attributes);
}
/*
* Returns amount of attributes.
*/
@Override
public final int getAttributeCount() {
return 10;
}
/*
* Returns amount of methods.
*/
@Override
public final int getMethodCount() {
return 3;
}
@Override
public final DataType getDataType(final int index) {
if (index == 1) {
return DataType.OCTET_STRING;
}
if (index == 2) {
return DataType.OCTET_STRING;
}
if (index == 3) {
return DataType.UINT32;
}
if (index == 4) {
return DataType.ARRAY;
}
if (index == 5) {
return DataType.ARRAY;
}
if (index == 6) {
return DataType.UINT32;
}
if (index == 7) {
return DataType.UINT32;
}
if (index == 8) {
return DataType.BOOLEAN;
}
if (index == 9) {
return DataType.UINT32;
}
if (index == 10) {
return DataType.UINT32;
}
throw new IllegalArgumentException("getDataType failed. Invalid attribute index.");
}
/*
* Returns value of given attribute.
*/
@Override
public final Object getValue(final GXDLMSSettings settings, final ValueEventArgs e) {
GXByteBuffer bb = new GXByteBuffer();
if (e.getIndex() == 1) {
return GXCommon.logicalNameToBytes(getLogicalName());
}
if (e.getIndex() == 2) {
return GXCommon.logicalNameToBytes(getDataLinkLayerReference());
}
if (e.getIndex() == 3) {
if (getIPAddress() == null) {
return 0;
}
bb.set(getIPAddress().getAddress());
return bb.getUInt32();
}
if (e.getIndex() == 4) {
GXByteBuffer data = new GXByteBuffer();
data.setUInt8(DataType.ARRAY.getValue());
if (multicastIPAddress == null) {
GXCommon.setObjectCount(0, data);
} else {
GXCommon.setObjectCount(getMulticastIPAddress().length, data);
for (InetAddress it : getMulticastIPAddress()) {
bb.setUInt8(DataType.UINT16.ordinal());
bb.set(it.getAddress());
}
}
return data.array();
}
if (e.getIndex() == 5) {
GXByteBuffer data = new GXByteBuffer();
data.setUInt8(DataType.ARRAY.getValue());
if (ipOptions == null) {
data.setUInt8(0);
} else {
GXCommon.setObjectCount(ipOptions.length, data);
for (GXDLMSIp4SetupIpOption it : ipOptions) {
data.setUInt8(DataType.STRUCTURE.getValue());
data.setUInt8(3);
GXCommon.setData(settings, data, DataType.UINT8, it.getType());
GXCommon.setData(settings, data, DataType.UINT8, it.getLength());
GXCommon.setData(settings, data, DataType.OCTET_STRING, it.getData());
}
}
return data.array();
}
if (e.getIndex() == 6) {
if (getSubnetMask() == null || getSubnetMask().isEmpty()) {
return 0;
}
try {
bb.set(InetAddress.getByName(getSubnetMask()).getAddress());
return bb.getUInt32();
} catch (UnknownHostException e1) {
throw new IllegalArgumentException("Invalid subnet mask.");
}
}
if (e.getIndex() == 7) {
if (getGatewayIPAddress() == null) {
return 0;
}
bb.set(getGatewayIPAddress().getAddress());
return bb.getUInt32();
}
if (e.getIndex() == 8) {
return this.getUseDHCP();
}
if (e.getIndex() == 9) {
if (getPrimaryDNSAddress() == null) {
return 0;
}
bb.set(getPrimaryDNSAddress().getAddress());
return bb.getUInt32();
}
if (e.getIndex() == 10) {
if (getSecondaryDNSAddress() == null) {
return 0;
}
bb.set(getSecondaryDNSAddress().getAddress());
return bb.getUInt32();
}
e.setError(ErrorCode.READ_WRITE_DENIED);
return null;
}
/*
* Set value of given attribute.
*/
@Override
public final void setValue(final GXDLMSSettings settings, final ValueEventArgs e) {
GXByteBuffer bb = new GXByteBuffer();
if (e.getIndex() == 1) {
setLogicalName(GXCommon.toLogicalName(e.getValue()));
} else if (e.getIndex() == 2) {
if (e.getValue() instanceof String) {
setDataLinkLayerReference(e.getValue().toString());
} else {
setDataLinkLayerReference(GXCommon.toLogicalName(e.getValue()));
}
} else if (e.getIndex() == 3) {
bb.setUInt32(((Number) e.getValue()).intValue());
try {
setIPAddress(InetAddress.getByAddress(bb.array()));
} catch (UnknownHostException e1) {
throw new IllegalArgumentException("Invalid primary DNS address.");
}
} else if (e.getIndex() == 4) {
java.util.ArrayList data = new java.util.ArrayList();
if (e.getValue() != null) {
for (Object it : (List) e.getValue()) {
bb.setUInt32(((Number) it).intValue());
try {
data.add(InetAddress.getByAddress(bb.array()));
} catch (UnknownHostException e1) {
throw new IllegalArgumentException("Invalid IP address.");
}
bb.clear();
}
}
setMulticastIPAddress(data.toArray(new InetAddress[0]));
} else if (e.getIndex() == 5) {
java.util.ArrayList data = new java.util.ArrayList();
if (e.getValue() != null) {
for (Object it : (List) e.getValue()) {
GXDLMSIp4SetupIpOption item = new GXDLMSIp4SetupIpOption();
item.setType(Ip4SetupIpOptionType.forValue(((Number) ((List) it).get(0)).intValue()));
item.setLength(((Number) (((List) it).get(1))).shortValue());
item.setData((byte[]) ((List) it).get(2));
data.add(item);
}
}
setIPOptions(data.toArray(new GXDLMSIp4SetupIpOption[data.size()]));
} else if (e.getIndex() == 6) {
try {
bb.setUInt32(((Number) e.getValue()).intValue());
setSubnetMask(InetAddress.getByAddress(bb.array()).getHostName());
} catch (UnknownHostException e1) {
throw new IllegalArgumentException("Invalid IP address.");
}
} else if (e.getIndex() == 7) {
bb.setUInt32(((Number) e.getValue()).intValue());
try {
setGatewayIPAddress(InetAddress.getByAddress(bb.array()));
} catch (UnknownHostException e1) {
throw new IllegalArgumentException("Invalid Gateway IP address.");
}
} else if (e.getIndex() == 8) {
setUseDHCP(((Boolean) e.getValue()).booleanValue());
} else if (e.getIndex() == 9) {
bb.setUInt32(((Number) e.getValue()).intValue());
try {
setPrimaryDNSAddress(InetAddress.getByAddress(bb.array()));
} catch (UnknownHostException e1) {
throw new IllegalArgumentException("Invalid primary DNS address.");
}
} else if (e.getIndex() == 10) {
bb.setUInt32(((Number) e.getValue()).intValue());
try {
setSecondaryDNSAddress(InetAddress.getByAddress(bb.array()));
} catch (UnknownHostException e1) {
throw new IllegalArgumentException("Invalid IP address.");
}
} else {
e.setError(ErrorCode.READ_WRITE_DENIED);
}
}
@Override
public final void load(final GXXmlReader reader) throws XMLStreamException {
try {
dataLinkLayerReference = reader.readElementContentAsString("DataLinkLayerReference");
ipAddress = InetAddress.getByName(reader.readElementContentAsString("IPAddress"));
List list = new ArrayList();
if (reader.isStartElement("MulticastIPAddress", true)) {
while (reader.isStartElement("Value", false)) {
list.add(InetAddress.getByName(reader.readElementContentAsString("Value")));
}
reader.readEndElement("MulticastIPAddress");
}
multicastIPAddress = list.toArray(new InetAddress[0]);
List tmp = new ArrayList();
if (reader.isStartElement("IPOptions", true)) {
while (reader.isStartElement("IPOption", true)) {
GXDLMSIp4SetupIpOption it = new GXDLMSIp4SetupIpOption();
it.setType(Ip4SetupIpOptionType.forValue(reader.readElementContentAsInt("Type")));
it.setLength((short) reader.readElementContentAsInt("Length"));
it.setData(GXDLMSTranslator.hexToBytes(reader.readElementContentAsString("Data")));
tmp.add(it);
}
// OLD. This can remove in the future.
while (reader.isStartElement("IPOptions", true)) {
GXDLMSIp4SetupIpOption it = new GXDLMSIp4SetupIpOption();
it.setType(Ip4SetupIpOptionType.forValue(reader.readElementContentAsInt("Type")));
it.setLength((short) reader.readElementContentAsInt("Length"));
it.setData(GXDLMSTranslator.hexToBytes(reader.readElementContentAsString("Data")));
tmp.add(it);
}
reader.readEndElement("IPOptions");
}
ipOptions = tmp.toArray(new GXDLMSIp4SetupIpOption[tmp.size()]);
subnetMask = reader.readElementContentAsString("SubnetMask");
gatewayIPAddress = InetAddress.getByName(reader.readElementContentAsString("GatewayIPAddress"));
useDHCP = reader.readElementContentAsInt("UseDHCP") != 0;
primaryDNSAddress = InetAddress.getByName(reader.readElementContentAsString("PrimaryDNSAddress"));
secondaryDNSAddress = InetAddress.getByName(reader.readElementContentAsString("SecondaryDNSAddress"));
} catch (Exception ex) {
throw new RuntimeException(ex.getMessage());
}
}
@Override
public final void save(final GXXmlWriter writer) throws XMLStreamException {
writer.writeElementString("DataLinkLayerReference", dataLinkLayerReference);
if (ipAddress != null) {
writer.writeElementString("IPAddress", ipAddress.getHostAddress());
}
if (multicastIPAddress != null) {
writer.writeStartElement("MulticastIPAddress");
for (InetAddress it : multicastIPAddress) {
writer.writeElementString("Value", it.getHostAddress());
}
writer.writeEndElement();
}
if (ipOptions != null) {
writer.writeStartElement("IPOptions");
for (GXDLMSIp4SetupIpOption it : ipOptions) {
writer.writeStartElement("IPOption");
writer.writeElementString("Type", it.getType().ordinal());
writer.writeElementString("Length", it.getLength());
writer.writeElementString("Data", GXDLMSTranslator.toHex(it.getData()));
writer.writeEndElement();
}
writer.writeEndElement();
}
writer.writeElementString("SubnetMask", subnetMask);
if (gatewayIPAddress != null) {
writer.writeElementString("GatewayIPAddress", gatewayIPAddress.getHostAddress());
}
writer.writeElementString("UseDHCP", useDHCP);
if (primaryDNSAddress != null) {
writer.writeElementString("PrimaryDNSAddress", primaryDNSAddress.getHostAddress());
}
if (secondaryDNSAddress != null) {
writer.writeElementString("SecondaryDNSAddress", secondaryDNSAddress.getHostAddress());
}
}
@Override
public final void postLoad(final GXXmlReader reader) {
// Not needed for this object.
}
@Override
public String[] getNames() {
return new String[] { "Logical Name", "Data LinkLayer Reference", "IP Address", "Multicast IP Address",
"IP Options", "Subnet Mask", "Gateway IP Address", "Use DHCP", "Primary DNS Address",
"Secondary DNS Address" };
}
@Override
public String[] getMethodNames() {
return new String[] { "Add mc IP address", "Delete mc IP address", "Get nbof mc IP addresses" };
}
}