Package uicc.connection

Interface BIPLink

All Superinterfaces:
Observable
public interface BIPLink extends Observable
The BIPLink interface represents a pure BIP logical connection to a remote entity. Objects implementing BIPLink interface and returned by the ConnectionServer.getConnection method are Permanent Entry Point Objects.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    close()
    Closes the BIP link.
    short
    open()
    It request the opening of the BIP link.
    boolean
    send(byte[] baData, short sOffset, short sLength)
    Sends data on the BIP link without any additional on-card reliable level.

  • Method Details

    • open

      short open() throws ConnectionException
      It request the opening of the BIP link.
      Returns:
      the size of the allocated PDU buffer or 0 if the proactive command was not successful.
      Throws:
      ConnectionException - with the following reason code:
      • TOOLKIT_RESOURCE_NOT_AVAILABLE if the proactive command could not be issued.
      • INVALID_STATE if the BIP link is already opened.
      • USER_CANCELLATION if the user cancelled the opening of the BIP link.
      • UNSUPPORTED_OPERATION if the Terminal Equipment does not support the required mechanisms to perform the action.
      • RESOURCE_NOT_AVAILABLE if there are not sufficient resources available (on the UICC or on the terminal).

    • close

      boolean close() throws ConnectionException
      Closes the BIP link.
      Returns:
      true if the proactive command has been successfully executed by the Terminal Equipment false otherwise.
      Throws:
      ConnectionException - with the following reason code:
      • TOOLKIT_RESOURCE_NOT_AVAILABLE if the proactive command could not be issued.
      • USER_CANCELLATION if the user cancelled the closing of the BIP link

    • send

      boolean send(byte[] baData, short sOffset, short sLength) throws ArrayIndexOutOfBoundsException, ConnectionException, NullPointerException
      Sends data on the BIP link without any additional on-card reliable level.

      Note: The applet execution is resumed once the data has been sent.

      Parameters:
      baData - byte array containing the data to be sent
      sOffset - the starting offset of the data to be sent in the baData byte array
      sLength - the length of the data to be sent
      Returns:
      true if the proactive command has been successfully executed by the Terminal Equipment; false otherwise.
      Throws:
      ArrayIndexOutOfBoundsException - if sOffset and sLength are causing access outside of baData array bounds
      ConnectionException - with the following reason code:
      • TOOLKIT_RESOURCE_NOT_AVAILABLE if the proactive command could not be issued.
      • INVALID_STATE if the BIP link is not opened.
      • USER_CANCELLATION if the user cancelled the connecting of the BIP link
      NullPointerException - if baData is equal to null