Index (GenDriverAPI 2.3.1 API)

A B C D E F G H I K M N O P R S T U V W
All Classes All Packages

A

addFormParam(String, String) - Method in interface com.smartgridready.driver.api.http.GenHttpRequest: Adds a form parameter to the request.
addHeader(String, String) - Method in interface com.smartgridready.driver.api.http.GenHttpRequest: Adds a request header.
addPath(String) - Method in interface com.smartgridready.driver.api.http.GenUriBuilder: Adds a request path.
addQueryParameter(String, String) - Method in interface com.smartgridready.driver.api.http.GenUriBuilder: Adds a query parameter.
AUTHORIZATION - Static variable in class com.smartgridready.driver.api.http.HttpHeaders: Authorization.

B

BAD_REQUEST - Static variable in class com.smartgridready.driver.api.http.HttpStatus: 400 Bad Request.
build() - Method in interface com.smartgridready.driver.api.http.GenUriBuilder: Builds the final URI.

C

com.smartgridready.driver.api.common - package com.smartgridready.driver.api.common
com.smartgridready.driver.api.contacts - package com.smartgridready.driver.api.contacts
com.smartgridready.driver.api.http - package com.smartgridready.driver.api.http
com.smartgridready.driver.api.messaging - package com.smartgridready.driver.api.messaging
com.smartgridready.driver.api.messaging.model - package com.smartgridready.driver.api.messaging.model
com.smartgridready.driver.api.messaging.model.authentication - package com.smartgridready.driver.api.messaging.model.authentication
com.smartgridready.driver.api.modbus - package com.smartgridready.driver.api.modbus
connect() - Method in interface com.smartgridready.driver.api.contacts.GenDriverAPI4Contacts: Connects to the contacts interface.
connect() - Method in interface com.smartgridready.driver.api.modbus.GenDriverAPI4Modbus: Connects to the Modbus interface.
create(int) - Method in interface com.smartgridready.driver.api.contacts.GenDriverAPI4ContactsFactory: Creates a driver instance.
create(int, long) - Method in interface com.smartgridready.driver.api.contacts.GenDriverAPI4ContactsFactory: Creates a driver instance.
create(MessagingInterfaceDescription) - Method in interface com.smartgridready.driver.api.messaging.GenMessagingClientFactory: Factory method to create a new instance of the messaging client.
createHttpRequest() - Method in interface com.smartgridready.driver.api.http.GenHttpClientFactory: Creates a new request.
createHttpRequest(boolean) - Method in interface com.smartgridready.driver.api.http.GenHttpClientFactory: Creates a new request.
createRtuTransport(String) - Method in interface com.smartgridready.driver.api.modbus.GenDriverAPI4ModbusFactory: Creates a serial Modbus RTU transport.
createRtuTransport(String, int) - Method in interface com.smartgridready.driver.api.modbus.GenDriverAPI4ModbusFactory: Creates a serial Modbus RTU transport.
createRtuTransport(String, int, Parity) - Method in interface com.smartgridready.driver.api.modbus.GenDriverAPI4ModbusFactory: Creates a serial Modbus RTU transport.
createRtuTransport(String, int, Parity, DataBits) - Method in interface com.smartgridready.driver.api.modbus.GenDriverAPI4ModbusFactory: Creates a serial Modbus RTU transport.
createRtuTransport(String, int, Parity, DataBits, StopBits) - Method in interface com.smartgridready.driver.api.modbus.GenDriverAPI4ModbusFactory: Creates a serial Modbus RTU transport.
createRtuTransport(String, int, Parity, DataBits, StopBits, boolean) - Method in interface com.smartgridready.driver.api.modbus.GenDriverAPI4ModbusFactory: Creates a serial Modbus RTU transport.
createTcpTransport(String) - Method in interface com.smartgridready.driver.api.modbus.GenDriverAPI4ModbusFactory: Creates a Modbus TCP transport.
createTcpTransport(String, int) - Method in interface com.smartgridready.driver.api.modbus.GenDriverAPI4ModbusFactory: Creates a Modbus TCP transport.
createUdpTransport(String) - Method in interface com.smartgridready.driver.api.modbus.GenDriverAPI4ModbusFactory: Creates a Modbus UDP transport.
createUdpTransport(String, int) - Method in interface com.smartgridready.driver.api.modbus.GenDriverAPI4ModbusFactory: Creates a Modbus UDP transport.
createUriBuilder(String) - Method in interface com.smartgridready.driver.api.http.GenHttpClientFactory: Creates an URI builder.

D

DataBits - Enum in com.smartgridready.driver.api.modbus: Defines an enumeration of serial connection data bits options.
DELETE - com.smartgridready.driver.api.http.HttpMethod: DELETE.
disconnect() - Method in interface com.smartgridready.driver.api.contacts.GenDriverAPI4Contacts: Disconnects from the contacts interface.
disconnect() - Method in interface com.smartgridready.driver.api.modbus.GenDriverAPI4Modbus: Disconnects from the Modbus interface.

E

EIGHT - com.smartgridready.driver.api.modbus.DataBits: 8 bits.
EVEN - com.smartgridready.driver.api.modbus.Parity: Even parity.
execute() - Method in interface com.smartgridready.driver.api.http.GenHttpRequest: Executes the request and delivers the response.

F

FORBIDDEN - Static variable in class com.smartgridready.driver.api.http.HttpStatus: 403 Forbidden.

G

GenDriverAPI4Contacts - Interface in com.smartgridready.driver.api.contacts: Defines the interface of a digital contacts interface driver.
GenDriverAPI4ContactsFactory - Interface in com.smartgridready.driver.api.contacts: Defines the interface of a digital contacts interface driver factory.
GenDriverAPI4Modbus - Interface in com.smartgridready.driver.api.modbus: Defines the interface of a Modbus interface driver.
GenDriverAPI4ModbusFactory - Interface in com.smartgridready.driver.api.modbus: Defines the interface for a Modbus interface driver factory.
GenDriverException - Exception in com.smartgridready.driver.api.common: Implements the most generalized interface driver exception.
GenDriverException(String) - Constructor for exception com.smartgridready.driver.api.common.GenDriverException: Construct with message.
GenDriverException(String, Throwable) - Constructor for exception com.smartgridready.driver.api.common.GenDriverException: Construct with message and inner exception.
GenDriverException(Throwable) - Constructor for exception com.smartgridready.driver.api.common.GenDriverException: Construct with inner exception.
GenDriverModbusException - Exception in com.smartgridready.driver.api.modbus: Implements a Modbus interface driver exception.
GenDriverModbusException(String) - Constructor for exception com.smartgridready.driver.api.modbus.GenDriverModbusException: Construct with message.
GenDriverModbusException(String, Throwable) - Constructor for exception com.smartgridready.driver.api.modbus.GenDriverModbusException: Construct with message and inner exception.
GenDriverModbusException(Throwable) - Constructor for exception com.smartgridready.driver.api.modbus.GenDriverModbusException: Construct with inner exception.
GenDriverSocketException - Exception in com.smartgridready.driver.api.modbus: Implements an interface driver network socket exception.
GenDriverSocketException(String) - Constructor for exception com.smartgridready.driver.api.modbus.GenDriverSocketException: Construct with message.
GenDriverSocketException(String, Throwable) - Constructor for exception com.smartgridready.driver.api.modbus.GenDriverSocketException: Construct with message and inner exception.
GenDriverSocketException(Throwable) - Constructor for exception com.smartgridready.driver.api.modbus.GenDriverSocketException: Construct with inner exception.
GenHttpClientFactory - Interface in com.smartgridready.driver.api.http: Defines the interface of an HTTP request factory.
GenHttpRequest - Interface in com.smartgridready.driver.api.http: Defines the interface of an HTTP request.
GenHttpResponse - Class in com.smartgridready.driver.api.http: Implements a HTTP response.
GenMessagingClient - Interface in com.smartgridready.driver.api.messaging: Defines the interface of a messaging client.
GenMessagingClientFactory - Interface in com.smartgridready.driver.api.messaging: Defines the interface of a messaging client factory.
GenUriBuilder - Interface in com.smartgridready.driver.api.http: Defines the interface of an URI builder.
GET - com.smartgridready.driver.api.http.HttpMethod: GET.
getBasicAuthentication() - Method in class com.smartgridready.driver.api.messaging.model.authentication.MessageBrokerAuthentication: Gets the basic authentication configuration.
getClientCertificateAuthentication() - Method in class com.smartgridready.driver.api.messaging.model.authentication.MessageBrokerAuthentication: Gets the client-certificate-based configuration.
getClientId() - Method in class com.smartgridready.driver.api.messaging.model.MessagingInterfaceDescription: Gets the messaging client identifier.
getHost() - Method in class com.smartgridready.driver.api.messaging.model.MessageBroker: Gets the host address.
getKey() - Method in class com.smartgridready.driver.api.messaging.model.Message: Gets the message key.
getKeystorePassword() - Method in class com.smartgridready.driver.api.messaging.model.authentication.MessageBrokerAuthenticationClientCertificate: Gets the key store password.
getKeystorePath() - Method in class com.smartgridready.driver.api.messaging.model.authentication.MessageBrokerAuthenticationClientCertificate: Gets the key store path.
getMessageBrokerAuthentication() - Method in class com.smartgridready.driver.api.messaging.model.MessagingInterfaceDescription: Gets the message broker authentication configuration.
getMessageBrokerList() - Method in class com.smartgridready.driver.api.messaging.model.MessagingInterfaceDescription: Gets the list of configured message brokers.
getMessagingPlatformType() - Method in class com.smartgridready.driver.api.messaging.model.MessagingInterfaceDescription: Gets the messaging platform type.
getPassword() - Method in class com.smartgridready.driver.api.messaging.model.authentication.MessageBrokerAuthenticationBasic: Gets the password
getPayload() - Method in class com.smartgridready.driver.api.messaging.model.Message: Gets the message payload.
getPort() - Method in class com.smartgridready.driver.api.messaging.model.MessageBroker: Gets the TCP port.
getReason() - Method in class com.smartgridready.driver.api.http.GenHttpResponse: Gets the status message.
getResponse() - Method in class com.smartgridready.driver.api.http.GenHttpResponse: Gets the response body.
getResponseCode() - Method in class com.smartgridready.driver.api.http.GenHttpResponse: Gets the HTTP status code.
getSupportedPlatforms() - Method in interface com.smartgridready.driver.api.messaging.GenMessagingClientFactory: Gets the messaging platforms supported by the implementation.
getTruststorePassword() - Method in class com.smartgridready.driver.api.messaging.model.authentication.MessageBrokerAuthenticationClientCertificate: Gets the trust store password.
getTruststorePath() - Method in class com.smartgridready.driver.api.messaging.model.authentication.MessageBrokerAuthenticationClientCertificate: Gets the trust store path.
getUsername() - Method in class com.smartgridready.driver.api.messaging.model.authentication.MessageBrokerAuthenticationBasic: Gets the user name.

H

HttpHeaders - Class in com.smartgridready.driver.api.http: Defines HTTP header name constants.
HttpMethod - Enum in com.smartgridready.driver.api.http: Defines an enumeration of HTTP methods.
HttpStatus - Class in com.smartgridready.driver.api.http: Defines HTTP status code constants.

I

INTERNAL_SERVER_ERROR - Static variable in class com.smartgridready.driver.api.http.HttpStatus: 500 Internal Server Error.
isConnected() - Method in interface com.smartgridready.driver.api.contacts.GenDriverAPI4Contacts: Tells if the contacts interface is connected.
isConnected() - Method in interface com.smartgridready.driver.api.modbus.GenDriverAPI4Modbus: Tells if the Modbus interface is connected.
isFilterMatch(String) - Method in interface com.smartgridready.driver.api.messaging.MessageFilterHandler: Matches the filter against the message payload.
isOk() - Method in class com.smartgridready.driver.api.http.GenHttpResponse: Checks if the response is successful, depending on the status code.
isTls() - Method in class com.smartgridready.driver.api.messaging.model.MessageBroker: Tells if TLS is used.
isTlsVerifyCertificate() - Method in class com.smartgridready.driver.api.messaging.model.MessageBroker: Tells if TLS certificate verification is enabled.

K

KAFKA - com.smartgridready.driver.api.messaging.model.MessagingPlatformType: Apache Kafka.

M

Message - Class in com.smartgridready.driver.api.messaging.model: Represents a message conveyed by messaging clients.
Message(String, String) - Constructor for class com.smartgridready.driver.api.messaging.model.Message: Constructor using an optional message key and the message payload.
MessageBroker - Class in com.smartgridready.driver.api.messaging.model: Implements a message broker configuration.
MessageBroker(String, String, boolean, boolean) - Constructor for class com.smartgridready.driver.api.messaging.model.MessageBroker: Construct.
MessageBrokerAuthentication - Class in com.smartgridready.driver.api.messaging.model.authentication: Contains message broker authentication configurations.
MessageBrokerAuthentication(MessageBrokerAuthenticationBasic, MessageBrokerAuthenticationClientCertificate) - Constructor for class com.smartgridready.driver.api.messaging.model.authentication.MessageBrokerAuthentication: Construct all configurations.
MessageBrokerAuthenticationBasic - Class in com.smartgridready.driver.api.messaging.model.authentication: Represents a message broker authentication configuration using user name and password.
MessageBrokerAuthenticationBasic(String, String) - Constructor for class com.smartgridready.driver.api.messaging.model.authentication.MessageBrokerAuthenticationBasic: Construct.
MessageBrokerAuthenticationClientCertificate - Class in com.smartgridready.driver.api.messaging.model.authentication: Represents a message broker authentication configuration using client certificates.
MessageBrokerAuthenticationClientCertificate(String, String, String, String) - Constructor for class com.smartgridready.driver.api.messaging.model.authentication.MessageBrokerAuthenticationClientCertificate: Construct.
MessageFilterHandler - Interface in com.smartgridready.driver.api.messaging: Defines the interface of a message filter handler.
MessagingInterfaceDescription - Class in com.smartgridready.driver.api.messaging.model: Implements a messaging interface description.
MessagingInterfaceDescription(MessagingPlatformType, List<MessageBroker>, MessageBrokerAuthentication, String) - Constructor for class com.smartgridready.driver.api.messaging.model.MessagingInterfaceDescription: Construct.
MessagingPlatformType - Enum in com.smartgridready.driver.api.messaging.model: Defines a enumeration of messaging platform types.
MQTT5 - com.smartgridready.driver.api.messaging.model.MessagingPlatformType: MQTT v5.

N

NONE - com.smartgridready.driver.api.modbus.Parity: No parity.

O

ODD - com.smartgridready.driver.api.modbus.Parity: Odd parity.
of(String) - Static method in class com.smartgridready.driver.api.http.GenHttpResponse: Creates a new instance.
of(String) - Static method in class com.smartgridready.driver.api.messaging.model.Message: Factory method for a message that has a payload only.
of(String, int, String) - Static method in class com.smartgridready.driver.api.http.GenHttpResponse: Creates a new instance.
of(String, String) - Static method in class com.smartgridready.driver.api.messaging.model.Message: Factory method for a message with payload and an additional message key.
OK - Static variable in class com.smartgridready.driver.api.http.HttpStatus: 200 OK.
ONE - com.smartgridready.driver.api.modbus.StopBits: 1 stop bit.
ONE_AND_HALF - com.smartgridready.driver.api.modbus.StopBits: 1.5 stop bits.

P

Parity - Enum in com.smartgridready.driver.api.modbus: Defines an enumeration of serial connection parity bit options.
PATCH - com.smartgridready.driver.api.http.HttpMethod: PATCH.
POST - com.smartgridready.driver.api.http.HttpMethod: POST.
PUT - com.smartgridready.driver.api.http.HttpMethod: PUT.

R

readCoils(short, int, int) - Method in interface com.smartgridready.driver.api.modbus.GenDriverAPI4Modbus: Reads one or multiple coils.
ReadCoils(int, int) - Method in interface com.smartgridready.driver.api.modbus.GenDriverAPI4Modbus: Deprecated.
readContacts(String, String) - Method in interface com.smartgridready.driver.api.contacts.GenDriverAPI4Contacts: Reads the state of the digital contacts according to a specific functional profile and data point.
readDiscreteInputs(short, int, int) - Method in interface com.smartgridready.driver.api.modbus.GenDriverAPI4Modbus: Reads one or multiple discrete inputs.
ReadDiscreteInputs(int, int) - Method in interface com.smartgridready.driver.api.modbus.GenDriverAPI4Modbus: Deprecated.
readHoldingRegisters(short, int, int) - Method in interface com.smartgridready.driver.api.modbus.GenDriverAPI4Modbus: Reads one or multiple holding registers.
ReadHoldingRegisters(int, int) - Method in interface com.smartgridready.driver.api.modbus.GenDriverAPI4Modbus: Deprecated.
readInputRegisters(short, int, int) - Method in interface com.smartgridready.driver.api.modbus.GenDriverAPI4Modbus: Reads one or multiple input registers.
ReadInputRegisters(int, int) - Method in interface com.smartgridready.driver.api.modbus.GenDriverAPI4Modbus: Deprecated.
readSync(String, Message, String, MessageFilterHandler, long) - Method in interface com.smartgridready.driver.api.messaging.GenMessagingClient: Subscribes to a topic and returns a completable future that provides the next message from the given topic.

S

sendAsynch(String, Message) - Method in interface com.smartgridready.driver.api.messaging.GenMessagingClient: Sends a message asynchronously to a given topic.
sendSync(String, Message) - Method in interface com.smartgridready.driver.api.messaging.GenMessagingClient: This method publishes a message to the given topic.
setBody(String) - Method in interface com.smartgridready.driver.api.http.GenHttpRequest: Sets the request body.
setHttpMethod(HttpMethod) - Method in interface com.smartgridready.driver.api.http.GenHttpRequest: Sets the HTTP method.
setQueryString(String) - Method in interface com.smartgridready.driver.api.http.GenUriBuilder: Sets the raw query string, overriding query parameters.
setUnitIdentifier(short) - Method in interface com.smartgridready.driver.api.modbus.GenDriverAPI4Modbus: Deprecated.
setUri(URI) - Method in interface com.smartgridready.driver.api.http.GenHttpRequest: Sets the request URI.
SEVEN - com.smartgridready.driver.api.modbus.DataBits: 7 bits.
StopBits - Enum in com.smartgridready.driver.api.modbus: Defines an enumeration of serial connection stop bits options.
subscribe(String, MessageFilterHandler, Consumer<Either<Throwable, Message>>) - Method in interface com.smartgridready.driver.api.messaging.GenMessagingClient: Subscribes to a topic for receiving a stream of messages.

T

TWO - com.smartgridready.driver.api.modbus.StopBits: 2 stop bits.

U

UNAUTHORIZED - Static variable in class com.smartgridready.driver.api.http.HttpStatus: 401 Unauthorized.
unsubscribe(String) - Method in interface com.smartgridready.driver.api.messaging.GenMessagingClient: Unsubscribes message handlers from a topic.

V

validate() - Method in interface com.smartgridready.driver.api.messaging.MessageFilterHandler: Checks if the filter is valid.
valueOf(String) - Static method in enum com.smartgridready.driver.api.http.HttpMethod: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.smartgridready.driver.api.messaging.model.MessagingPlatformType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.smartgridready.driver.api.modbus.DataBits: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.smartgridready.driver.api.modbus.Parity: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.smartgridready.driver.api.modbus.StopBits: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.smartgridready.driver.api.http.HttpMethod: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.smartgridready.driver.api.messaging.model.MessagingPlatformType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.smartgridready.driver.api.modbus.DataBits: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.smartgridready.driver.api.modbus.Parity: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.smartgridready.driver.api.modbus.StopBits: Returns an array containing the constants of this enum type, in the order they are declared.

W

writeContacts(String, String, boolean[]) - Method in interface com.smartgridready.driver.api.contacts.GenDriverAPI4Contacts: Writes the state of the digital contacts according to a specific functional profile and data point.
writeMultipleCoils(short, int, boolean[]) - Method in interface com.smartgridready.driver.api.modbus.GenDriverAPI4Modbus: Writes multiple coils.
WriteMultipleCoils(int, boolean[]) - Method in interface com.smartgridready.driver.api.modbus.GenDriverAPI4Modbus: Deprecated.
writeMultipleRegisters(short, int, int[]) - Method in interface com.smartgridready.driver.api.modbus.GenDriverAPI4Modbus: Writes multiple holding registers.
WriteMultipleRegisters(int, int[]) - Method in interface com.smartgridready.driver.api.modbus.GenDriverAPI4Modbus: Deprecated.
writeSingleCoil(short, int, boolean) - Method in interface com.smartgridready.driver.api.modbus.GenDriverAPI4Modbus: Writes a single coil.
WriteSingleCoil(int, boolean) - Method in interface com.smartgridready.driver.api.modbus.GenDriverAPI4Modbus: Deprecated.
writeSingleRegister(short, int, int) - Method in interface com.smartgridready.driver.api.modbus.GenDriverAPI4Modbus: Writes a single holding register.
WriteSingleRegister(int, int) - Method in interface com.smartgridready.driver.api.modbus.GenDriverAPI4Modbus: Deprecated.

A B C D E F G H I K M N O P R S T U V W
All Classes All Packages