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, ParentStreamProvider, SecureConnection, SocketConnection, StreamConnection

public class SSL30Connection
extends Object
implements SecureConnection, ParentStreamProvider

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

Fields inherited from interface javax.microedition.io.SocketConnection
DELAY, KEEPALIVE, LINGER, RCVBUF, SNDBUF
 
Constructor Summary
 Category: Signed 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.
 Category: Signed SSL30Connection(StreamConnection subConnection, String name, boolean startHandshake)
          Creates an instance of the SSL protocol passing in an underlying stream connection and the address you are connecting to.
 
Method Summary
 Category: Signed  void close()
          Close the connection.
 Category: Signed  String getAddress()
          Gets the remote address to which the socket is bound.
 Category: Signed  String getLocalAddress()
          Gets the local address to which the socket is bound.
 Category: Signed  int getLocalPort()
          Returns the local port to which this socket is bound.
 Category: Signed  StreamConnection getParentStream()
          Returns the parent stream if it is available.
 Category: Signed  int getPort()
          Returns the remote port to which this socket is bound.
 Category: Signed  SecurityInfo getSecurityInfo()
          Return the security information associated with this connection.
 Category: Signed  int getSocketOption(byte option)
          Get a socket option for the connection.
 Category: Signed  DataInputStream openDataInputStream()
          Returns a data input stream to use for retrieving data from the TLS stream.
 Category: Signed  DataOutputStream openDataOutputStream()
          Returns a data output stream for writing data to the stream securely using TLS.
 Category: Signed  InputStream openInputStream()
          Returns the input stream where one would read information from when it is being sent through the protocol.
 Category: Signed  OutputStream openOutputStream()
          Sends information across to the other side of the connection (server) using TLS.
 Category: Signed  void setSocketOption(byte option, int value)
          Set a socket option for the connection.
 
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. By default, this is MIDP 2.0 compliant in that the handshake is completed immediately.

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.

SSL30Connection

public SSL30Connection(StreamConnection subConnection,
                       String name,
                       boolean startHandshake)
                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.
startHandshake - If this boolean is true, then the handshake will be completed before this function is finished. If it is false, then the handshake is completed when required.
Throws:
IOException - Thrown if an I/O error occurs.
TLSException - Thrown if a TLS error occurs.
Since:
JDE 4.0.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.

Returns:
The InputStream.
Throws:
IOException - Thrown if an I/O error occurs or if the connection is already closed.
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.

Returns:
The DataInputStream.
Throws:
IOException - Thrown if an I/O error occurs or if the connection is already closed.
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.

Returns:
The OutputStream.
Throws:
IOException - Thrown if an I/O error occurs or if the connection is already closed.
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.

Returns:
The DataOutputStream.
Throws:
IOException - Thrown if an I/O error occurs or if the connection is already closed.
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.

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.

getSecurityInfo

public SecurityInfo getSecurityInfo()
                             throws IOException
Return the security information associated with this connection. If the connection is still in Setup state then the connection is initiated to establish the secure connection to the server. The method returns when the connection is established and the Certificate supplied by the server has been validated. The SecurityInfo is only returned if the connection has been successfully made to the server.
Returns:
the security information associated with this open connection.
Throws:
IOException - Thrown if an I/O error occurs or if the connection is already closed.
Since:
JDE 4.0.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.

setSocketOption

public void setSocketOption(byte option,
                            int value)
                     throws IllegalArgumentException,
                            IOException
Set a socket option for the connection.

Options inform the low level networking code about intended usage patterns that the application will use in dealing with the socket connection.

Calling setSocketOption to assign buffer sizes is a hint to the platform of the sizes to set the underlying network I/O buffers. Calling getSocketOption can be used to see what sizes the system is using. The system MAY adjust the buffer sizes to account for better throughput available from Maximum Transmission Unit (MTU) and Maximum Segment Size (MSS) data available from current network information.

Parameters:
option - socket option identifier (KEEPALIVE, LINGER, SNDBUF, RCVBUF, or DELAY)
value - numeric value for specified option
Throws:
IllegalArgumentException - if the value is not valid (e.g. negative value) or if the option identifier is not valid
IOException - if the connection was closed
Since:
JDE 4.0.2
See Also:
getSocketOption(byte)
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.

getSocketOption

public int getSocketOption(byte option)
                    throws IllegalArgumentException,
                           IOException
Get a socket option for the connection.
Parameters:
option - socket option identifier (KEEPALIVE, LINGER, SNDBUF, RCVBUF, or DELAY)
Returns:
numeric value for specified option or -1 if the value is not available.
Throws:
IllegalArgumentException - if the option identifier is not valid
IOException - if the connection was closed
Since:
JDE 4.0.2
See Also:
setSocketOption(byte, int)
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.

getLocalAddress

public String getLocalAddress()
                       throws IOException
Gets the local address to which the socket is bound.

The host address(IP number) that can be used to connect to this end of the socket connection from an external system. Since IP addresses may be dynamically assigned, a remote application will need to be robust in the face of IP number reasssignment.

The local hostname (if available) can be accessed from System.getProperty("microedition.hostname")

Returns:
the local address to which the socket is bound.
Throws:
IOException - if the connection was closed.
Since:
JDE 4.0.0
See Also:
ServerSocketConnection
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.

getLocalPort

public int getLocalPort()
                 throws IOException
Returns the local port to which this socket is bound.
Returns:
the local port number to which this socket is connected.
Throws:
IOException - if the connection was closed.
Since:
JDE 4.0.0
See Also:
ServerSocketConnection
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.

getAddress

public String getAddress()
                  throws IOException
Gets the remote address to which the socket is bound. The address can be either the remote host name or the IP address(if available).
Returns:
the remote address to which the socket is bound.
Throws:
IOException - if the connection was closed.
Since:
JDE 4.0.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.

getPort

public int getPort()
            throws IOException
Returns the remote port to which this socket is bound.
Returns:
the remote port number to which this socket is connected.
Throws:
IOException - if the connection was closed.
Since:
JDE 4.0.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.

getParentStream

public StreamConnection getParentStream()
Returns the parent stream if it is available.
Returns:
the parent stream this connection was created with.
Since:
JDE 4.0.2
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.


Copyright 1999-2004 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.