Skip navigation links
A C D E F G H I L M N P R S T V W 

A

authorize(Certificate) - Method in interface com.mathworks.mps.client.MWSSLServerAuthorizer
Authorize a server based on its certificate

C

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
com.mathworks.mps.client.rest - package com.mathworks.mps.client.rest
RESTful API and Protocol Buffer Support
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.

D

DEFAULT_IS_COOKIE_ENABLED - Static variable in interface com.mathworks.mps.client.MWHttpClientConfig
 
DEFAULT_IS_INTERRUPTABLE - Static variable in interface com.mathworks.mps.client.MWHttpClientConfig
 
DEFAULT_NUM_CONNECTIONS_PER_ADDRESS - Static variable in interface com.mathworks.mps.client.MWHttpClientConfig
 
DEFAULT_RESPONSE_SIZE_LIMIT - Static variable in interface com.mathworks.mps.client.MWHttpClientConfig
 
DEFAULT_STRUCT_TYPES - Static variable in interface com.mathworks.mps.client.MWMarshalingRules
 
DEFAULT_TIMEOUT_MS - Static variable in interface com.mathworks.mps.client.MWHttpClientConfig
 

E

equals(Object) - Method in class com.mathworks.mps.client.MATLABStackFrame
Returns true if 2 MATLABStackFrame instances have the same file name, function name and line number
expired() - Method in interface com.mathworks.mps.client.MWRequestStateVisitor
The request could not be found on the server at its previous URL.

F

failed(Exception) - Method in interface com.mathworks.mps.client.MWRequestStateVisitor
The request has completed with an error.

G

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.
getCreatedSeq() - Method in class com.mathworks.mps.client.rest.MATLABRequests
Returns lastModifiedSeq value on the server associated with the client from which the HTTP request was made.
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.
getHttpBody() - Method in class com.mathworks.mps.client.rest.HTTPErrorInfo
Returns the HTTP body for the failed request.
getHttpErrorCode() - Method in class com.mathworks.mps.client.rest.HTTPErrorInfo
Returns the HTTP error code for the failed request.
getHttpErrorMessage() - Method in class com.mathworks.mps.client.rest.HTTPErrorInfo
Returns the HTTP error message for the failed request.
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".
getInstanceId() - Method in class com.mathworks.mps.client.rest.MATLABRequestHandle
Returns the instance ID of the server.
getLastModifiedSeq() - Method in class com.mathworks.mps.client.rest.MATLABRequest
Returns the lastModifiedSeq value on the server when the HTTP request was made.
getLastModifiedSeq() - Method in class com.mathworks.mps.client.rest.MATLABRequestHandle
Returns the lastModifiedSeq value on the server when the HTTP request was made.
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
getMATLABRequests() - Method in class com.mathworks.mps.client.rest.MATLABRequests
Returns a map of all requests sent to the server from each client.
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.
getMwMarshalingRules() - Method in class com.mathworks.mps.client.rest.MATLABParams
Returns an object of type MWMarshalingRules.
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.
getNargout() - Method in class com.mathworks.mps.client.rest.MATLABParams
Returns the number of output arguments returned by the MATLAB function.
getRequestBody() - Method in class com.mathworks.mps.client.rest.MATLABParams
Constructs a byte array corresponding to the HTTP request body.
getRequestURL() - Method in class com.mathworks.mps.client.rest.MATLABRequestHandle
Returns the request URL associated with the request.
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
getResult() - Method in class com.mathworks.mps.client.rest.MATLABResult
Returns the result of the execution of a MATLAB function deployed on the MATLAB Production Server.
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.
getState() - Method in class com.mathworks.mps.client.rest.MATLABRequest
Returns the state of the request.
getState() - Method in class com.mathworks.mps.client.rest.MATLABRequestHandle
Returns the state of the request.
getState() - Method in enum com.mathworks.mps.client.rest.MATLABRequestState
 
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.
getTargetType() - Method in class com.mathworks.mps.client.rest.MATLABParams
Returns the expected target type.
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

H

hashCode() - Method in class com.mathworks.mps.client.MATLABStackFrame
Return hash value for an instance of MATLABStackFrame instance
HTTPErrorInfo - Class in com.mathworks.mps.client.rest
This class parses the error response body for the GET Result of Request request when the state of the request is ERROR_STATE.
HTTPErrorInfo() - Constructor for class com.mathworks.mps.client.rest.HTTPErrorInfo
 

I

inQueue(long, URL) - Method in interface com.mathworks.mps.client.MWRequestStateVisitor
The request is waiting to be processed (this is the initial state).
interrupted() - Method in interface com.mathworks.mps.client.MWRequestStateVisitor
The request is interrupted on the client side.
invoke(String, int, Class<T>, Object...) - Method in interface com.mathworks.mps.client.MWInvokable
Invokes a MATLAB function that returns multiple values.
invoke(String, Class<T>, Object...) - Method in interface com.mathworks.mps.client.MWInvokable
Invokes a MATLAB function that returns a single value.
invokeAsync(MWInvokeRequest<T>, MWRequestListener<T>) - Method in interface com.mathworks.mps.client.MWInvokable
Invokes a MATLAB function asynchronously with a callback attached.
invokeVoid(String, Object...) - Method in interface com.mathworks.mps.client.MWInvokable
Invokes a MATLAB function that does not return a value.
isCertificateRequired() - Method in interface com.mathworks.mps.client.MWSSLServerAuthorizer
Check to see if the client needs a server certificate
isCookieEnabled() - Method in interface com.mathworks.mps.client.MWHttpClientConfig
 
isCookieEnabled() - Method in class com.mathworks.mps.client.MWHttpClientDefaultConfig
 
isInterruptible() - Method in interface com.mathworks.mps.client.MWHttpClientConfig
Tells whether this instance of MWHttpClientConfig can be used for an interruptible MWHttpClient
isInterruptible() - Method in class com.mathworks.mps.client.MWHttpClientDefaultConfig
Returns the default interruptible value
isTerminal() - Method in interface com.mathworks.mps.client.MWRequestState
Returns true if this state is a terminal state.

L

loggerFactory - Static variable in class com.mathworks.mps.client.MWHttpClient
 

M

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.
MATLABParams - Class in com.mathworks.mps.client.rest
This class creates the payload for the initial HTTP POST request.
MATLABRequest - Class in com.mathworks.mps.client.rest
This class represents the HTTP response to the GET State Information request.
MATLABRequest(long, MATLABRequestState) - Constructor for class com.mathworks.mps.client.rest.MATLABRequest
 
MATLABRequestHandle - Class in com.mathworks.mps.client.rest
This class represents the MATLAB function execution request created with the initial POST Asynchronous Request.
MATLABRequestHandle() - Constructor for class com.mathworks.mps.client.rest.MATLABRequestHandle
 
MATLABRequests - Class in com.mathworks.mps.client.rest
This class represents the collection of requests owned by a certain client.
MATLABRequests() - Constructor for class com.mathworks.mps.client.rest.MATLABRequests
 
MATLABRequestState - Enum in com.mathworks.mps.client.rest
The state of an asynchronous MATLAB execution request.
MATLABResult<T> - Class in com.mathworks.mps.client.rest
This class represents the outcome of the execution of a MATLAB function deployed on MATLAB Production Server.
MATLABResult() - Constructor for class com.mathworks.mps.client.rest.MATLABResult
 
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.

N

newInstance(InputStream) - Static method in class com.mathworks.mps.client.rest.HTTPErrorInfo
Creates an HTTPErrorInfo object.
newInstance(byte[]) - Static method in class com.mathworks.mps.client.rest.HTTPErrorInfo
Creates an HTTPErrorInfo object.
newInstance(int, Class, MWMarshalingRules, Object...) - Static method in class com.mathworks.mps.client.rest.MATLABParams
Creates a MATLABParams object.
newInstance(int, Class, Object...) - Static method in class com.mathworks.mps.client.rest.MATLABParams
Creates a MATLABParams object.
newInstance(InputStream) - Static method in class com.mathworks.mps.client.rest.MATLABRequest
Creates an object of MATLABRequest class.
newInstance(byte[]) - Static method in class com.mathworks.mps.client.rest.MATLABRequest
Creates an object of MATLABRequest class.
newInstance(InputStream) - Static method in class com.mathworks.mps.client.rest.MATLABRequestHandle
Creates an object of MATLABRequestHandle class.
newInstance(byte[]) - Static method in class com.mathworks.mps.client.rest.MATLABRequestHandle
Creates an object of MATLABRequestHandle class.
newInstance(InputStream) - Static method in class com.mathworks.mps.client.rest.MATLABRequests
Creates a MATLABRequests object.
newInstance(byte[]) - Static method in class com.mathworks.mps.client.rest.MATLABRequests
Creates a MATLABRequests object.
newInstance(MATLABParams, InputStream) - Static method in class com.mathworks.mps.client.rest.MATLABResult
Creates a MATLABResult object after passing the required arguments.
newInstance(MATLABParams, byte[]) - Static method in class com.mathworks.mps.client.rest.MATLABResult
Creates a MATLABResult object after passing the required arguments.
notify(MWRequest<T>) - Method in interface com.mathworks.mps.client.MWRequestListener
Notify the listener that the state has changed.

P

printMATLABStackTrace() - Method in exception com.mathworks.mps.client.MATLABException
Print MATLABException's MATLAB stack trace to the standard error output stream that is the value of the field System.err
printMATLABStackTrace(PrintStream) - Method in exception com.mathworks.mps.client.MATLABException
Prints MATLABException's MATLAB back trace to the specified PrintStream.
printMATLABStackTrace(PrintWriter) - Method in exception com.mathworks.mps.client.MATLABException
Prints MATLABException's MATLAB back trace to the specified PrintWriter
processing(long, URL) - Method in interface com.mathworks.mps.client.MWRequestStateVisitor
The request is currently being processed.

R

ready(T) - Method in interface com.mathworks.mps.client.MWRequestStateVisitor
The request has completed with no errors; here is the result (this is a terminal state).
release() - Method in interface com.mathworks.mps.client.MWRequest
Release resources on the server

S

sending(byte[], URL) - Method in interface com.mathworks.mps.client.MWRequestStateVisitor
The request data is being sent.
setInputParams(Object...) - Method in class com.mathworks.mps.client.MWInvokeRequest
Sets the input parameters to the MATLAB function.
setNargout(int) - Method in class com.mathworks.mps.client.MWInvokeRequest
Sets number of output arguments expected from the MATLAB request.

T

toString() - Method in class com.mathworks.mps.client.MATLABStackFrame
Return string representation of an instance of MATLABStackFrame
toString() - Method in class com.mathworks.mps.client.rest.MATLABRequestHandle
 

V

valueOf(String) - Static method in enum com.mathworks.mps.client.rest.MATLABRequestState
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.mathworks.mps.client.rest.MATLABRequestState
Returns an array containing the constants of this enum type, in the order they are declared.
visit(MWRequestStateVisitor<T>) - Method in interface com.mathworks.mps.client.MWRequestState
Call the appropriate method of visitor, based on the current known state of this request.

W

writeTo(OutputStream) - Method in class com.mathworks.mps.client.rest.MATLABParams
Writes a byte array corresponding to the MatlabParams object to this output stream.
A C D E F G H I L M N P R S T V W 
Skip navigation links

Copyright 2010-2016 The MathWorks, Inc.