Protocol.java

/*
 *
 *
 * Copyright  1990-2009 Sun Microsystems, Inc. All Rights Reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License version
 * 2 only, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License version 2 for more details (a copy is
 * included at /legal/license.txt).
 *
 * You should have received a copy of the GNU General Public License
 * version 2 along with this work; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA
 *
 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
 * Clara, CA 95054 or visit www.sun.com if you need additional
 * information or have any questions.
 */

package com.sun.jsr082.obex.btgoep;

import java.io.IOException;
import javax.microedition.io.Connection;
import javax.microedition.io.StreamConnectionNotifier;
import javax.microedition.io.StreamConnection;
import com.sun.j2me.security.BluetoothPermission;
import com.sun.jsr082.bluetooth.BluetoothUrl;
import com.sun.jsr082.bluetooth.BluetoothProtocol;
import com.sun.jsr082.obex.ClientSessionImpl;
import com.sun.jsr082.obex.SessionNotifierImpl;
import com.sun.jsr082.obex.btgoep.BTGOEPConnection;
import com.sun.jsr082.obex.btgoep.BTGOEPNotifier;

/*
 * Provides a wrapper for "btgoep" protocol implementation
 * to answer the GCF style.
 */
public class Protocol extends BluetoothProtocol {
    /* Privileged security token used to access to btspp scheme. */
//    private static SecurityToken internalSecurityToken;

    /* Originally requested url saved to reused in btspp transport. */
    String name = null;

    /*
     * Constructs an instance.
     */
    public Protocol() {
        super(BluetoothUrl.OBEX);
    }

    /*
     * Cheks permissions and opens requested connection.
     * Returns either ClientSession or SessionNotifier for OBEX connections,
     * depending whether client or server URL was specified. Actually all
     * essential logic is implemented in the superclass, this one only saves
     * resource name to reuse it for opening btspp transport.
     *
     * @param token security token of the calling class
     * @param name the URL for the connection without protocol.
     * @param mode obex supports READ_WRITE mode only.
     * @param timeouts ignored (because it is allowed by spec).
     * @return ClientSession for client url or SessionNotifier for server url.
     * @exception IOException if opening connection fails.
     */
    public Connection openPrim(String name, int mode,
            boolean timeouts) throws IOException {
        this.name = name;
        return super.openPrim(name, mode, timeouts);
    }

    /*
     * Ensures URL parameters have valid value. Makes nothing actually
     * for all the required checks will be done durin ntspp transport
     * creation.
     * @param url URL to check
     */
    protected void checkUrl(BluetoothUrl url) {}

    /*
     * Creates ClientSession connection over the rfcomm transport layer
     * @param token security token of the calling class
     * @param mode       I/O access mode
     * @return ClientSession connection instance
     * @exception IOException if openning connection fails.
     */
    protected Connection clientConnection(int mode)
                throws IOException {
        checkForPermission(BluetoothPermission.OBEX_CLIENT);

        StreamConnection sock = (StreamConnection)
            new com.sun.jsr082.bluetooth.btspp.Protocol(BluetoothUrl.OBEX).
            openPrim(name, mode, false);
        return new ClientSessionImpl(newBTGOEPConnection(sock, 
                "btgoep://" + name));
    }

    /*
     * Creates new btgoep connection.
     * @param sock stream
     * @param url URL of connection
     * @return btgoep connection instance
     * @exception IOException if creating connection fails.
     */
    protected BTGOEPConnection newBTGOEPConnection(StreamConnection sock,
            String url) throws IOException {
        return new BTGOEPConnection(sock);
    }

    /*
     * Creates server connection over the rfcomm transport layer
     * @param token security token of the calling class
     * @param mode       I/O access mode
     * @return server connection instance
     * @exception IOException if openning connection fails.
     */
    protected Connection serverConnection(int mode)
                throws IOException {
        checkForPermission(BluetoothPermission.OBEX_SERVER);

        StreamConnectionNotifier sock = (StreamConnectionNotifier)
            new com.sun.jsr082.bluetooth.btspp.Protocol(BluetoothUrl.OBEX).
            openPrim(name, mode, false);
        return new SessionNotifierImpl(newBTGOEPNotifier(sock,
                "btgoep://" + name));
    }

    /*
     * Creates new btgoep server connection.
     * @param sock stream
     * @param url URL of connection
     * @return btgoep connection instance
     * @exception IOException if creating connection fails.
     */
    protected BTGOEPNotifier newBTGOEPNotifier(StreamConnectionNotifier sock,
            String url) throws IOException {
        return new BTGOEPNotifier(sock);
    }

    /*
     * Retrieves privileged token if there is no defined one.
     * @param token security token on hands or <code>null</code>
     *        if there is no one
     * @return privileged security token that allow acces to btspp if
     *     given token is <code>null</code>, the token given otherwise.
     */
/*
    private static SecurityToken getBtsppToken(SecurityToken token) {
        return (token == null) ? internalSecurityToken : token;
    }
*/
}