Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 9439a7fe authored by Nick Pelly's avatar Nick Pelly
Browse files

Add javax.obex library, contributed by Motorola. 

Based of a JSR-82 reference implementation.

This check-in is 'as-is' from the source provided June 25.

This code does not conform to Android style and quality guidelines. I will be
working with Motorola to improve it. If it does not see substantial improvement
in the Eclair timeframe it will be deleted.
parent 3ccd3655

obex/javax/obex/ApplicationParameter.java

0 → 100644
+135 −0
Original line number Diff line number Diff line 
/*

 * Copyright (c) 2008-2009, Motorola, Inc.

 *

 * 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 the Motorola, Inc. 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.

 */



package javax.obex;



public class ApplicationParameter {

    private int max_length_ini = 1000;



    private byte[] b_array;



    private int length;



    public static class TRIPLET_TAGID {

        public static final byte ORDER_TAGID = 0x01;



        public static final byte SEARCH_VALUE_TAGID = 0x02;



        public static final byte SEARCH_ATTRIBUTE_TAGID = 0x03;



        public static final byte MAXLISTCOUNT_TAGID = 0x04;//if equals to "0", PSE only reply number of contacts



        public static final byte LISTSTARTOFFSET_TAGID = 0x05;



        public static final byte FILTER_TAGID = 0x06;



        public static final byte FORMAT_TAGID = 0x07;



        public static final byte PHONEBOOKSIZE_TAGID = 0x08;//only used if max list count = 0



        public static final byte NEWMISSEDCALLS_TAGID = 0x09;//only used in "mch" in response

    }



    public static class TRIPLET_VALUE {

        public static class ORDER {

            public static final byte ORDER_BY_INDEX = 0x00;



            public static final byte ORDER_BY_ALPHANUMERIC = 0x01;



            public static final byte ORDER_BY_PHONETIC = 0x02;

        }



        public static class SEARCHATTRIBUTE {

            public static final byte SEARCH_BY_NAME = 0x00;



            public static final byte SEARCH_BY_NUMBER = 0x01;



            public static final byte SEARCH_BY_SOUND = 0x02;

        }



        public static class FORMAT {

            public static final byte VCARD_VERSION_21 = 0x00;



            public static final byte VCARD_VERSION_30 = 0x01;

        }

    }



    public static class TRIPLET_LENGTH {

        public static final byte ORDER_LENGTH = 1;



        //public final byte SEARCH_VALUE_LENGTH = 0x02;

        public static final byte SEARCH_ATTRIBUTE_LENGTH = 1;



        public static final byte MAXLISTCOUNT_LENGTH = 2;



        public static final byte LISTSTARTOFFSET_LENGTH = 2;



        public static final byte FILTER_LENGTH = 8;



        public static final byte FORMAT_LENGTH = 1;



        public static final byte PHONEBOOKSIZE_LENGTH = 2;



        public static final byte NEWMISSEDCALLS_LENGTH = 1;

    }



    /*

    public class TRIPLET_STRUCTURE{

        TRIPLET_TAGID id;

        TRIPLET_LENGTH length;

        byte[] value;

    }

    */

    public ApplicationParameter() {

        b_array = new byte[max_length_ini];

        length = 0;

    }



    public void addAPPHeader(byte tag, byte len, byte[] value) {

        if ((length + len + 2) > max_length_ini) {

            byte[] array_tmp = new byte[length + 4 * len];

            System.arraycopy(b_array, 0, array_tmp, 0, length);

            b_array = array_tmp;

            max_length_ini = length + 4 * len;

        }

        b_array[length++] = tag;

        b_array[length++] = len;

        System.arraycopy(value, 0, b_array, length, len);

        length += len;

    }



    public byte[] getAPPparam() {

        byte[] para = new byte[length];

        System.arraycopy(b_array, 0, para, 0, length);

        return para;

    }

}

obex/javax/obex/Authenticator.java

0 → 100644
+124 −0
Original line number Diff line number Diff line 
/*

 * Copyright (c) 2008-2009, Motorola, Inc.

 *

 * 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 the Motorola, Inc. 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.

 */



package javax.obex;



/**

 * This interface provides a way to respond to authentication challenge and

 * authentication response headers.  When a client or server receives an

 * authentication challenge or authentication response header, the

 * <code>onAuthenticationChallenge()</code> or

 * <code>onAuthenticationResponse()</code> will be called, respectively, by

 * the implementation.

 * <P>

 * For more information on how the authentication procedure works in OBEX,

 * please review the IrOBEX specification at

 * <A HREF="http://www.irda.org">http://www.irda.org</A>.

 * <P>

 * <STRONG>Authentication Challenges</STRONG>

 * <P>

 * When a client or server receives an authentication challenge header, the

 * <code>onAuthenticationChallenge()</code> method will be invoked by the

 * OBEX API implementation.  The application will then return the user name

 * (if needed) and password via a <code>PasswordAuthentication</code> object.

 * The password in this object is not sent in the authentication response.

 * Instead, the 16-byte challenge received in the authentication challenge is

 * combined with the password returned from the

 * <code>onAuthenticationChallenge()</code> method and passed through the MD5

 * hash algorithm.  The resulting value is sent in the authentication response

 * along with the user name if it was provided.

 * <P>

 * <STRONG>Authentication Responses</STRONG>

 * <P>

 * When a client or server receives an authentication response header, the

 * <code>onAuthenticationResponse()</code> method is invoked by the API

 * implementation with the user name received in the authentication response

 * header.  (The user name will be <code>null</code> if no user name was

 * provided in the authentication response header.)  The application must

 * determine the correct password.  This value should be returned from the

 * <code>onAuthenticationResponse()</code> method.  If the authentication

 * request should fail without the implementation checking the password,

 * <code>null</code> should

 * be returned by the application.  (This is needed for reasons like not

 * recognizing the user name, etc.)  If the returned value is not

 * <code>null</code>, the OBEX API implementation will combine the password

 * returned from the <code>onAuthenticationResponse()</code> method and

 * challenge sent via the authentication challenge, apply the MD5 hash

 * algorithm, and compare the result to the response hash received in the

 * authentication response header.  If the values are not equal, an

 * <code>IOException</code> will be thrown if the client requested authentication.

 * If the server requested authentication, the

 * <code>onAuthenticationFailure()</code> method will be called on the

 * <code>ServerRequestHandler</code> that failed authentication.  The

 * connection is <B>not</B> closed if authentication failed.

 *

 * @version 0.3 November 28, 2008

 */

public interface Authenticator {



    /**

     * Called when a client or a server receives an authentication challenge

     * header. It should respond to the challenge with a

     * <code>PasswordAuthentication</code> that contains the correct user name

     * and password for the challenge.

     *

     * @param description the description of which user name and password

     * should be used; if no description is provided in the authentication

     * challenge or the description is encoded in an encoding scheme that is

     * not supported, an empty string will be provided

     *

     * @param isUserIdRequired <code>true</code> if the user ID is required;

     * <code>false</code> if the user ID is not required

     *

     * @param isFullAccess <code>true</code> if full access to the server

     * will be granted; <code>false</code> if read only access will be

     * granted

     *

     * @return a <code>PasswordAuthentication</code> object containing the

     * user name and password used for authentication

     */

    public PasswordAuthentication onAuthenticationChallenge(String description,

            boolean isUserIdRequired, boolean isFullAccess);



    /**

     * Called when a client or server receives an authentication response

     * header.  This method will provide the user name and expect the correct

     * password to be returned.

     *

     * @param userName the user name provided in the authentication response;

     * may be <code>null</code>

     *

     * @return the correct password for the user name provided; if

     * <code>null</code> is returned then the authentication request failed

     */

    public byte[] onAuthenticationResponse(byte[] userName);

}

obex/javax/obex/BaseStream.java

0 → 100644
+83 −0
Original line number Diff line number Diff line 
/*

 * Copyright (c) 2008-2009, Motorola, Inc.

 *

 * 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 the Motorola, Inc. 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.

 */



package javax.obex;



import java.io.*;



/**

 * This interface defines the methods needed by a parent that uses the

 * PrivateInputStream and PrivateOutputStream objects defined in this package.

 *

 * @version 0.3 November 28, 2008

 */

public interface BaseStream {



    /**

     * Verifies that this object is still open.

     *

     * @exception IOException if the object is closed

     */

    public void ensureOpen() throws IOException;



    /**

     * Verifies that additional information may be sent.  In other words, the

     * operation is not done.

     *

     * @exception IOException if the operation is completed

     */

    public void ensureNotDone() throws IOException;



    /**

     * Continues the operation since there is no data to read.

     *

     * @param sendEmpty <code>true</code> if the operation should send an

     * empty packet or not send anything if there is no data to send

     * @param inStream  <code>true</code> if the stream is input stream or

     * is output stream

     * @return <code>true</code> if the operation was completed;

     * <code>false</code> if no operation took place

     *

     * @exception IOException if an IO error occurs

     */

    public boolean continueOperation(boolean sendEmpty, boolean inStream) throws IOException;



    /**

     * Called when the output or input stream is closed.

     *

     * @param inStream <code>true</code> if the input stream is closed;

     * <code>false</code> if the output stream is closed

     *

     * @exception IOException if an IO error occurs

     */

    public void streamClosed(boolean inStream) throws IOException;

}

obex/javax/obex/ClientOperation.java

0 → 100644
+840 −0

File added.

Preview size limit exceeded, changes collapsed.

obex/javax/obex/ClientSession.java

0 → 100644
+783 −0

File added.

Preview size limit exceeded, changes collapsed.