Package org.openmuc.jdlms
Package containing classes to build a DLMS client or server.
- See Also:
ConnectionBuilder
,DlmsConnection
,DlmsSnConnection
,ServerBuilder
,DlmsServer
-
Interface Summary Interface Description DataDirectory Type used to type server data directory structure.DlmsConnection Interface used to interact with a DLMS/COSEM server using the LN services.DlmsEventListener The listener interface for receiving events from a remote smart meter.DlmsInterceptor A interceptor interface used to intercept xDLMS services of a COSEM object.DlmsInvocationContext Exposes context information about the intercepted invocation and operations that enable interceptor methods to control the behavior of the invocation of an xDLMS action/ COSEM attribute or method access.DlmsSnConnection DLMS connection class providing methods to directly access SN services READ and WRITE.GetResult Class representing the result of the get service.RawMessageListener Listen to transmitted data between jDLMS client and the remote meter.ReadResult This class represents the result of the invocation of the read service.ServerConnectionInfo Information about the change of the connection.ServerConnectionListener A connection listener to listen to all new connections and to closing connections. -
Class Summary Class Description AttributeAddress Set of data needed to address an attribute.ConnectionBuilder<T extends ConnectionBuilder<T>> Class to build aDlmsConnection
withConnectionBuilder.build()
or aDlmsSnConnection
withConnectionBuilder.buildSnConnection()
.CosemInterfaceObject Any COSEM object must inherit this abstract class.CosemResourceDescriptor The COSEM resource descriptor.CosemSnInterfaceObject COSEM interface object which is necessary to extend, if short naming is used.DlmsServer Class representing a physical device (DLMS/COSEM server).DlmsServer.TcpServerBuilder Builder to create a TCP physical device/server.DlmsServer.TcpServerSettingsImpl EventNotification Class holding all data received from an event that the remote station sentHexConverter LogicalDevice This class represents a logical device in the physical server/meter.MethodParameter Collection of data needed for a single remote ACTION call.MethodResult Container class holding the results of a remote method invocation via action operationObisCode Represents the address of a remote object according to IEC 62056-6-1.RawMessageData jDLMS raw message data for logging purposes.RawMessageData.Apdu Representation of an APDU.RawMessageData.CosemPdu Representation of a raw COSEM PDU.RawMessageData.RawMessageDataBuilder SecuritySuite This Suite hold the necessary information to authenticate a client to a server and to encrypt and authenticitySecuritySuite.SecuritySuiteBuilder SecurityUtils A static utility class that provides security functions.SelectiveAccessDescription Additional parameter to access attributes to narrow the results of a get operation on the smart meter.SerialConnectionBuilder This connection Builder is used, to build an serial connection to a meter, optionally using the IEC 61056-21 protocol, or directly HDLC.ServerBuilder<T extends ServerBuilder<T>> Builder class to build a DLMS Server.ServerBuilder.ServerSettingsImpl SetParameter Collection of data needed for a single remote SET callSnAddressSpec Variable Access Specification of COSEM attributes or methods.SnClassInfo Interface class (IC) info used to enable the mapping between attribute or method ID and SN offset.SnClassVersion This class represents a tuple of a class ID and version of a IC.SnMemberRange This class represents an SN class member of a coherent range.SnObjectInfo This class represents the mapping between the instance ID (Obis) and base name (object name) of a COSEM SN object.SnWriteParameter This class represents the the struct of parameters used to invoke the DLMS write service.TcpConnectionBuilder Builder class to establish a DLMS connection via TCP/IP protocol suite. -
Enum Summary Enum Description AccessResultCode Enumeration of all possible result codes.AttributeAccessMode The access restrictions for COSEM attributes.AuthenticationMechanism Mechanisms to authenticate to the remote meter.ConformanceSetting Conformance block used to negotiate the communication capabilities, between client and server.DlmsInvocationContext.XDlmsServiceType The invocation type (service).JDlmsException.ExceptionId An exception ID.JDlmsException.Fault The fault of the exception cause.MethodAccessMode Restrict the access mode of a method.MethodResultCode Enumeration of all possible result code a smart meter can send after a method has been called via an action operationObisCode.Medium RawMessageData.MessageSource The source of the message.SecuritySuite.EncryptionMechanism Cryptographic algorithm identify the algorithm for which a derived secret symmetrical key will be used.SecuritySuite.SecurityPolicy The security policy.SecurityUtils.KeyId ServerConnectionInfo.Status The status of a connection.TcpConnectionBuilder.InetTransportProtocol -
Exception Summary Exception Description DlmsAccessException Base exception for a illegal attribute of illegal method access exception.FatalJDlmsException This Exception denotes, that the a fatal exception has occurred.IllegalAttributeAccessException This exception signals that a COSEM attribute has been accessed in a incorrect way.IllegalMethodAccessException This exception signals that a COSEM method has been accessed in a wrong way.JDlmsException Signals, that a exception has occurred.NonFatalJDlmsException This Exception denotes, that a non fatal exception has occurred.ResponseTimeoutException Signals that a timeout has occurred on aBaseDlmsConnection
get, set, or action request. -
Error Summary Error Description IllegalPametrizationError This error indicates, that the server was set up incorrect. -
Annotation Types Summary Annotation Type Description CosemAttribute This annotation is used to define a COSEM attribute in a COSEM class.CosemClass TheCosemClass
annotation tells jDLMS stack that the annotated class is a COSEM class.CosemMethod This annotation is used to define a COSEM method in a COSEM class.