- cancelled() - Method in interface com.mathworks.mps.client.MWRequestStateVisitor
-
The request was cancelled at the client's request (this is a terminal state).
- close() - Method in interface com.mathworks.mps.client.MWClient
-
Close all open server connections and free any native resources.
- close() - Method in class com.mathworks.mps.client.MWHttpClient
-
Closes the client-server communication.
- com.mathworks.mps.client - package com.mathworks.mps.client
-
Provides library support for Java clients to communicate with MATLAB Production Server.
- com.mathworks.mps.client.annotations - package com.mathworks.mps.client.annotations
-
Contains custom annotations for MATLAB Production Server Java client
- createComponentProxy(URL, MWMarshalingRules) - Method in interface com.mathworks.mps.client.MWClient
-
Creates a reflection-based proxy object reference to a deployable hosted by MATLAB Production Server.
- createComponentProxy(URL) - Method in interface com.mathworks.mps.client.MWClient
-
Creates a proxy object reference to a deployable archive hosted by MATLAB Production Server.
- createComponentProxy(URL, MWMarshalingRules) - Method in class com.mathworks.mps.client.MWHttpClient
-
Creates a reflection-based proxy object reference to a deployable archive
hosted by MATLAB Production Server.
- createComponentProxy(URL) - Method in class com.mathworks.mps.client.MWHttpClient
-
Creates a reflection-based proxy object reference to a deployable archive
hosted by MATLAB Production Server.
- createProxy(URL, Class<T>) - Method in interface com.mathworks.mps.client.MWClient
-
Creates an interface-based proxy object reference to a deployable archive hosted by MATLAB Production Server.
- createProxy(URL, Class<T>) - Method in class com.mathworks.mps.client.MWHttpClient
-
Creates an interface-based proxy object reference to a deployable archive
hosted by the server.
- getClient() - Method in interface com.mathworks.mps.client.MWRequest
-
Get the client to which the request is attached.
- getClientUUID() - Method in class com.mathworks.mps.client.MWHttpClient
-
Returns the client's universally unique identifier (UUID).
- getConfig() - Method in class com.mathworks.mps.client.MWHttpClient
-
Returns a reference to the connection configuration associated with this
instance of MWHttpClient
.
- getFile() - Method in class com.mathworks.mps.client.MATLABStackFrame
-
Get the complete path to MATLAB file including the extension.
- getFuture() - Method in interface com.mathworks.mps.client.MWRequest
-
Returns a future object that can be used to get the result or cancel this request.
- getHostnameVerifier() - Method in interface com.mathworks.mps.client.MWSSLConfig
-
Provides a user defined hostname verifier that will be used only if URL's hostname and server's hostname
do not match during the default HTTPS
hostname verification.
- getHostnameVerifier() - Method in class com.mathworks.mps.client.MWSSLDefaultConfig
-
Returns the default implementation of HostnameVerifier
interface.
- getInputParams() - Method in class com.mathworks.mps.client.MWInvokeRequest
-
Returns the input parameters.
- getInstance(String) - Static method in class com.mathworks.mps.client.MWCustomSSLContext
-
Creates a SSLContext object that implements the specified secure socket protocol where the enabled protocols of the
SSL object returned will be reduced to "protocol".
- getInstance(String, String) - Static method in class com.mathworks.mps.client.MWCustomSSLContext
-
Creates a SSLContext object that implements the specified secure socket protocol "protocol" where
the enabled protocols of the SSL object returned will be reduced to "protocol" and "protocol2".
- getInstance(String...) - Static method in class com.mathworks.mps.client.MWCustomSSLContext
-
Creates a SSLContext object that implements the specified secure socket protocol given by the first argument, where
the enabled protocols of the SSL object returned will be reduced to "protocols".
- getLine() - Method in class com.mathworks.mps.client.MATLABStackFrame
-
Get the line number in MATLAB file
- getMATLABIdentifier() - Method in exception com.mathworks.mps.client.MATLABException
-
Returns identifier used when error was thrown in MATLAB
- getMATLABStackTrace() - Method in exception com.mathworks.mps.client.MATLABException
-
Returns MATLAB stack with 0 or more MATLABStackFrame
.
- getMaxConnectionsPerAddress() - Method in interface com.mathworks.mps.client.MWHttpClientConfig
-
Get maximum number of connections per address used by MWHttpClient
to fulfill multiple
simultaneous requests created by client.
- getMaxConnectionsPerAddress() - Method in class com.mathworks.mps.client.MWHttpClientDefaultConfig
-
Returns the default value for maximum connections per address
- getMessage() - Method in exception com.mathworks.mps.client.MATLABException
-
Returns detailed MATLAB message corresponding to an error
- getMessage() - Method in exception com.mathworks.mps.client.MWHttpException
-
Get detailed message comprising of HTTP response status and response message associated with a failed request.
- getMLFunction() - Method in class com.mathworks.mps.client.MWInvokeRequest
-
Returns the MATLAB function name.
- getName() - Method in class com.mathworks.mps.client.MATLABStackFrame
-
Get the name of MATLAB function in MATLAB file.
- getNargout() - Method in class com.mathworks.mps.client.MWInvokeRequest
-
Returns the number of output arguments.
- getResponseCode() - Method in exception com.mathworks.mps.client.MWHttpException
-
Get HTTP response status associated with a failed request.
- getResponseMessage() - Method in exception com.mathworks.mps.client.MWHttpException
-
Get HTTP response message associated with a failed request.
- getResponseSizeLimit() - Method in interface com.mathworks.mps.client.MWHttpClientConfig
-
Get the maximum response size the client can accept.
- getResponseSizeLimit() - Method in class com.mathworks.mps.client.MWHttpClientDefaultConfig
-
Returns the deafault maximum response size limit in bytes
- getServerAuthorizer() - Method in interface com.mathworks.mps.client.MWSSLConfig
-
Provides an interface for performing extra level of authorization based on the server certificate
provided during the SSL handshake.
- getServerAuthorizer() - Method in class com.mathworks.mps.client.MWSSLDefaultConfig
-
Returns the default implementation for extra level of server authorization.
- getSSLConfig() - Method in class com.mathworks.mps.client.MWHttpClient
-
Returns a reference to the SSL configuration associated with this
instance of MWHttpClient
.
- getSSLContext() - Method in interface com.mathworks.mps.client.MWSSLConfig
-
Returns an SSLContext
that provides secure socket protocol implementation required for
supporting HTTPS
protocol.
- getSSLContext() - Method in class com.mathworks.mps.client.MWSSLDefaultConfig
-
Returns the default SSLContext
obtained by the call to
SSLContext.getDefault()
- getState() - Method in interface com.mathworks.mps.client.MWRequest
-
Get the current state of the request.
- getStructTypes() - Method in class com.mathworks.mps.client.MWDefaultMarshalingRules
-
Get the list of user defined Java classes that represent a MATLAB struct
- getStructTypes() - Method in interface com.mathworks.mps.client.MWMarshalingRules
-
Get the list of user defined Java classes that represent a MATLAB struct
- getTargetType() - Method in class com.mathworks.mps.client.MWInvokeRequest
-
Returns the targetType of this request.
- getTimeOutMs() - Method in interface com.mathworks.mps.client.MWHttpClientConfig
-
Get the time out in milliseconds for a client to receive response from the server.
- getTimeOutMs() - Method in class com.mathworks.mps.client.MWHttpClientDefaultConfig
-
Returns the default amount of time, in milliseconds, the client will wait for a response
- MATLABException - Exception in com.mathworks.mps.client
-
Represents a MATLAB error.
- MATLABException(String, String, List<MATLABStackFrame>) - Constructor for exception com.mathworks.mps.client.MATLABException
-
Create an instance of MATLABException
using MATLAB error message, error identifier and a list
of MATLABStackFrame
representing MATLAB stack trace associated with an error in MATLAB.
- MATLABStackFrame - Class in com.mathworks.mps.client
-
Represents an element in MATLAB stack trace obtained from MATLABException
.
- MATLABStackFrame(String, String, int) - Constructor for class com.mathworks.mps.client.MATLABStackFrame
-
Construct MATLABStackFrame
using file name, function name and line number
- MWClient - Interface in com.mathworks.mps.client
-
The MWClient interface needs to be implemented by a class that is meant to provide client-server
communication for MATLAB Production Server.
- MWCustomSSLContext - Class in com.mathworks.mps.client
-
This class is going to use a standard SSLContext to implement an SSLContextSpi.
- MWDefaultMarshalingRules - Class in com.mathworks.mps.client
-
Provides a default implementation of MWMarshalingRules
.
- MWDefaultMarshalingRules() - Constructor for class com.mathworks.mps.client.MWDefaultMarshalingRules
-
- MWHttpClient - Class in com.mathworks.mps.client
-
Establishes an HTTP/HTTPS based connection between a Java client and MATLAB
Production Server.
- MWHttpClient() - Constructor for class com.mathworks.mps.client.MWHttpClient
-
Create an MWHttpClient
instance with an instance of
MWHttpClientDefaultConfig
to configure the client-server
connection and an instance of MWSSLDefaultConfig
to
configure secure socket connection over HTTPS
.
- MWHttpClient(MWHttpClientConfig) - Constructor for class com.mathworks.mps.client.MWHttpClient
-
Create an MWHttpClient
instance with a user provided
configuration.
- MWHttpClient(MWSSLConfig) - Constructor for class com.mathworks.mps.client.MWHttpClient
-
Create an MWHttpClient
instance with a user user provided
configuration for the secure socket communication.
- MWHttpClient(MWHttpClientConfig, MWSSLConfig) - Constructor for class com.mathworks.mps.client.MWHttpClient
-
Create an MWHttpClient
instance with user provided
configurations for both the client-server connection and the SSL layer.
- MWHttpClientConfig - Interface in com.mathworks.mps.client
-
Interface defining the configuration of the client-server connection used by
MWHttpClient
.
- MWHttpClientDefaultConfig - Class in com.mathworks.mps.client
-
Default configuration used for creating an instance of MWHttpClient
.
- MWHttpClientDefaultConfig() - Constructor for class com.mathworks.mps.client.MWHttpClientDefaultConfig
-
- MWHttpException - Exception in com.mathworks.mps.client
-
Represents a failed MATLAB Production Server request originated by MWHttpClient
.
- MWHttpException(int, String) - Constructor for exception com.mathworks.mps.client.MWHttpException
-
Create MWHttpException
using HTTP response code and HTTP message, associated with a failed
request.
- MWInvokable - Interface in com.mathworks.mps.client
-
The MWInvocable interface provides methods used to directly invoke MATLAB
functions on a MATLAB Production Server instance using a reflection-based
proxy object.
- MWInvokeRequest<T> - Class in com.mathworks.mps.client
-
The class represents a MATLAB execution request.
- MWInvokeRequest(String, Class<T>) - Constructor for class com.mathworks.mps.client.MWInvokeRequest
-
Constructs an instance from the String which must be a valid deployed MATLAB function.
- MWMarshalingRules - Interface in com.mathworks.mps.client
-
This interface defines rules for marshaling data between Java and MATLAB.
- MWRequest<T> - Interface in com.mathworks.mps.client
-
An asynchronous MATLAB execution request that has been attached to an MWClient.
- MWRequestListener<T> - Interface in com.mathworks.mps.client
-
Receives notification when a request's state changes.
- MWRequestState<T> - Interface in com.mathworks.mps.client
-
The state of an asynchronous MATLAB execution request (immutable).
- MWRequestStateVisitor<T> - Interface in com.mathworks.mps.client
-
Visits the state of an asynchronous MATLAB execution request.
- MWSSLConfig - Interface in com.mathworks.mps.client
-
This interface allows MPS client to communicate with an MPS server instance over HTTPS
- MWSSLDefaultConfig - Class in com.mathworks.mps.client
-
Default implementation of MWSSLConfig
interface.
- MWSSLDefaultConfig() - Constructor for class com.mathworks.mps.client.MWSSLDefaultConfig
-
- MWSSLServerAuthorizer - Interface in com.mathworks.mps.client
-
This class is the base interface for server authorization based on the server certificate available during the
SSL handshake.
- MWStructureList - Annotation Type in com.mathworks.mps.client.annotations
-
This annotation must be used for an interface with methods representing MATLAB functions
which expect a struct as input or output.