src/java.smartcardio/share/classes/javax/smartcardio/package-info.java
author valeriep
Wed, 13 Mar 2019 02:48:09 +0000
changeset 54089 fc84d7c22132
parent 52991 9e28eff3d40f
permissions -rw-r--r--
8220258: fix headings in java.smartcardio Summary: Replace h3 with h2 Reviewed-by: ascarpino
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
52991
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
     1
/*
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
     2
 *  Copyright (c) 2005, 2018, Oracle and/or its affiliates. All rights reserved.
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
     3
 *  DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
     4
 *
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
     5
 *  This code is free software; you can redistribute it and/or modify it
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
     6
 *  under the terms of the GNU General Public License version 2 only, as
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
     7
 *  published by the Free Software Foundation.  Oracle designates this
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
     8
 *  particular file as subject to the "Classpath" exception as provided
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
     9
 *  by Oracle in the LICENSE file that accompanied this code.
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    10
 *
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    11
 *  This code is distributed in the hope that it will be useful, but WITHOUT
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    12
 *  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    13
 *  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    14
 *  version 2 for more details (a copy is included in the LICENSE file that
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    15
 *  accompanied this code).
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    16
 *
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    17
 *  You should have received a copy of the GNU General Public License version
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    18
 *  2 along with this work; if not, write to the Free Software Foundation,
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    19
 *  Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    20
 *
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    21
 *  Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    22
 *  or visit www.oracle.com if you need additional information or have any
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    23
 *  questions.
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    24
 */
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
52991
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    26
/**
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    27
 * Java™ Smart Card I/O API.
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    28
 *
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    29
 * This specification describes the Java Smart Card I/O API defined by
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    30
 * <a href="http://jcp.org/en/jsr/detail?id=268">JSR 268</a>.
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    31
 *
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    32
 * It defines a Java API for communication with Smart Cards
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    33
 * using ISO/IEC 7816-4 APDUs. It thereby allows Java applications to interact with
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    34
 * applications running on the Smart Card, to store and retrieve data
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    35
 * on the card, etc.
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    36
 *
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    37
 * <p>
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    38
 * The API is defined by classes in the package
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    39
 * <code>javax.smartcardio</code>. They can be classified as follows:
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    40
 *
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    41
 * <dl>
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    42
 * <dt>Classes describing the corresponding Smart Card structures
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    43
 * <dd>
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    44
 * <a href="ATR.html">ATR</a>,
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    45
 * <a href="CommandAPDU.html">CommandAPDU</a>,
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    46
 * <a href="ResponseAPDU.html">ResponseAPDU</a>
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    47
 *
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    48
 * <dt>Factory to obtain implementations
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    49
 * <dd>
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    50
 * <a href="TerminalFactory.html">TerminalFactory</a>
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    51
 *
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    52
 * <dt>Main classes for card and terminal functions
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    53
 * <dd>
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    54
 * <a href="CardTerminals.html">CardTerminals</a>,
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    55
 * <a href="CardTerminal.html">CardTerminal</a>,
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    56
 * <a href="Card.html">Card</a>,
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    57
 * <a href="CardChannel.html">CardChannel</a>
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    58
 *
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    59
 * <dt>Supporting permission and exception classes
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    60
 * <dd>
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    61
 * <a href="CardPermission.html">CardPermission</a>,
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    62
 * <a href="CardException.html">CardException</a>,
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    63
 * <a href="CardNotPresentException.html">CardNotPresentException</a>
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    64
 *
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    65
 * <dt>Service provider interface, not accessed directly by applications
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    66
 * <dd>
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    67
 * <a href="TerminalFactorySpi.html">TerminalFactorySpi</a>
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    68
 *
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    69
 * </dl>
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    70
 *
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    71
 *
54089
fc84d7c22132 8220258: fix headings in java.smartcardio
valeriep
parents: 52991
diff changeset
    72
 * <h2>API Example</h2>
52991
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    73
 *
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    74
 * A simple example of using the API is:
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    75
 * <pre>
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    76
 *      // show the list of available terminals
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    77
 *      TerminalFactory factory = TerminalFactory.getDefault();
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    78
 *      List&lt;CardTerminal&gt; terminals = factory.terminals().list();
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    79
 *      System.out.println("Terminals: " + terminals);
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    80
 *      // get the first terminal
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    81
 *      CardTerminal terminal = terminals.get(0);
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    82
 *      // establish a connection with the card
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    83
 *      Card card = terminal.connect("T=0");
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    84
 *      System.out.println("card: " + card);
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    85
 *      CardChannel channel = card.getBasicChannel();
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    86
 *      ResponseAPDU r = channel.transmit(new CommandAPDU(c1));
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    87
 *      System.out.println("response: " + toString(r.getBytes()));
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    88
 *      // disconnect
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    89
 *      card.disconnect(false);
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    90
 * </pre>
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    91
 *
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    92
 * @since   1.6
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    93
 * @author  Andreas Sterbenz
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    94
 * @author  JSR 268 Expert Group
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    95
 */
9e28eff3d40f 8215309: Convert package.html files to package-info.java files
rriggs
parents: 47216
diff changeset
    96
package javax.smartcardio;