当前位置：文档库 › Appendix2

Appendix2

Class Summary

Interfaces

Authenticator This interface provides a way to respond to authentication challenge and authentica-

tion response headers.

ClientSession The ClientSession interface provides methods for OBEX requests.

HeaderSet The HeaderSet interface defines the methods that set and get the values of OBEX

headers.

Operation The Operation interface provides ways to manipulate a single OBEX PUT or GET

operation.

SessionNotifier The SessionNotifier interface defines a connection notifier for server-side

OBEX connections.

Classes

This class holds user name and password combinations.

PasswordAuthentica-

tion

ResponseCodes The ResponseCodes class contains the list of valid response codes a server may

send to a client.

ServerRequestHandler The ServerRequestHandler class defines an event listener that will respond to

OBEX requests made to the server.

javax.obex

Authenticator

Declaration

public interface Authenticator

Description

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 onAuthenticationChallenge() or onAuthenticationResponse() will be called, respectively, by the implementation.

For more information on how the authentication procedure works in OBEX, please review the IrOBEX specification at https://www.wendangku.net/doc/04952840.html,.

Authentication Challenges

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

onAuthenticationChallenge() method will be invoked by the OBEX API implementation. The application will then return the user name (if needed) and password via a PasswordAuthentication 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 onAuthenticationChallenge() 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.

Authentication Responses

When a client or server receives an authentication response header, the onAuthenticationResponse() method is invoked by the API implementation with the user name received in the authentication response header. (The user name will be null 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 onAuthenticationResponse() method. If the authentication request should fail without the implementation checking the password, null should be returned by the application. (This is needed for reasons like not recognizing the user name, etc.) If the returned value is not null, the OBEX API implementation will combine the password returned from the onAuthenticationResponse() 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 IOException will be thrown if the client requested authentication. If the server requested authentication, the

onAuthenticationFailure() method will be called on the ServerRequestHandler that failed authentication. The connection is not closed if authentication failed.

Member Summary

Methods

public PasswordAu-

thentication onAuthenticationChallenge(String,boolean,boolean) Called when a client or a server receives an authentication challenge header.

public byte onAuthenticationResponse(byte[])

Called when a client or server receives an authentication response header.

Methods

onAuthenticationChallenge(String, boolean, boolean)

public PasswordAuthentication onAuthenticationChallenge(https://www.wendangku.net/doc/04952840.html,ng.String description, boolean isUserIdRequired,boolean isFullAccess)

Called when a client or a server receives an authentication challenge header. It should respond to the chal-lenge with a PasswordAuthentication that contains the correct user name and password for the challenge.

Parameters:

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

isUserIdRequired - true if the user ID is required; false if the user ID is not required

isFullAccess - true if full access to the server will be granted; false if read only access will be granted

Returns:a PasswordAuthentication object containing the user name and password used for authentication

onAuthenticationResponse(byte[])

public byte[]onAuthenticationResponse(byte[]userName)

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.

Parameters:

userName - the user name provided in the authentication response; may be null

Returns:the correct password for the user name provided; if null is returned then the authentication request failed

javax.obex

ClientSession

Declaration

public interface ClientSession extends javax.microedition.io.Connection

All Superinterfaces:javax.microedition.io.Connection

Description

The ClientSession interface provides methods for OBEX requests. This interface provides a way to define headers for any OBEX operation. OBEX operations are CONNECT, SETPATH, PUT, GET and DISCONNECT. For PUTs and GETs, this interface will return a javax.obex.Operation object to complete the operations. For CONNECT, DISCONNECT, and SETPATH operations, this interface will complete the operation and return the result in a HeaderSet object.

Connection ID and Target Headers

According to the IrOBEX specification, a packet may not contain a Connection ID and Target header. Since the Connection ID header is managed by the implementation, it will not send a Connection ID header if a Connection ID was specified in a packet that has a Target header. In other words, if an application adds a Target header to a HeaderSet object used in an OBEX operation and a Connection ID was specified, no Connection ID will be sent in the packet containing the Target header.

CREATE-EMPTY and PUT-DELETE Requests

To perform a CREATE-EMPTY request, the client must call the put() method. With the Operation object returned, the client must open the output stream by calling openOutputStream() and then close the stream by calling close() on the OutputStream without writing any data. Using the DataOutputStream returned from openDataOutputStream() works the same way.

There are two ways to perform a PUT-DELETE request. The delete() method is one way to perform a PUT-DELETE request. The second way to perform a PUT-DELETE request is by calling put() and never calling openOutputStream() or openDataOutputStream() on the Operation object returned from

put().

PUT example

void putObjectViaOBEX(ClientSession conn,HeaderSet head,byte[]obj)

throws IOException{

//Include the length header

head.setHeader(HeaderSet.LENGTH,new Long(obj.length));

//Initiate the PUT request

Operation op=conn.put(head);

//Open the output stream to put the object to it

OutputStream out=op.openOutputStream();

//Send the object to the server

out.write(obj);

//End the transaction

out.close();

op.close();

}

GET example

byte[]getObjectViaOBEX(ClientSession conn,HeaderSet head)throws IOException{ //Send the initial GET request to the server

Operation op=conn.get(head);

//Get the object from the input stream

InputStream in=op.openInputStream();

ByteArrayOutputStream out=new ByteArrayOutputStream();

int data=in.read();

while(data!=-1){

out.write((byte)data);

data=in.read();

}

//End the transaction

in.close();

op.close();

byte[]obj=out.toByteArray();

out.close();

return obj;

}

Member Summary

Methods

public HeaderSet connect(HeaderSet)

Completes an OBEX CONNECT operation.

public HeaderSet createHeaderSet()

Creates a javax.obex.HeaderSet object.

public HeaderSet delete(HeaderSet)

Performs an OBEX DELETE operation.

public HeaderSet disconnect(HeaderSet)

Completes an OBEX DISCONNECT operation.

public Operation get(HeaderSet)

Performs an OBEX GET operation.

public long getConnectionID()

Retrieves the connection ID that is being used in the present connection.

public Operation put(HeaderSet)

Performs an OBEX PUT operation.

public void setAuthenticator(Authenticator)

Sets the Authenticator to use with this connection.

public void setConnectionID(long)

Sets the connection ID header to include in the request packets.

public HeaderSet setPath(HeaderSet,boolean,boolean)

Completes an OBEX SETPATH operation.

Inherited Member Summary

Methods inherited from interface javax.microedition.io.Connection

Inherited Member Summary

Methods

connect(HeaderSet)

public HeaderSet connect(HeaderSet headers)

throws IOException

Completes an OBEX CONNECT operation. If the headers argument is null, no headers will be sent in the request. This method will never return null.

This method must be called and a successful response code of OBEX_HTTP_OK must be received before put(), get(), setPath(), delete(), or disconnect() may be called. Similarly, after a success-ful call to disconnect(), this method must be called before calling put(), get(), setPath(), delete(), or disconnect().

Parameters:

headers - the headers to send in the CONNECT request

Returns:the headers that were returned from the server

Throws:

IOException - if an error occurred in the transport layer; if the client is already in an operation; if this method had already been called with a successful response code of OBEX_HTTP_OK and calls to disconnect() have not returned a response code of OBEX_HTTP_OK; if the headers defined in

headers exceed the max packet length

IllegalArgumentException - if headers was not created by a call to

createHeaderSet()

public HeaderSet createHeaderSet()

Creates a javax.obex.HeaderSet object. This object can be used to define header values in a request.

Returns:a new javax.obex.HeaderSet object