org.n52.matlab.control.MatlabSessionImpl Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of matlab-control Show documentation
MATLAB Control
The newest version!
package org.n52.matlab.control;

/*
 * Copyright (c) 2013, Joshua Kaplan
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
 * following conditions are met:
 *  - Redistributions of source code must retain the above copyright notice, this list of conditions and the following
 *    disclaimer.
 *  - Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
 *    following disclaimer in the documentation and/or other materials provided with the distribution.
 *  - Neither the name of matlabcontrol nor the names of its contributors may be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

import java.rmi.registry.Registry;
import java.util.UUID;

/**
 * Implementation of {@link MatlabSession}. Split into interface and implementation to work properly with RMI.
 * 
 * @since 4.0.0
 * 
 * @author Joshua Kaplan
 */
class MatlabSessionImpl implements MatlabSession
{   
    /**
     * The prefix for all RMI names of bound instances of {@link MatlabSession}.
     */
    private static final String MATLAB_SESSION_PREFIX = "MATLAB_SESSION_";
    
    /**
     * The bound name in the RMI registry for this instance.
     */
    private final String SESSION_ID = MATLAB_SESSION_PREFIX + UUID.randomUUID().toString();

    @Override
    public synchronized boolean connectFromRMI(String receiverID, int port)
    {
        boolean success = false;
        if(MatlabConnector.isAvailableForConnection())
        {
            MatlabConnector.connect(receiverID, port, true);
            success = true;
        }
        
        return success;
    }
    
    /**
     * The unique identifier for this session.
     * 
     * @return 
     */
    String getSessionID()
    {
        return SESSION_ID;
    }
    
    /**
     * Attempts to connect to a running instance of MATLAB. Returns {@code true} if a connection was made,
     * {@code false} otherwise.
     * 
     * @param receiverID
     * @param port
     * @return if connection was made
     */
    static boolean connectToRunningSession(String receiverID, int port)
    {
        boolean establishedConnection = false;
        
        try
        {
            Registry registry = LocalHostRMIHelper.getRegistry(port);
            
            String[] remoteNames = registry.list();
            for(String name : remoteNames)
            {
                if(name.startsWith(MATLAB_SESSION_PREFIX))
                {
                    MatlabSession session = (MatlabSession) registry.lookup(name);
                    if(session.connectFromRMI(receiverID, port))
                    {
                        establishedConnection = true;
                        break;
                    }
                }
            }
        }
        catch(Exception e) { }
        
        return establishedConnection;
    }
}