A B C D E G H I L M N O P Q R S T U W X
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- address - Variable in class net.dona.doip.client.transport.ConnectionOptions
-
The IP address of the DOIP server.
- AllTrustingTrustManager - Class in net.dona.doip.util.tls
-
An instance of
X509TrustManager
which will trust all certificates. - AllTrustingTrustManager() - Constructor for class net.dona.doip.util.tls.AllTrustingTrustManager
- attributes - Variable in class net.dona.doip.client.DigitalObject
-
The attributes of the object.
- attributes - Variable in class net.dona.doip.client.Element
-
The attributes of the element.
- attributes - Variable in class net.dona.doip.DoipRequestHeaders
-
Attributes supplied to the operation.
- attributes - Variable in class net.dona.doip.DoipResponseHeaders
-
Attributes to be included with the response.
- authentication - Variable in class net.dona.doip.DoipRequestHeaders
-
Authentication information; the structure depends on the authentication method used.
- AuthenticationInfo - Interface in net.dona.doip.client
-
An interface for classes which provide authentication information to
DoipClient
. - AutoSelfSignedKeyManager - Class in net.dona.doip.util.tls
-
This object is used to provide a private key for authentication to the other side of a secure socket connection.
- AutoSelfSignedKeyManager(String) - Constructor for class net.dona.doip.util.tls.AutoSelfSignedKeyManager
-
Constructs a key manager for the supplied identity with a newly minted keypair.
- AutoSelfSignedKeyManager(String, X509Certificate[], PrivateKey) - Constructor for class net.dona.doip.util.tls.AutoSelfSignedKeyManager
-
Constructs a key manager corresponding to the supplied certificate chain and private key.
- AutoSelfSignedKeyManager(String, X509Certificate, PrivateKey) - Constructor for class net.dona.doip.util.tls.AutoSelfSignedKeyManager
-
Constructs a key manager corresponding to the supplied certificate and private key.
- AutoSelfSignedKeyManager(String, PublicKey, PrivateKey) - Constructor for class net.dona.doip.util.tls.AutoSelfSignedKeyManager
-
Constructs a key manager corresponding the the supplied keypair.
B
- backlog - Variable in class net.dona.doip.server.DoipServerConfig
-
Backlog to be used for the TCP listener (defaults to 50).
- BadDoipException - Exception in net.dona.doip
-
Exception which indicates a malformed DOIP message.
- BadDoipException(String) - Constructor for exception net.dona.doip.BadDoipException
- BadDoipException(String, Throwable) - Constructor for exception net.dona.doip.BadDoipException
- BadDoipException(Throwable) - Constructor for exception net.dona.doip.BadDoipException
C
- certificateChain - Variable in class net.dona.doip.server.DoipServerConfig.TlsConfig
-
Certificate chain for the server.
- checkClientTrusted(X509Certificate[], String) - Method in class net.dona.doip.util.tls.AllTrustingTrustManager
- checkClientTrusted(X509Certificate[], String) - Method in class net.dona.doip.util.tls.TrustManagerForSpecifiedServerIdAndKeys
- checkServerTrusted(X509Certificate[], String) - Method in class net.dona.doip.util.tls.AllTrustingTrustManager
- checkServerTrusted(X509Certificate[], String) - Method in class net.dona.doip.util.tls.TrustManagerForSpecifiedServerIdAndKeys
- chooseClientAlias(String[], Principal[], Socket) - Method in class net.dona.doip.util.tls.AutoSelfSignedKeyManager
- chooseEngineClientAlias(String[], Principal[], SSLEngine) - Method in class net.dona.doip.util.tls.AutoSelfSignedKeyManager
- chooseEngineServerAlias(String, Principal[], SSLEngine) - Method in class net.dona.doip.util.tls.AutoSelfSignedKeyManager
- chooseServerAlias(String, Principal[], Socket) - Method in class net.dona.doip.util.tls.AutoSelfSignedKeyManager
- clientId - Variable in class net.dona.doip.client.transport.ConnectionOptions
-
The identifier for the client; if present, will be used along with
ConnectionOptions.clientPublicKey
andConnectionOptions.clientPrivateKey
to produce a client-side TLS certificate to be used for the connection. - clientId - Variable in class net.dona.doip.DoipRequestHeaders
-
The id of the calling entity.
- clientPrivateKey - Variable in class net.dona.doip.client.transport.ConnectionOptions
- clientPublicKey - Variable in class net.dona.doip.client.transport.ConnectionOptions
- close() - Method in class net.dona.doip.client.DelegatedCloseableInputStream
- close() - Method in class net.dona.doip.client.DoipClient
-
Closes all open connections and release all resources.
- close() - Method in class net.dona.doip.client.DoipSearchResults
- close() - Method in interface net.dona.doip.client.SearchResults
-
Closes the search results, releasing the connection to the server.
- close() - Method in class net.dona.doip.client.transport.DoipClientResponse
-
Closes the response "output" and runs a callback if one was specified using
DoipClientResponse.setOnClose(Runnable)
. - close() - Method in interface net.dona.doip.client.transport.DoipConnection
- close() - Method in class net.dona.doip.client.transport.DoipConnectionImpl
- close() - Method in interface net.dona.doip.client.transport.DoipExchange
- close() - Method in class net.dona.doip.client.transport.ReleaseOnceDoipConnection
- close() - Method in class net.dona.doip.client.transport.TransportDoipClient
-
Closes all connections.
- close() - Method in interface net.dona.doip.InDoipMessage
- close() - Method in class net.dona.doip.InDoipMessageFromCollection
-
A no-op for this implementation.
- close() - Method in class net.dona.doip.InDoipMessageFromJson
-
A no-op for this implementation.
- close() - Method in class net.dona.doip.InDoipMessageImpl
-
Reads all remaining segments (unless the DOIP message is malformed, in which case it returns immediately).
- close() - Method in interface net.dona.doip.OutDoipMessage
- close() - Method in class net.dona.doip.OutDoipMessageImpl
- closeSegmentOutput() - Method in class net.dona.doip.OutDoipMessageImpl
-
Closes the particular segment currently being written, if any
- commit() - Method in interface net.dona.doip.server.DoipServerResponse
-
Ensure that the initial segment has been sent to the client.
- commit() - Method in class net.dona.doip.server.DoipServerResponseImpl
- configureEnabledProtocolsAndCipherSuites(ServerSocket) - Static method in class net.dona.doip.util.tls.TlsProtocolAndCipherSuiteConfigurationUtil
-
Configures an
SSLServerSocket
to use the appropriate protocols and cipher suites. - configureEnabledProtocolsAndCipherSuites(Socket) - Static method in class net.dona.doip.util.tls.TlsProtocolAndCipherSuiteConfigurationUtil
-
Configures an
SSLSocket
to use the appropriate protocols and cipher suites. - connect(InetAddress, int) - Method in class net.dona.doip.client.transport.TransportDoipClient
-
Connects to a server by specifying an IP address and port, using default timeouts of one minute, trusting any provided server certificate, and not supplying a client certificate.
- connect(InetAddress, int, int, int) - Method in class net.dona.doip.client.transport.TransportDoipClient
-
Connects to a server by specifying an IP address and port, using the specified timeouts, trusting any provided server certificate, and not supplying a client certificate.
- connect(InetAddress, int, X509TrustManager, X509KeyManager, int, int) - Method in class net.dona.doip.client.transport.TransportDoipClient
-
Connects to a server by specifying an IP address and port, using the specified timeouts, trusting server certificates according to the specified trust manager, and providing a client certificate using the specified key manager.
- connect(ConnectionOptions) - Method in class net.dona.doip.client.transport.TransportDoipClient
-
Connect to a server using the specified connection options.
- ConnectionAndPool - Class in net.dona.doip.client
-
Used internally by
DoipClient
to manage pools of connections. - ConnectionAndPool(DoipConnectionPool) - Constructor for class net.dona.doip.client.ConnectionAndPool
- ConnectionOptions - Class in net.dona.doip.client.transport
-
Options for a connection to a DOIP server.
- ConnectionOptions() - Constructor for class net.dona.doip.client.transport.ConnectionOptions
- connectTimeoutMs - Variable in class net.dona.doip.client.transport.ConnectionOptions
-
Connection timeout in ms.
- create(Gson, TypeToken<T>) - Method in class net.dona.doip.util.GsonUtility.StreamTypeAdapterFactory
- create(DigitalObject, AuthenticationInfo, ServiceInfo) - Method in class net.dona.doip.client.DoipClient
-
Creates a digital object at a service.
- createServerSocket() - Method in class net.dona.doip.util.tls.TlsProtocolAndCipherSuiteConfigurationUtil.ServerSocketFactoryWrapper
- createServerSocket(int) - Method in class net.dona.doip.util.tls.TlsProtocolAndCipherSuiteConfigurationUtil.ServerSocketFactoryWrapper
- createServerSocket(int, int) - Method in class net.dona.doip.util.tls.TlsProtocolAndCipherSuiteConfigurationUtil.ServerSocketFactoryWrapper
- createServerSocket(int, int, InetAddress) - Method in class net.dona.doip.util.tls.TlsProtocolAndCipherSuiteConfigurationUtil.ServerSocketFactoryWrapper
- createSocket() - Method in class net.dona.doip.util.tls.TlsProtocolAndCipherSuiteConfigurationUtil.SocketFactoryWrapper
- createSocket(String, int) - Method in class net.dona.doip.util.tls.TlsProtocolAndCipherSuiteConfigurationUtil.SocketFactoryWrapper
- createSocket(String, int, InetAddress, int) - Method in class net.dona.doip.util.tls.TlsProtocolAndCipherSuiteConfigurationUtil.SocketFactoryWrapper
- createSocket(InetAddress, int) - Method in class net.dona.doip.util.tls.TlsProtocolAndCipherSuiteConfigurationUtil.SocketFactoryWrapper
- createSocket(InetAddress, int, InetAddress, int) - Method in class net.dona.doip.util.tls.TlsProtocolAndCipherSuiteConfigurationUtil.SocketFactoryWrapper
- createSocket(Socket, String, int, boolean) - Method in class net.dona.doip.util.tls.TlsProtocolAndCipherSuiteConfigurationUtil.SocketFactoryWrapper
D
- DEFAULT - Static variable in class net.dona.doip.client.QueryParams
-
Default query parameters.
- DelegatedCloseableInputStream - Class in net.dona.doip.client
-
An input stream which will run a supplied runnable when the input stream is closed.
- DelegatedCloseableInputStream(InputStream, Runnable) - Constructor for class net.dona.doip.client.DelegatedCloseableInputStream
-
Constructs an input stream which wraps the supplied input stream and runs the supplied runnable when the input stream is closed.
- delete(String, AuthenticationInfo) - Method in class net.dona.doip.client.DoipClient
-
Deletes a digital object.
- delete(String, AuthenticationInfo, ServiceInfo) - Method in class net.dona.doip.client.DoipClient
-
Deletes a digital object from a specified service.
- deserialize(JsonElement, Type, JsonDeserializationContext) - Method in class net.dona.doip.util.GsonUtility.PrivateKeyTypeHierarchyAdapter
- deserialize(JsonElement, Type, JsonDeserializationContext) - Method in class net.dona.doip.util.GsonUtility.PublicKeyTypeHierarchyAdapter
- DigitalObject - Class in net.dona.doip.client
-
A Java representation of a Digital Object.
- DigitalObject() - Constructor for class net.dona.doip.client.DigitalObject
- DoipClient - Class in net.dona.doip.client
-
A DOIP client for performing operations on objects.
- DoipClient() - Constructor for class net.dona.doip.client.DoipClient
-
Constructs a new DoipClient.
- DoipClientResponse - Class in net.dona.doip.client.transport
-
A response from a server to the client.
- DoipClientResponse(DoipResponseHeaders, InDoipMessage) - Constructor for class net.dona.doip.client.transport.DoipClientResponse
-
Constructs the response with the given initial segment, and further segments to be read from the supplied
InDoipMessage
. - DoipConnection - Interface in net.dona.doip.client.transport
-
A connection with a DOIP server.
- DoipConnectionImpl - Class in net.dona.doip.client.transport
-
An implementation of
DoipConnection
. - DoipConnectionImpl(Socket) - Constructor for class net.dona.doip.client.transport.DoipConnectionImpl
-
Establishes a DoipConnection using the specified Socket.
- DoipConnectionPool - Class in net.dona.doip.client.transport
-
Used internally by
DoipClient
to manage pools of connections. - DoipConnectionPool(int, TransportDoipClient, ConnectionOptions) - Constructor for class net.dona.doip.client.transport.DoipConnectionPool
- DoipConstants - Class in net.dona.doip
-
Constants useful in processing DOIP messages.
- DoipConstants() - Constructor for class net.dona.doip.DoipConstants
- DoipException - Exception in net.dona.doip.client
-
An exception thrown by
DoipClient
when something goes wrong such as an unexpected status code returned for an operation. - DoipException(String) - Constructor for exception net.dona.doip.client.DoipException
- DoipException(String, String) - Constructor for exception net.dona.doip.client.DoipException
- DoipException(String, String, Throwable) - Constructor for exception net.dona.doip.client.DoipException
- DoipException(Throwable) - Constructor for exception net.dona.doip.client.DoipException
- doipExceptionFromDoipResponse(DoipClientResponse) - Static method in class net.dona.doip.client.DoipClient
- DoipExchange - Interface in net.dona.doip.client.transport
-
An object representing both the outgoing request input, and the response, of a DOIP connection.
- DoipProcessor - Interface in net.dona.doip.server
-
A DoipProcessor encapsulates the request-processing logic of a DOIP server.
- DoipRequestHeaders - Class in net.dona.doip
-
The initial segment of a properly formed DOIP request, except the requestId which will be generated by processing code.
- DoipRequestHeaders() - Constructor for class net.dona.doip.DoipRequestHeaders
- DoipRequestHeadersWithRequestId - Class in net.dona.doip
-
The initial segment of a properly formed DOIP request, including the requestId.
- DoipRequestHeadersWithRequestId(DoipRequestHeaders) - Constructor for class net.dona.doip.DoipRequestHeadersWithRequestId
-
Copies the fields from the supplied request.
- DoipResponseHeaders - Class in net.dona.doip
-
The initial segment of a properly formed DOIP request, except the requestId which will be generated by processing code.
- DoipResponseHeaders() - Constructor for class net.dona.doip.DoipResponseHeaders
- DoipResponseHeadersWithRequestId - Class in net.dona.doip
-
The initial segment of a properly formed DOIP response, including the requestId.
- DoipResponseHeadersWithRequestId() - Constructor for class net.dona.doip.DoipResponseHeadersWithRequestId
- DoipSearchResults<T> - Class in net.dona.doip.client
-
Used internally by
DoipClient
to produce search results - DoipSearchResults(DoipClientResponse, Class<T>) - Constructor for class net.dona.doip.client.DoipSearchResults
- DoipServer - Class in net.dona.doip.server
-
A DOIP server.
- DoipServer(DoipServerConfig) - Constructor for class net.dona.doip.server.DoipServer
-
Constructs a DoipServer.
- DoipServer(DoipServerConfig, DoipProcessor) - Constructor for class net.dona.doip.server.DoipServer
-
Constructs a DoipServer with a previously instantiated
DoipProcessor
. - DoipServerConfig - Class in net.dona.doip.server
-
Configuration for a
DoipServer
. - DoipServerConfig() - Constructor for class net.dona.doip.server.DoipServerConfig
- DoipServerConfig.TlsConfig - Class in net.dona.doip.server
-
TLS configuration for a
DoipServer
. - DoipServerRequest - Interface in net.dona.doip.server
-
Interface for an incoming DOIP request to be handled by a
DoipProcessor
. - DoipServerRequestImpl - Class in net.dona.doip.server
-
An implementation of
DoipServerRequest
used internally byDoipServer
. - DoipServerRequestImpl(InDoipMessage, String, PublicKey, X509Certificate[]) - Constructor for class net.dona.doip.server.DoipServerRequestImpl
- DoipServerResponse - Interface in net.dona.doip.server
-
Interface for an outgoing DOIP response to be populated by a
DoipProcessor
. - DoipServerResponseImpl - Class in net.dona.doip.server
-
An implementation of
DoipServerResponse
used internally byDoipServer
. - DoipServerResponseImpl(String, OutDoipMessage) - Constructor for class net.dona.doip.server.DoipServerResponseImpl
E
- Element - Class in net.dona.doip.client
-
A Java representation of an element of a Digital Object.
- Element() - Constructor for class net.dona.doip.client.Element
- elements - Variable in class net.dona.doip.client.DigitalObject
-
The elements of the object.
- ENABLED_CIPHER_SUITES - Static variable in class net.dona.doip.util.tls.TlsProtocolAndCipherSuiteConfigurationUtil
-
A list of TLS cipher suites both provided by the JVM and considered sufficiently strong.
- ENABLED_PROTOCOLS - Static variable in class net.dona.doip.util.tls.TlsProtocolAndCipherSuiteConfigurationUtil
-
A list of TLS protocols both provided by the JVM and considered sufficiently strong.
- equals(Object) - Method in class net.dona.doip.server.DoipServerConfig
- equals(Object) - Method in class net.dona.doip.server.DoipServerConfig.TlsConfig
- equals(Object) - Method in class net.dona.doip.util.tls.TlsProtocolAndCipherSuiteConfigurationUtil.ServerSocketFactoryWrapper
- equals(Object) - Method in class net.dona.doip.util.tls.TlsProtocolAndCipherSuiteConfigurationUtil.SocketFactoryWrapper
G
- generate(String, int, PublicKey, PrivateKey) - Static method in class net.dona.doip.util.tls.X509CertificateGenerator
- generate(String, PublicKey, PrivateKey) - Static method in class net.dona.doip.util.tls.X509CertificateGenerator
- generateWithCnAndUid(String, String, PublicKey, PrivateKey) - Static method in class net.dona.doip.util.tls.X509CertificateGenerator
- generateWithUid(String, PublicKey, PrivateKey) - Static method in class net.dona.doip.util.tls.X509CertificateGenerator
- get() - Method in class net.dona.doip.client.transport.DoipConnectionPool
- getAcceptedIssuers() - Method in class net.dona.doip.util.tls.AllTrustingTrustManager
- getAcceptedIssuers() - Method in class net.dona.doip.util.tls.TrustManagerForSpecifiedServerIdAndKeys
- getAllTrustingClientSSLContext() - Static method in class net.dona.doip.util.tls.TlsProtocolAndCipherSuiteConfigurationUtil
-
Returns an
SSLContext
which trusts all server certificates. - getAttribute(String) - Method in class net.dona.doip.client.transport.DoipClientResponse
-
Returns a specified attribute from the initial segment of the response.
- getAttribute(String) - Method in interface net.dona.doip.server.DoipServerRequest
-
Returns a single attribute from the attributes given by the initial segment of the request.
- getAttribute(String) - Method in class net.dona.doip.server.DoipServerRequestImpl
- getAttributeAsString(String) - Method in class net.dona.doip.client.transport.DoipClientResponse
-
Returns a specified attribute from the initial segment of the response, as a String.
- getAttributeAsString(String) - Method in interface net.dona.doip.server.DoipServerRequest
-
Returns as a String a single attribute from the attributes given by the initial segment of the request.
- getAttributeAsString(String) - Method in class net.dona.doip.server.DoipServerRequestImpl
- getAttributes() - Method in class net.dona.doip.client.transport.DoipClientResponse
-
Returns the attributes from the initial segment of the response.
- getAttributes() - Method in interface net.dona.doip.server.DoipServerRequest
-
Returns the attributes given by the initial segment of the request.
- getAttributes() - Method in class net.dona.doip.server.DoipServerRequestImpl
- getAuthentication() - Method in interface net.dona.doip.client.AuthenticationInfo
-
Returns the authentication property to be supplied with the initial segment of DOIP requests.
- getAuthentication() - Method in class net.dona.doip.client.PasswordAuthenticationInfo
- getAuthentication() - Method in class net.dona.doip.client.PrivateKeyAuthenticationInfo
- getAuthentication() - Method in class net.dona.doip.client.TokenAuthenticationInfo
- getAuthentication() - Method in interface net.dona.doip.server.DoipServerRequest
-
Returns the authentication information given by the initial segment of the request.
- getAuthentication() - Method in class net.dona.doip.server.DoipServerRequestImpl
- getBytesOutputStream() - Method in interface net.dona.doip.OutDoipMessage
-
Returns an
OutputStream
that can be used to write to a bytes segment. - getBytesOutputStream() - Method in class net.dona.doip.OutDoipMessageImpl
- getCertificate() - Method in class net.dona.doip.util.tls.AutoSelfSignedKeyManager
-
Returns the certificate (supplied or generated).
- getCertificateChain(String) - Method in class net.dona.doip.util.tls.AutoSelfSignedKeyManager
- getClientAliases(String, Principal[]) - Method in class net.dona.doip.util.tls.AutoSelfSignedKeyManager
- getClientId() - Method in interface net.dona.doip.client.AuthenticationInfo
-
Returns the clientId to be supplied with the initial segment of DOIP requests.
- getClientId() - Method in class net.dona.doip.client.PasswordAuthenticationInfo
- getClientId() - Method in class net.dona.doip.client.PrivateKeyAuthenticationInfo
- getClientId() - Method in class net.dona.doip.client.TokenAuthenticationInfo
- getClientId() - Method in interface net.dona.doip.server.DoipServerRequest
-
Returns the client id given by the initial segment of the request.
- getClientId() - Method in class net.dona.doip.server.DoipServerRequestImpl
- getConnection() - Method in class net.dona.doip.client.ConnectionAndPool
- getConnectionCertificateChain() - Method in interface net.dona.doip.server.DoipServerRequest
-
If the client is using a TLS client-side certificate, this returns the supplied certificate chain.
- getConnectionCertificateChain() - Method in class net.dona.doip.server.DoipServerRequestImpl
- getConnectionClientId() - Method in interface net.dona.doip.server.DoipServerRequest
-
If the client is using a TLS client-side certificate, this returns the client id from the certificate.
- getConnectionClientId() - Method in class net.dona.doip.server.DoipServerRequestImpl
- getConnectionPublicKey() - Method in interface net.dona.doip.server.DoipServerRequest
-
If the client is using a TLS client-side certificate, this returns the public key from the certificate.
- getConnectionPublicKey() - Method in class net.dona.doip.server.DoipServerRequestImpl
- getDefaultCipherSuites() - Method in class net.dona.doip.util.tls.TlsProtocolAndCipherSuiteConfigurationUtil.ServerSocketFactoryWrapper
- getDefaultCipherSuites() - Method in class net.dona.doip.util.tls.TlsProtocolAndCipherSuiteConfigurationUtil.SocketFactoryWrapper
- getFirstSegment(InDoipMessage) - Static method in class net.dona.doip.util.InDoipMessageUtil
-
Returns the first segment of the supplied
InDoipMessage
, or null if it is empty. - getGson() - Static method in class net.dona.doip.util.GsonUtility
-
Returns a
Gson
. - getInput() - Method in interface net.dona.doip.server.DoipServerRequest
-
Returns the input of the request.
- getInput() - Method in class net.dona.doip.server.DoipServerRequestImpl
- getInputStream() - Method in interface net.dona.doip.InDoipSegment
-
Returns an input stream, for either a JSON segment or a bytes segment.
- getInputStream() - Method in class net.dona.doip.InDoipSegmentFromInputStream
- getInputStream() - Method in class net.dona.doip.InDoipSegmentFromJson
- getJson() - Method in interface net.dona.doip.InDoipSegment
-
Returns the JSON of a JSON segment
- getJson() - Method in class net.dona.doip.InDoipSegmentFromInputStream
- getJson() - Method in class net.dona.doip.InDoipSegmentFromJson
- getJsonWriter() - Method in interface net.dona.doip.OutDoipMessage
-
Returns a
Writer
that can be used to write to a JSON segment. - getJsonWriter() - Method in class net.dona.doip.OutDoipMessageImpl
- getName() - Method in class net.dona.doip.client.SortField
- getOperationId() - Method in interface net.dona.doip.server.DoipServerRequest
-
Returns the operation id (the operation to perform) given by the initial segment of the request.
- getOperationId() - Method in class net.dona.doip.server.DoipServerRequestImpl
- getOutput() - Method in class net.dona.doip.client.transport.DoipClientResponse
-
Returns the "output" of the response as an
InDoipMessage
for the client to read from. - getOutput() - Method in interface net.dona.doip.server.DoipServerResponse
-
Get an
OutDoipMessage
for writing output segments to the client. - getOutput() - Method in class net.dona.doip.server.DoipServerResponseImpl
- getPageNumber() - Method in class net.dona.doip.client.QueryParams
- getPageSize() - Method in class net.dona.doip.client.QueryParams
- getPort() - Method in class net.dona.doip.server.DoipServer
- getPrettyGson() - Static method in class net.dona.doip.util.GsonUtility
-
Returns a
Gson
which is configured for pretty-printing. - getPrivateKey(String) - Method in class net.dona.doip.util.tls.AutoSelfSignedKeyManager
- getRequestId() - Method in class net.dona.doip.server.DoipServerRequestImpl
- getRequestOutgoingMessage() - Method in interface net.dona.doip.client.transport.DoipExchange
-
Returns an instance of
OutDoipMessage
to which segments of the request input can be written. - getResponse() - Method in interface net.dona.doip.client.transport.DoipExchange
-
Returns the response from the server.
- getServerAliases(String, Principal[]) - Method in class net.dona.doip.util.tls.AutoSelfSignedKeyManager
- getSortFields() - Method in class net.dona.doip.client.QueryParams
- getStatus() - Method in class net.dona.doip.client.transport.DoipClientResponse
-
Returns the status code from the initial segment of the response.
- getStatusCode() - Method in exception net.dona.doip.client.DoipException
-
Gets the status code returned by the operation, if available.
- getSupportedCipherSuites() - Method in class net.dona.doip.util.tls.TlsProtocolAndCipherSuiteConfigurationUtil.ServerSocketFactoryWrapper
- getSupportedCipherSuites() - Method in class net.dona.doip.util.tls.TlsProtocolAndCipherSuiteConfigurationUtil.SocketFactoryWrapper
- getTargetId() - Method in interface net.dona.doip.server.DoipServerRequest
-
Returns the target id (the object on which to perform the operation) given by the initial segment of the request.
- getTargetId() - Method in class net.dona.doip.server.DoipServerRequestImpl
- getTerminalException() - Method in class net.dona.doip.InDoipMessageImpl
-
If the DOIP message was malformed, retrieves a
BadDoipException
indicating how; otherwise returns null. - GsonUtility - Class in net.dona.doip.util
-
A provider of
Gson
instances able to serialize instances ofStream
(as arrays) and instances ofPublicKey
andPrivateKey
(in JSON Web Key format). - GsonUtility() - Constructor for class net.dona.doip.util.GsonUtility
- GsonUtility.PrivateKeyTypeHierarchyAdapter - Class in net.dona.doip.util
- GsonUtility.PublicKeyTypeHierarchyAdapter - Class in net.dona.doip.util
- GsonUtility.StreamGsonTypeAdapter<T> - Class in net.dona.doip.util
-
Serializing
Stream
s of objects in a streaming fashion, which will be useful for outputting extremely large search results. - GsonUtility.StreamTypeAdapterFactory - Class in net.dona.doip.util
H
- hashCode() - Method in class net.dona.doip.server.DoipServerConfig
- hashCode() - Method in class net.dona.doip.server.DoipServerConfig.TlsConfig
- hashCode() - Method in class net.dona.doip.util.tls.TlsProtocolAndCipherSuiteConfigurationUtil.ServerSocketFactoryWrapper
- hashCode() - Method in class net.dona.doip.util.tls.TlsProtocolAndCipherSuiteConfigurationUtil.SocketFactoryWrapper
- hello(String, AuthenticationInfo) - Method in class net.dona.doip.client.DoipClient
-
Performs the "hello" operation.
- hello(String, AuthenticationInfo, ServiceInfo) - Method in class net.dona.doip.client.DoipClient
-
Performs the "hello" operation at a specified service.
I
- id - Variable in class net.dona.doip.client.DigitalObject
-
The identifier of the object.
- id - Variable in class net.dona.doip.client.Element
-
The id of the element.
- id - Variable in class net.dona.doip.server.DoipServerConfig.TlsConfig
-
Identifier for the server, which will be included in any automatically generated server certificate.
- in - Variable in class net.dona.doip.client.Element
-
The bytes of the element, as an
InputStream
. - InDoipMessage - Interface in net.dona.doip
-
A DOIP message to be read as input (for example, a response for the client, or a request for the server).
- InDoipMessageFromCollection - Class in net.dona.doip
-
An implementation of
InDoipMessage
constructed by supplying an explicit collection ofInDoipSegment
s. - InDoipMessageFromCollection(Collection<InDoipSegment>) - Constructor for class net.dona.doip.InDoipMessageFromCollection
-
Constructs an
InDoipMessage
whose segments are those in the supplied collection. - InDoipMessageFromJson - Class in net.dona.doip
-
An implementation of
InDoipMessage
constructed by supplying a singleJsonElement
, which will lead to a single JSON segment in the message. - InDoipMessageFromJson(JsonElement) - Constructor for class net.dona.doip.InDoipMessageFromJson
-
Constructs an
InDoipMessage
with a single JSON segment containing the supplied JSON. - InDoipMessageImpl - Class in net.dona.doip
-
An implementation of
InDoipMessage
which reads a serialized DOIP message from anInputStream
. - InDoipMessageImpl(InputStream) - Constructor for class net.dona.doip.InDoipMessageImpl
-
Constructs an
InDoipMessage
using the serialized DOIP message from the suppliedInputStream
. - InDoipMessageUtil - Class in net.dona.doip.util
-
Utility methods for
InDoipMessage
. - InDoipMessageUtil() - Constructor for class net.dona.doip.util.InDoipMessageUtil
- InDoipSegment - Interface in net.dona.doip
-
A segment of a DOIP message to be read as input (see
InDoipMessage
). - InDoipSegmentFromInputStream - Class in net.dona.doip
-
An implementation of
InDoipSegment
produced from in input stream; may be either a JSON segment or a bytes segment. - InDoipSegmentFromInputStream(boolean, InputStream) - Constructor for class net.dona.doip.InDoipSegmentFromInputStream
-
Constructs an
InDoipSegment
from an input stream. - InDoipSegmentFromJson - Class in net.dona.doip
-
An implementation of
InDoipSegment
produced from supplied JSON, which is always a JSON segment. - InDoipSegmentFromJson(JsonElement) - Constructor for class net.dona.doip.InDoipSegmentFromJson
-
Constructs an
InDoipSegment
JSON segment from the supplied JSON. - init() - Method in class net.dona.doip.server.DoipServer
-
Initializes the server listener and thread pool and begins serving requests.
- init(JsonObject) - Method in interface net.dona.doip.server.DoipProcessor
-
Initializes the DoipProcessor according to the supplied configuration object.
- input - Variable in class net.dona.doip.DoipRequestHeaders
-
Input supplied to the operation, when supplied in "compact" form as a single JSON segment.
- ipAddress - Variable in class net.dona.doip.client.ServiceInfo
-
The IP address to connect to.
- isClosed() - Method in interface net.dona.doip.client.transport.DoipConnection
-
Returns true if the connection is closed.
- isClosed() - Method in class net.dona.doip.client.transport.DoipConnectionImpl
- isClosed() - Method in class net.dona.doip.client.transport.ReleaseOnceDoipConnection
- isEmpty(InDoipMessage) - Static method in class net.dona.doip.util.InDoipMessageUtil
-
Returns true is the supplied
InDoipMessage
is empty (has no segments), otherwise false. - isJson() - Method in interface net.dona.doip.InDoipSegment
-
Returns true if this is a JSON segment, false if this is a bytes segment.
- isJson() - Method in class net.dona.doip.InDoipSegmentFromInputStream
- isJson() - Method in class net.dona.doip.InDoipSegmentFromJson
- isReverse() - Method in class net.dona.doip.client.SortField
- iterator() - Method in class net.dona.doip.client.DoipSearchResults
- iterator() - Method in interface net.dona.doip.client.SearchResults
-
Returns an
Iterator
of the search results (either String or DigitalObject). - iterator() - Method in class net.dona.doip.InDoipMessageFromCollection
- iterator() - Method in class net.dona.doip.InDoipMessageFromJson
- iterator() - Method in class net.dona.doip.InDoipMessageImpl
L
- length - Variable in class net.dona.doip.client.Element
-
The size of the element.
- listenAddress - Variable in class net.dona.doip.server.DoipServerConfig
-
IP address to which to bind the listener.
- listOperations(String, AuthenticationInfo) - Method in class net.dona.doip.client.DoipClient
-
Lists operations available for a digital object.
- listOperations(String, AuthenticationInfo, ServiceInfo) - Method in class net.dona.doip.client.DoipClient
-
Lists operations available for a digital object at a specified service.
M
- maxIdleTimeMillis - Variable in class net.dona.doip.server.DoipServerConfig
-
Idle time in ms for an open DOIP connection while waiting for another request (defaults to 5 minutes).
- MESSAGE_ATT - Static variable in class net.dona.doip.DoipConstants
N
- net.dona.doip - package net.dona.doip
- net.dona.doip.client - package net.dona.doip.client
- net.dona.doip.client.transport - package net.dona.doip.client.transport
- net.dona.doip.server - package net.dona.doip.server
- net.dona.doip.util - package net.dona.doip.util
- net.dona.doip.util.tls - package net.dona.doip.util.tls
- numThreads - Variable in class net.dona.doip.server.DoipServerConfig
-
Number of request-processing threads (defaults to 200).
O
- OP_CREATE - Static variable in class net.dona.doip.DoipConstants
- OP_DELETE - Static variable in class net.dona.doip.DoipConstants
- OP_HELLO - Static variable in class net.dona.doip.DoipConstants
- OP_LIST_OPERATIONS - Static variable in class net.dona.doip.DoipConstants
- OP_RETRIEVE - Static variable in class net.dona.doip.DoipConstants
- OP_SEARCH - Static variable in class net.dona.doip.DoipConstants
- OP_UPDATE - Static variable in class net.dona.doip.DoipConstants
- operationId - Variable in class net.dona.doip.DoipRequestHeaders
-
The id of the operation to be performed.
- OutDoipMessage - Interface in net.dona.doip
-
A DOIP message to be written as output (for example, a request from the client, or a response from the server).
- OutDoipMessageImpl - Class in net.dona.doip
-
An implementation of
OutDoipMessage
which writes a serialized DOIP message into anOutputStream
. - OutDoipMessageImpl(OutputStream) - Constructor for class net.dona.doip.OutDoipMessageImpl
-
Constructs an
OutDoipMessage
which will write a serialized DOIP message into the suppliedOutputStream
. - output - Variable in class net.dona.doip.DoipResponseHeaders
-
Output of the operation, when supplied in "compact" form as a single JSON segment.
P
- parallelStream() - Method in interface net.dona.doip.client.SearchResults
-
Returns a potentially parallel
Stream
of the search results (either String or DigitalObject). - parseIdentityHandle(X509Certificate) - Static method in class net.dona.doip.util.tls.X509IdParser
-
Parses the identity handle from the certificate.
- parseIdentityHandle(X509Certificate[]) - Static method in class net.dona.doip.util.tls.X509IdParser
-
Parses the identity handle from the first certificate in a chain.
- PasswordAuthenticationInfo - Class in net.dona.doip.client
-
An
AuthenticationInfo
which provides a username and a password. - PasswordAuthenticationInfo(String, String) - Constructor for class net.dona.doip.client.PasswordAuthenticationInfo
- PasswordAuthenticationInfo(String, String, String) - Constructor for class net.dona.doip.client.PasswordAuthenticationInfo
- performOperation(String, String, AuthenticationInfo, JsonObject) - Method in class net.dona.doip.client.DoipClient
-
Performs an operation, looking up the target's service information by handle resolution.
- performOperation(String, String, AuthenticationInfo, JsonObject, JsonElement) - Method in class net.dona.doip.client.DoipClient
-
Performs an operation, looking up the target's service information by handle resolution.
- performOperation(String, String, AuthenticationInfo, JsonObject, JsonElement, ServiceInfo) - Method in class net.dona.doip.client.DoipClient
-
Performs an operation at a specified service.
- performOperation(String, String, AuthenticationInfo, JsonObject, ServiceInfo) - Method in class net.dona.doip.client.DoipClient
-
Performs an operation at a specified service.
- performOperation(String, String, AuthenticationInfo, JsonObject, InDoipMessage) - Method in class net.dona.doip.client.DoipClient
-
Performs an operation, looking up the target's service information by handle resolution.
- performOperation(String, String, AuthenticationInfo, JsonObject, InDoipMessage, ServiceInfo) - Method in class net.dona.doip.client.DoipClient
-
Performs an operation at a specified service.
- performOperation(DoipRequestHeaders, InDoipMessage) - Method in class net.dona.doip.client.DoipClient
-
Performs an operation, looking up the target's service information by handle resolution.
- performOperation(DoipRequestHeaders, InDoipMessage, ServiceInfo) - Method in class net.dona.doip.client.DoipClient
-
Performs an operation at a specified service.
- port - Variable in class net.dona.doip.client.ServiceInfo
-
The port to connect to.
- port - Variable in class net.dona.doip.client.transport.ConnectionOptions
-
The port of the DOIP server.
- port - Variable in class net.dona.doip.server.DoipServerConfig
-
Port to which to bind the listener.
- privateKey - Variable in class net.dona.doip.server.DoipServerConfig.TlsConfig
-
Private key for the server.
- PrivateKeyAuthenticationInfo - Class in net.dona.doip.client
-
An
AuthenticationInfo
which provides an identity and a JWT signed by that entity's private key. - PrivateKeyAuthenticationInfo(String, PrivateKey) - Constructor for class net.dona.doip.client.PrivateKeyAuthenticationInfo
- PrivateKeyAuthenticationInfo(String, PrivateKey, String) - Constructor for class net.dona.doip.client.PrivateKeyAuthenticationInfo
- PrivateKeyTypeHierarchyAdapter() - Constructor for class net.dona.doip.util.GsonUtility.PrivateKeyTypeHierarchyAdapter
- process(DoipServerRequest, DoipServerResponse) - Method in interface net.dona.doip.server.DoipProcessor
-
Process a request and provide a response.
- processorClass - Variable in class net.dona.doip.server.DoipServerConfig
-
Class name of a
DoipProcessor
, which will be automatically instantiated, initialized, and later shut down by aDoipServer
when constructed usingDoipServer(DoipServerConfig)
. - processorConfig - Variable in class net.dona.doip.server.DoipServerConfig
-
JSON used to initialize an automatically constructed
DoipProcessor
(see {DoipServerConfig.processorClass
). - protocol - Variable in class net.dona.doip.client.ServiceInfo
-
The protocol; currently assumed to be TCP.
- protocolVersion - Variable in class net.dona.doip.client.ServiceInfo
-
The protocol version; currently assume to be DOIPv2.
- publicKey - Variable in class net.dona.doip.client.ServiceInfo
-
The public key of the service (serialized in JWK format).
- publicKey - Variable in class net.dona.doip.server.DoipServerConfig.TlsConfig
-
Public key for the server.
- PublicKeyTypeHierarchyAdapter() - Constructor for class net.dona.doip.util.GsonUtility.PublicKeyTypeHierarchyAdapter
Q
- QueryParams - Class in net.dona.doip.client
-
An object for holding query parameters for
DoipClient
search operations. - QueryParams(int, int) - Constructor for class net.dona.doip.client.QueryParams
-
Constructs a QueryParams.
- QueryParams(int, int, List<SortField>) - Constructor for class net.dona.doip.client.QueryParams
-
Constructs a QueryParams.
R
- read(JsonReader) - Method in class net.dona.doip.util.GsonUtility.StreamGsonTypeAdapter
- readCertAsPem(Reader) - Static method in class net.dona.doip.util.tls.X509CertificateGenerator
- readCertChainAsPem(Reader) - Static method in class net.dona.doip.util.tls.X509CertificateGenerator
- readTimeoutMs - Variable in class net.dona.doip.client.transport.ConnectionOptions
-
Read timeout in ms.
- release() - Method in class net.dona.doip.client.transport.ReleaseOnceDoipConnection
- release(DoipConnection) - Method in class net.dona.doip.client.transport.DoipConnectionPool
- releaseConnection() - Method in class net.dona.doip.client.ConnectionAndPool
- ReleaseOnceDoipConnection - Class in net.dona.doip.client.transport
-
An implementation of
DoipConnection
which is used byDoipConnectionPool
and ensures correct behavior for releasing connections back into the pool. - ReleaseOnceDoipConnection(DoipConnection) - Constructor for class net.dona.doip.client.transport.ReleaseOnceDoipConnection
- requestId - Variable in class net.dona.doip.DoipRequestHeadersWithRequestId
-
The requestId of the request, generally automatically generated by processing code.
- requestId - Variable in class net.dona.doip.DoipResponseHeadersWithRequestId
- retrieve(String, boolean, AuthenticationInfo) - Method in class net.dona.doip.client.DoipClient
-
Retrieves a digital object, possibly including all element data.
- retrieve(String, boolean, AuthenticationInfo, ServiceInfo) - Method in class net.dona.doip.client.DoipClient
-
Retrieves a digital object from a specified service, possibly including all element data.
- retrieve(String, AuthenticationInfo) - Method in class net.dona.doip.client.DoipClient
-
Retrieves a digital object.
- retrieve(String, AuthenticationInfo, ServiceInfo) - Method in class net.dona.doip.client.DoipClient
-
Retrieves a digital object from a specified service.
- retrieveElement(String, String, AuthenticationInfo) - Method in class net.dona.doip.client.DoipClient
-
Retrieves an element from a digital object.
- retrieveElement(String, String, AuthenticationInfo, ServiceInfo) - Method in class net.dona.doip.client.DoipClient
-
Retrieves an element from a digital object at a specified service.
- retrievePartialElement(String, String, Long, Long, AuthenticationInfo, ServiceInfo) - Method in class net.dona.doip.client.DoipClient
-
Retrieves a byte range of an element from a digital object at a specified service.
S
- search(String, String, QueryParams, AuthenticationInfo) - Method in class net.dona.doip.client.DoipClient
-
Search for digital objects, returning the full results as digital objects.
- search(String, String, QueryParams, AuthenticationInfo, ServiceInfo) - Method in class net.dona.doip.client.DoipClient
-
Search for digital objects, returning the full results as digital objects.
- searchIds(String, String, QueryParams, AuthenticationInfo) - Method in class net.dona.doip.client.DoipClient
-
Search for digital objects, returning the ids of the results.
- searchIds(String, String, QueryParams, AuthenticationInfo, ServiceInfo) - Method in class net.dona.doip.client.DoipClient
-
Search for digital objects, returning the ids of the results.
- SearchResults<T> - Interface in net.dona.doip.client
-
A representation of search results from
DoipClient
search operations. - sendCompactRequest(DoipRequestHeaders) - Method in interface net.dona.doip.client.transport.DoipConnection
-
Sends a "compact" request consisting of a single JSON segment, with the request "input" embedded in the initial segment.
- sendCompactRequest(DoipRequestHeaders) - Method in class net.dona.doip.client.transport.DoipConnectionImpl
- sendCompactRequest(DoipRequestHeaders) - Method in class net.dona.doip.client.transport.ReleaseOnceDoipConnection
- sendRequest(DoipRequestHeaders, InDoipMessage) - Method in interface net.dona.doip.client.transport.DoipConnection
-
Sends a request with the specified initial segment, and subsequent segments (the request "input") read from the supplied InDoipMessage.
- sendRequest(DoipRequestHeaders, InDoipMessage) - Method in class net.dona.doip.client.transport.DoipConnectionImpl
- sendRequest(DoipRequestHeaders, InDoipMessage) - Method in class net.dona.doip.client.transport.ReleaseOnceDoipConnection
- sendRequestToExchange(DoipRequestHeaders) - Method in interface net.dona.doip.client.transport.DoipConnection
-
Sends a request using a specified initial segment, and providing a
DoipExchange
which allows writing additional segments as well as reading segments from the response. - sendRequestToExchange(DoipRequestHeaders) - Method in class net.dona.doip.client.transport.DoipConnectionImpl
- sendRequestToExchange(DoipRequestHeaders) - Method in class net.dona.doip.client.transport.ReleaseOnceDoipConnection
- serialize(PrivateKey, Type, JsonSerializationContext) - Method in class net.dona.doip.util.GsonUtility.PrivateKeyTypeHierarchyAdapter
- serialize(PublicKey, Type, JsonSerializationContext) - Method in class net.dona.doip.util.GsonUtility.PublicKeyTypeHierarchyAdapter
- serverId - Variable in class net.dona.doip.client.transport.ConnectionOptions
-
The identifier of the server; if present
ConnectionOptions.trustedServerPublicKeys
should also be provided. - ServerSocketFactoryWrapper(SSLServerSocketFactory) - Constructor for class net.dona.doip.util.tls.TlsProtocolAndCipherSuiteConfigurationUtil.ServerSocketFactoryWrapper
- serviceId - Variable in class net.dona.doip.client.ServiceInfo
-
The service identifier.
- ServiceInfo - Class in net.dona.doip.client
-
A representation of a service identifier together with the DOIPServiceInfo needed for connecting to the DOIP service.
- ServiceInfo() - Constructor for class net.dona.doip.client.ServiceInfo
-
Constructs a ServiceInfo with all fields unpopulated.
- ServiceInfo(String) - Constructor for class net.dona.doip.client.ServiceInfo
-
Constructs a ServiceInfo with only a service identifier.
- ServiceInfo(String, String, int) - Constructor for class net.dona.doip.client.ServiceInfo
-
Constructs a ServiceInfo with a service identifier, an IP address, and a port.
- ServiceInfo(String, String, int, PublicKey) - Constructor for class net.dona.doip.client.ServiceInfo
-
Constructs a ServiceInfo with a service identifier, an IP address, a port, and the expecte public key in the server certificate.
- serviceName - Variable in class net.dona.doip.client.ServiceInfo
-
Currently unused.
- setAttribute(String, JsonElement) - Method in class net.dona.doip.client.DigitalObject
-
A convenience method that sets an attribute on the object.
- setAttribute(String, JsonElement) - Method in interface net.dona.doip.server.DoipServerResponse
-
Set a single attribute in the initial segment of the response.
- setAttribute(String, JsonElement) - Method in class net.dona.doip.server.DoipServerResponseImpl
- setAttribute(String, String) - Method in class net.dona.doip.client.DigitalObject
-
A convenience method that sets an attribute on the object.
- setAttribute(String, String) - Method in interface net.dona.doip.server.DoipServerResponse
-
Set (as a String) a single attribute in the initial segment of the response.
- setAttribute(String, String) - Method in class net.dona.doip.server.DoipServerResponseImpl
- setAttributes(JsonObject) - Method in interface net.dona.doip.server.DoipServerResponse
-
Set the entire collection of attributes in the initial segment of the response.
- setAttributes(JsonObject) - Method in class net.dona.doip.server.DoipServerResponseImpl
- setCompleter(CompletableFuture<?>) - Method in class net.dona.doip.InDoipMessageImpl
-
Sets a
CompletableFuture
which will be completed when the message is fully processed. - setOnClose(Runnable) - Method in class net.dona.doip.client.transport.DoipClientResponse
-
Sets a callback which will be run after closing the response.
- setStatus(String) - Method in interface net.dona.doip.server.DoipServerResponse
-
Sets the status code in the initial segment of the response.
- setStatus(String) - Method in class net.dona.doip.server.DoipServerResponseImpl
- setup(GsonBuilder) - Static method in class net.dona.doip.util.GsonUtility
-
Sets up an instance of
GsonBuilder
to serialize streams and keys. - shutdown() - Method in class net.dona.doip.client.transport.DoipConnectionPool
- shutdown() - Method in interface net.dona.doip.server.DoipProcessor
-
Shuts down the DoipProcessor.
- shutdown() - Method in class net.dona.doip.server.DoipServer
-
Shuts down the server listener and thread pool.
- size() - Method in class net.dona.doip.client.DoipSearchResults
- size() - Method in interface net.dona.doip.client.SearchResults
-
Returns the full number of results across all pages, or -1 if the number is not available
- SocketFactoryWrapper(SSLSocketFactory) - Constructor for class net.dona.doip.util.tls.TlsProtocolAndCipherSuiteConfigurationUtil.SocketFactoryWrapper
- SortField - Class in net.dona.doip.client
-
A specification of part of a sort order for
QueryParams
. - SortField(String) - Constructor for class net.dona.doip.client.SortField
- SortField(String, boolean) - Constructor for class net.dona.doip.client.SortField
-
Constructs a SortField.
- spliterator() - Method in interface net.dona.doip.client.SearchResults
- spliterator() - Method in class net.dona.doip.InDoipMessageFromCollection
- spliterator() - Method in class net.dona.doip.InDoipMessageFromJson
- spliterator() - Method in class net.dona.doip.InDoipMessageImpl
- status - Variable in class net.dona.doip.DoipResponseHeaders
-
The status code for the response; see
DoipConstants
for commonly used status codes. - STATUS_BAD_REQUEST - Static variable in class net.dona.doip.DoipConstants
- STATUS_CONFLICT - Static variable in class net.dona.doip.DoipConstants
- STATUS_DECLINED - Static variable in class net.dona.doip.DoipConstants
- STATUS_ERROR - Static variable in class net.dona.doip.DoipConstants
- STATUS_FORBIDDEN - Static variable in class net.dona.doip.DoipConstants
- STATUS_NOT_FOUND - Static variable in class net.dona.doip.DoipConstants
- STATUS_OK - Static variable in class net.dona.doip.DoipConstants
- STATUS_UNAUTHENTICATED - Static variable in class net.dona.doip.DoipConstants
- storeCertAndKey(KeyStore, Certificate, PrivateKey, String, String) - Static method in class net.dona.doip.util.tls.X509CertificateGenerator
- stream() - Method in interface net.dona.doip.client.SearchResults
-
Returns an
Stream
of the search results (either String or DigitalObject). - stream() - Method in interface net.dona.doip.InDoipMessage
-
Returns an stream over elements of type
InDoipSegment
. - stream() - Method in class net.dona.doip.InDoipMessageFromCollection
- stream() - Method in class net.dona.doip.InDoipMessageFromJson
- stream() - Method in class net.dona.doip.InDoipMessageImpl
- StreamGsonTypeAdapter(TypeAdapter<T>) - Constructor for class net.dona.doip.util.GsonUtility.StreamGsonTypeAdapter
- StreamTypeAdapterFactory() - Constructor for class net.dona.doip.util.GsonUtility.StreamTypeAdapterFactory
T
- targetId - Variable in class net.dona.doip.DoipRequestHeaders
-
The id of the object on which the operation is to be performed.
- tlsConfig - Variable in class net.dona.doip.server.DoipServerConfig
-
TLS configuration for a
DoipServer
. - TlsConfig() - Constructor for class net.dona.doip.server.DoipServerConfig.TlsConfig
- TlsProtocolAndCipherSuiteConfigurationUtil - Class in net.dona.doip.util.tls
-
Utilities for restricting TLS connections to use appropriate protocol versions and cipher suites.
- TlsProtocolAndCipherSuiteConfigurationUtil() - Constructor for class net.dona.doip.util.tls.TlsProtocolAndCipherSuiteConfigurationUtil
- TlsProtocolAndCipherSuiteConfigurationUtil.ServerSocketFactoryWrapper - Class in net.dona.doip.util.tls
-
A wrapper for an
SSLServerSocketFactory
which ensures that all created server sockets will use appropriate protocols and cipher suites. - TlsProtocolAndCipherSuiteConfigurationUtil.SocketFactoryWrapper - Class in net.dona.doip.util.tls
-
A wrapper for an
SSLSocketFactory
which ensures that all created sockets will use appropriate protocols and cipher suites. - TokenAuthenticationInfo - Class in net.dona.doip.client
-
An
AuthenticationInfo
which supplies a specified token for a specified clientId. - TokenAuthenticationInfo(String, String) - Constructor for class net.dona.doip.client.TokenAuthenticationInfo
- TokenAuthenticationInfo(String, String, String) - Constructor for class net.dona.doip.client.TokenAuthenticationInfo
- toString() - Method in class net.dona.doip.util.tls.TlsProtocolAndCipherSuiteConfigurationUtil.ServerSocketFactoryWrapper
- toString() - Method in class net.dona.doip.util.tls.TlsProtocolAndCipherSuiteConfigurationUtil.SocketFactoryWrapper
- TransportDoipClient - Class in net.dona.doip.client.transport
-
A DOIP client close to the transport protocol.
- TransportDoipClient() - Constructor for class net.dona.doip.client.transport.TransportDoipClient
- trustedServerPublicKeys - Variable in class net.dona.doip.client.transport.ConnectionOptions
-
A list of public keys that will be trusted for this server.
- TrustManagerForSpecifiedServerIdAndKeys - Class in net.dona.doip.util.tls
-
A trust manager which expects the server certificate to both have the specified identitifier, and to have one of a list of specified public keys.
- TrustManagerForSpecifiedServerIdAndKeys(String, List<PublicKey>) - Constructor for class net.dona.doip.util.tls.TrustManagerForSpecifiedServerIdAndKeys
-
Constructs a trust manager which expects the server certificate to both have the specified identitifier, and to have one of a list of specified public keys.
- type - Variable in class net.dona.doip.client.DigitalObject
-
The type of the object.
- type - Variable in class net.dona.doip.client.Element
-
The type of the element.
U
- update(DigitalObject, AuthenticationInfo) - Method in class net.dona.doip.client.DoipClient
-
Updates a digital object.
- update(DigitalObject, AuthenticationInfo, ServiceInfo) - Method in class net.dona.doip.client.DoipClient
-
Updates a digital object at a specified service.
W
- write(JsonWriter, Stream<T>) - Method in class net.dona.doip.util.GsonUtility.StreamGsonTypeAdapter
- writeBytes(byte[]) - Method in interface net.dona.doip.OutDoipMessage
-
Writes a bytes segment into the outgoing message.
- writeBytes(byte[]) - Method in class net.dona.doip.OutDoipMessageImpl
- writeBytes(InputStream) - Method in interface net.dona.doip.OutDoipMessage
-
Writes a bytes segment into the outgoing message.
- writeBytes(InputStream) - Method in class net.dona.doip.OutDoipMessageImpl
- writeCertAsPem(Writer, Certificate) - Static method in class net.dona.doip.util.tls.X509CertificateGenerator
- writeCompactOutput(JsonElement) - Method in interface net.dona.doip.server.DoipServerResponse
-
Write a "compact" single-segment output.
- writeCompactOutput(JsonElement) - Method in class net.dona.doip.server.DoipServerResponseImpl
- writeInitialSegment(JsonElement) - Method in class net.dona.doip.server.DoipServerResponseImpl
- writeJson(byte[]) - Method in interface net.dona.doip.OutDoipMessage
-
Writes a JSON segment into the outgoing message.
- writeJson(byte[]) - Method in class net.dona.doip.OutDoipMessageImpl
- writeJson(JsonElement) - Method in interface net.dona.doip.OutDoipMessage
-
Writes a JSON segment into the outgoing message.
- writeJson(JsonElement) - Method in class net.dona.doip.OutDoipMessageImpl
- writeJson(String) - Method in interface net.dona.doip.OutDoipMessage
-
Writes a JSON segment into the outgoing message.
- writeJson(String) - Method in class net.dona.doip.OutDoipMessageImpl
X
- X509CertificateGenerator - Class in net.dona.doip.util.tls
-
Utility methods to generate X509 certificates, and to read and write certificates from and to PEM files.
- X509CertificateGenerator() - Constructor for class net.dona.doip.util.tls.X509CertificateGenerator
- X509IdParser - Class in net.dona.doip.util.tls
-
Utility methods to parse a (handle) identity from an X509 certificate.
- X509IdParser() - Constructor for class net.dona.doip.util.tls.X509IdParser
All Classes All Packages