|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.intel.bluetooth.obex.OBEXClientSessionImpl
public class OBEXClientSessionImpl
ClientSession implementation. See Bluetooth Specification Documents for details.
Your application should not use this class directly.
Field Summary | |
---|---|
protected Authenticator |
authenticator
|
protected long |
connectionID
|
protected boolean |
isConnected
|
protected int |
mtu
|
protected OBEXConnectionParams |
obexConnectionParams
|
protected com.intel.bluetooth.obex.OBEXClientOperation |
operation
|
protected int |
packetsCountRead
|
protected int |
packetsCountWrite
|
protected boolean |
requestSent
Each request packet flowed by response. |
Constructor Summary | |
---|---|
OBEXClientSessionImpl(StreamConnection conn,
OBEXConnectionParams obexConnectionParams)
Applications should not used this function. |
Method Summary | |
---|---|
protected void |
canStartOperation()
|
void |
close()
|
HeaderSet |
connect(HeaderSet headers)
Completes an OBEX CONNECT operation. |
HeaderSet |
createHeaderSet()
Creates a javax.obex.HeaderSet object. |
static HeaderSet |
createOBEXHeaderSet()
|
HeaderSet |
delete(HeaderSet headers)
Performs an OBEX DELETE operation. |
HeaderSet |
disconnect(HeaderSet headers)
Completes an OBEX DISCONNECT operation. |
boolean |
encrypt(long address,
boolean on)
|
Operation |
get(HeaderSet headers)
Performs an OBEX GET operation. |
BluetoothStack |
getBluetoothStack()
|
long |
getConnectionID()
Retrieves the connection ID that is being used in the present connection. |
long |
getRemoteAddress()
|
RemoteDevice |
getRemoteDevice()
|
int |
getSecurityOpt()
|
boolean |
isClosed()
|
void |
markAuthenticated()
|
Operation |
put(HeaderSet headers)
Performs an OBEX PUT operation. |
protected byte[] |
readPacket()
|
void |
setAuthenticator(Authenticator auth)
Sets the Authenticator to use with this connection. |
void |
setConnectionID(long id)
Sets the connection ID header to include in the request packets. |
HeaderSet |
setPath(HeaderSet headers,
boolean backup,
boolean create)
Completes an OBEX SETPATH operation. |
void |
setRemoteDevice(RemoteDevice remoteDevice)
|
void |
shutdown()
|
protected void |
writePacket(int commId,
com.intel.bluetooth.obex.OBEXHeaderSetImpl headers)
|
protected void |
writePacketWithFlags(int commId,
byte[] headerFlagsData,
com.intel.bluetooth.obex.OBEXHeaderSetImpl headers)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected com.intel.bluetooth.obex.OBEXClientOperation operation
protected boolean isConnected
protected long connectionID
protected int mtu
protected Authenticator authenticator
protected final OBEXConnectionParams obexConnectionParams
protected int packetsCountWrite
protected int packetsCountRead
protected boolean requestSent
Constructor Detail |
---|
public OBEXClientSessionImpl(StreamConnection conn, OBEXConnectionParams obexConnectionParams) throws IOException, Error
Error
- if called from outside of BlueCove internal code.
IOException
Method Detail |
---|
public HeaderSet createHeaderSet()
ClientSession
javax.obex.HeaderSet
object. This object can be
used to define header values in a request.
createHeaderSet
in interface ClientSession
javax.obex.HeaderSet
objectHeaderSet
public HeaderSet connect(HeaderSet headers) throws IOException
ClientSession
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
successful call to disconnect()
, this method must be
called before calling put()
, get()
,
setPath()
, delete()
, or
disconnect()
.
connect
in interface ClientSession
headers
- the headers to send in the CONNECT request
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
lengthpublic HeaderSet disconnect(HeaderSet headers) throws IOException
ClientSession
headers
argument is null
, no headers will be sent in the request.
This method will end the session. A new session may be started by calling
connect()
. This method will never return
null
.
disconnect
in interface ClientSession
headers
- the header to send in the DISCONNECT request
IOException
- if an error occurred in the transport layer; if the client
is already in an operation; if an OBEX connection does not
exist because connect()
has not been
called; if disconnect()
has been called and
received a response code of OBEX_HTTP_OK
after the last call to connect()
; if the
headers defined in headers
exceed the max
packet lengthpublic void setConnectionID(long id)
ClientSession
setConnectionID
in interface ClientSession
id
- the connection ID to usepublic long getConnectionID()
ClientSession
getConnectionID
in interface ClientSession
protected void canStartOperation() throws IOException
IOException
public HeaderSet setPath(HeaderSet headers, boolean backup, boolean create) throws IOException
ClientSession
null
.
setPath
in interface ClientSession
headers
- the headers to include in the SETPATH requestbackup
- if true
, instructs the server to back up one
directory before moving to the directory specified in name
(similar to cd .. on PCs); if false
, apply
name
to the current directorycreate
- if true
, instructs the server to create the
directory if it does not exist; if false
,
instruct the server to return an error code if the directory
does not exist
IOException
- if an error occurred in the transport layer; if the client
is already in an operation; if an OBEX connection does not
exist because connect()
has not been called;
if disconnect()
had been called and a
response code of OBEX_HTTP_OK
was received;
if the headers defined in headers
exceed the
max packet lengthpublic Operation get(HeaderSet headers) throws IOException
ClientSession
Operation
object to
continue with the operation. The headers argument may be null. This method will never return
null
.
get
in interface ClientSession
headers
- the OBEX headers to send as part of the initial GET request
IOException
- if an error occurred in the transport layer; if an OBEX
connection does not exist because connect()
has not been called; if disconnect()
had
been called and a response code of
OBEX_HTTP_OK
was received; if
connect()
has not been called; if the
client is already in an operation;Operation
public Operation put(HeaderSet headers) throws IOException
ClientSession
Operation
object to
continue with the PUT operation. The headers argument may be null. This method will never return
null
.
put
in interface ClientSession
headers
- the OBEX headers to send in the initial PUT request
IOException
- if an error occurred in the transport layer; if an OBEX
connection does not exist because connect()
has not been called; if disconnect()
had
been called and a response code of
OBEX_HTTP_OK
was received; if
connect()
has not been called; if the
client is already in an operation;Operation
public HeaderSet delete(HeaderSet headers) throws IOException
ClientSession
null
.
delete
in interface ClientSession
headers
- the header to send in the DELETE request
IOException
- if an error occurred in the transport layer; if the client
is already in an operation; if an OBEX connection does not
exist because connect()
has not been called;
if disconnect()
had been called and a
response code of OBEX_HTTP_OK
was received;
if the headers defined in headers
exceed the
max packet lengthpublic void setAuthenticator(Authenticator auth)
ClientSession
Authenticator
to use with this connection. The
Authenticator
allows an application to respond to
authentication challenge and authentication response headers. If no
Authenticator
is set, the response to an authentication
challenge or authentication response header is implementation dependent.
setAuthenticator
in interface ClientSession
auth
- the Authenticator
to use for this connectionpublic void close() throws IOException
close
in interface Connection
IOException
public static HeaderSet createOBEXHeaderSet()
protected void writePacket(int commId, com.intel.bluetooth.obex.OBEXHeaderSetImpl headers) throws IOException
IOException
protected void writePacketWithFlags(int commId, byte[] headerFlagsData, com.intel.bluetooth.obex.OBEXHeaderSetImpl headers) throws IOException
IOException
protected byte[] readPacket() throws IOException
IOException
public long getRemoteAddress() throws IOException
getRemoteAddress
in interface BluetoothConnectionAccess
IOException
public RemoteDevice getRemoteDevice()
getRemoteDevice
in interface BluetoothConnectionAccess
public boolean isClosed()
isClosed
in interface BluetoothConnectionAccess
public void shutdown() throws IOException
shutdown
in interface BluetoothConnectionAccess
IOException
public void markAuthenticated()
markAuthenticated
in interface BluetoothConnectionAccess
public int getSecurityOpt()
getSecurityOpt
in interface BluetoothConnectionAccess
public boolean encrypt(long address, boolean on) throws IOException
encrypt
in interface BluetoothConnectionAccess
IOException
RemoteDevice.encrypt(javax.microedition.io.Connection ,
boolean)
public void setRemoteDevice(RemoteDevice remoteDevice)
setRemoteDevice
in interface BluetoothConnectionAccess
public BluetoothStack getBluetoothStack()
getBluetoothStack
in interface BluetoothConnectionAccess
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |