SHOW Signed

net.rim.device.api.crypto.tls.ssl30
Class SSL30Connection

java.lang.Object
  |
  +--net.rim.device.api.crypto.tls.ssl30.SSL30Connection

All Implemented Interfaces:

Connection, InputConnection, OutputConnection, StreamConnection

public class SSL30Connection

extends Object

implements StreamConnection

This class can be used to instantiate a SSL3.0 connection directly given an underlying connection (such as TCP) or it can be instantiated using Connector.open and specifying ssl as the protocol to use.

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

Since:

JDE 3.6.0

Constructor Summary

SSL30Connection(StreamConnection subConnection, String name) Creates an instance of the SSL protocol passing in an underlying stream connection and the address you are connecting to.

Method Summary

	void	close() Close the connection.
	DataInputStream	openDataInputStream() Returns a data input stream to use for retrieving data from the TLS stream.
	DataOutputStream	openDataOutputStream() Returns a data output stream for writing data to the stream securely using TLS.
	InputStream	openInputStream() Returns the input stream where one would read information from when it is being sent through the protocol.
	OutputStream	openOutputStream() Sends information across to the other side of the connection (server) using TLS.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SSL30Connection

public SSL30Connection(StreamConnection subConnection,
                       String name)
                throws IOException,
                       TLSException

Creates an instance of the SSL protocol passing in an underlying stream connection and the address you are connecting to.

This creates the protocol and calls connect which will establish the connection with the server using SSL. To use the connection call the getInputStream and getOutputStream methods.

Parameters:

subConnection - An ordered stream connection such as a TCP connection which will provide the underlying transport for this protocol.

name - The address of both the server and the port that were passed into the subConnection constructor.

Throws:

IOException - Thrown if an I/O error occurs.

TLSException - Thrown if a TLS error occurs.

Since:

JDE 3.6.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

Method Detail

openInputStream

public InputStream openInputStream()
                            throws IOException

Returns the input stream where one would read information from when it is being sent through the protocol.

Specified by:

openInputStream in interface InputConnection

Returns:

The InputStream.

Throws:

IOException - Thrown if an I/O error occurs.

Since:

JDE 3.6.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

openDataInputStream

public DataInputStream openDataInputStream()
                                    throws IOException

Returns a data input stream to use for retrieving data from the TLS stream.

Specified by:

openDataInputStream in interface InputConnection

Returns:

The DataInputStream.

Throws:

IOException - Thrown if an I/O error occurs.

Since:

JDE 3.6.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

openOutputStream

public OutputStream openOutputStream()
                              throws IOException

Sends information across to the other side of the connection (server) using TLS.

Specified by:

openOutputStream in interface OutputConnection

Returns:

The OutputStream.

Throws:

IOException - Thrown if an I/O error occurs.

Since:

JDE 3.6.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

openDataOutputStream

public DataOutputStream openDataOutputStream()
                                      throws IOException

Returns a data output stream for writing data to the stream securely using TLS.

Specified by:

openDataOutputStream in interface OutputConnection

Returns:

The DataOutputStream.

Throws:

IOException - Thrown if an I/O error occurs.

Since:

JDE 3.6.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

close

public void close()
           throws IOException

Close the connection.

When the connection has been closed access to all methods except this one will cause an an IOException to be thrown.

Closing an already closed connection has no effect. Streams derived from the connection may be open when method is called. Any open streams will cause the connection to be held open until they themselves are closed.

Specified by:

close in interface Connection

Throws:

IOException - Thrown if an I/O error occurs.

Since:

JDE 3.6.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.