Static Proxy Interface Guidelines

When you write Java^® interfaces to invoke MATLAB^® code, remember these considerations:

For a complete example, see Create MATLAB Production Server Java Client Using MWHttpClient Class.

Java Client Prerequisites

Complete the following steps to prepare your MATLAB Production Server™ Java development environment.

Manage Client Lifecycle

A single Java client connects to one or more servers available at various URLs. Even though you create multiple instances of MWHttpClient, one instance is capable of establishing connections with multiple servers.

Proxy objects communicate with the server until the close method of that instance is invoked.

For a locally scoped instance of MWHttpClient, the Java client code looks like the following:

 Locally Scoped Instance

MWClient client = new MWHttpClient();
try{
    // Code that uses client to communicate with the server
}finally{
    client.close();
}

When using a locally scoped instance of MWHttpClient, tie it to a servlet.

When using a servlet, initialize the MWHttpClient inside the HttpServlet.init() method, and close it inside the HttpServlet.destroy() method, as in the following code:

 Servlet Implementation

public class MPSServlet extends HttpServlet
{
  private final MWClient client;

  public void init(ServletConfig config) throws ServletException
  {
    client = new MWHttpClient();
  }
    
  protected void doGet(HttpServletRequest req,HttpServletResponse resp)
  throws ServletException,java.io.IOException
  {
    // Code that uses client to communicate with the server    
  }
   
  public void destroy()
  {
    client.close();
  }
}

Handling Java Client Exceptions

The Java interface must declare checked exceptions for the following errors:

Managing System Resources

A single Java client connects to one or more servers available at different URLs. Instances of MWHttpClient can communicate with multiple servers.

All proxy objects, created by an instance of MWHttpClient, communicate with the server until the close method of MWHttpClient is invoked.

Call close only if you no longer need to communicate with the server and you are ready to release the system resources. Closing the client terminates connections to all created proxies.

Where to Find the Javadoc

The API doc for the Java client is installed in $MPS_INSTALL/client.

Logging

You can record details such as HTTP request statuses, server URLs, and output data in your Java client application using the logging capability available in the MATLAB Production Server Java client library. To offer logging options, the Java client library, mps_client.jar, packages the SLF4J API module (version 1.7.25) as part of the client library. You can use any SLF4J-supported logging framework such as Log4j, Logback, or the java.util.logging package. Without a binding, SLF4J defaults to a no-operation implementation. For details about using a binding, see the Bridging Legacy APIs documentation on the SLF4J website.

When using a logging framework or a different version of SLF4J, you must add it in front of the mps_client.jar on the Java class path.

If you use the java.util.logging package for logging, you must load and use the java.util.logging.Logger class in your Java application code before you load the com.mathworks.mps.client.MWHttpClient class. For more information about java.util.logging, see the Oracle^® Package java.util.logging Javadoc.