public interface Operation
Operation
interface provides ways to manipulate a single
OBEX PUT or GET operation. The implementation of this interface sends OBEX
packets as they are built. If during the operation the peer in the operation
ends the operation, an IOException
is thrown on the next read
from the input stream, write to the output stream, or call to
sendHeaders()
.
Definition of methods inherited from ContentConnection
getEncoding()
will always return null
.
getLength()
will return the length specified by the OBEX Length
header or -1 if the OBEX Length header was not included.
getType()
will return the value specified in the OBEX Type
header or null
if the OBEX Type header was not included.
How Headers are Handled
As headers are received, they may be retrieved through the
getReceivedHeaders()
method. If new headers are set during the
operation, the new headers will be sent during the next packet exchange.
PUT example
void putObjectViaOBEX(ClientSession conn, HeaderSet head, byte[] obj) throws IOException { // Include the length header head.setHeader(head.LENGTH, new Long(obj.length)); // Initiate the PUT request Operation op = conn.put(head); // Open the output stream to put the object to it DataOutputStream out = op.openDataOutputStream(); // 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); // Retrieve the length of the object being sent back int length = op.getLength(); // Create space for the object byte[] obj = new byte[length]; // Get the object from the input stream DataInputStream in = trans.openDataInputStream(); in.read(obj); // End the transaction in.close(); op.close(); return obj; }
close()
the OutputStream
returned from
openOutputStream()
or openDataOutputStream()
will
signal that the request is done. (In OBEX terms, the End-Of-Body header
should be sent and the final bit in the request will be set.) At this point,
the reply from the server may begin to be processed. A call to
getResponseCode()
will do an implicit close on the
OutputStream
and therefore signal that the request is done.
openInputStream()
or openDataInputStream()
will
signal that the request is done. (In OBEX terms, the final bit in the request
will be set.) A call to getResponseCode()
will cause an implicit
close on the InputStream
. No further data may be read at this
point.Modifier and Type | Method and Description |
---|---|
void |
abort()
Sends an ABORT message to the server.
|
void |
close() |
String |
getEncoding() |
int |
getHeaderLength() |
long |
getLength() |
int |
getMaxPacketSize() |
HeaderSet |
getReceivedHeader()
Returns the headers that have been received during the operation.
|
int |
getResponseCode()
Returns the response code received from the server.
|
String |
getType() |
void |
noBodyHeader() |
DataInputStream |
openDataInputStream() |
DataOutputStream |
openDataOutputStream() |
InputStream |
openInputStream() |
OutputStream |
openOutputStream() |
void |
sendHeaders(HeaderSet headers)
Specifies the headers that should be sent in the next OBEX message that
is sent.
|
void abort() throws IOException
close()
will be called by this method.IOException
- if the transaction has already ended or if an OBEX
server calls this methodHeaderSet getReceivedHeader() throws IOException
Operation
IOException
- if this Operation
has been closedvoid sendHeaders(HeaderSet headers) throws IOException
headers
- the headers to send in the next messageIOException
- if this Operation
has been closed or the
transaction has ended and no further messages will be exchangedIllegalArgumentException
- if headers
was not created
by a call to ServerRequestHandler.createHeaderSet()
or ClientSession.createHeaderSet()
NullPointerException
- if headers
if null
int getResponseCode() throws IOException
ResponseCodes
class.IOException
- if an error occurred in the transport layer during
the transaction; if this object was created by an OBEX serverResponseCodes
String getEncoding()
long getLength()
int getHeaderLength()
String getType()
InputStream openInputStream() throws IOException
IOException
DataInputStream openDataInputStream() throws IOException
IOException
OutputStream openOutputStream() throws IOException
IOException
DataOutputStream openDataOutputStream() throws IOException
IOException
void close() throws IOException
IOException
int getMaxPacketSize()
void noBodyHeader()