135 lines
5.0 KiB
Java
135 lines
5.0 KiB
Java
/*
|
|
* Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved.
|
|
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
|
*
|
|
* This code is free software; you can redistribute it and/or modify it
|
|
* under the terms of the GNU General Public License version 2 only, as
|
|
* published by the Free Software Foundation. Oracle designates this
|
|
* particular file as subject to the "Classpath" exception as provided
|
|
* by Oracle in the LICENSE file that accompanied this code.
|
|
*
|
|
* This code is distributed in the hope that it will be useful, but WITHOUT
|
|
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
* version 2 for more details (a copy is included in the LICENSE file that
|
|
* accompanied this code).
|
|
*
|
|
* You should have received a copy of the GNU General Public License version
|
|
* 2 along with this work; if not, write to the Free Software Foundation,
|
|
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
*
|
|
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
|
|
* or visit www.oracle.com if you need additional information or have any
|
|
* questions.
|
|
*/
|
|
|
|
package javax.smartcardio;
|
|
|
|
import java.util.*;
|
|
|
|
/**
|
|
* A Smart Card terminal, sometimes referred to as a Smart Card Reader.
|
|
* A CardTerminal object can be obtained by calling
|
|
* {@linkplain CardTerminals#list}
|
|
* or {@linkplain CardTerminals#getTerminal CardTerminals.getTerminal()}.
|
|
*
|
|
* <p>Note that physical card readers with slots for multiple cards are
|
|
* represented by one <code>CardTerminal</code> object per such slot.
|
|
*
|
|
* @see CardTerminals
|
|
* @see TerminalFactory
|
|
*
|
|
* @since 1.6
|
|
* @author Andreas Sterbenz
|
|
* @author JSR 268 Expert Group
|
|
*/
|
|
public abstract class CardTerminal {
|
|
|
|
/**
|
|
* Constructs a new CardTerminal object.
|
|
*
|
|
* <p>This constructor is called by subclasses only. Application should
|
|
* call {@linkplain CardTerminals#list list()}
|
|
* or {@linkplain CardTerminals#getTerminal getTerminal()}
|
|
* to obtain a CardTerminal object.
|
|
*/
|
|
protected CardTerminal() {
|
|
// empty
|
|
}
|
|
|
|
/**
|
|
* Returns the unique name of this terminal.
|
|
*
|
|
* @return the unique name of this terminal.
|
|
*/
|
|
public abstract String getName();
|
|
|
|
/**
|
|
* Establishes a connection to the card.
|
|
* If a connection has previously established using
|
|
* the specified protocol, this method returns the same Card object as
|
|
* the previous call.
|
|
*
|
|
* @param protocol the protocol to use ("T=0", "T=1", or "T=CL"), or "*" to
|
|
* connect using any available protocol.
|
|
*
|
|
* @throws NullPointerException if protocol is null
|
|
* @throws IllegalArgumentException if protocol is an invalid protocol
|
|
* specification
|
|
* @throws CardNotPresentException if no card is present in this terminal
|
|
* @throws CardException if a connection could not be established
|
|
* using the specified protocol or if a connection has previously been
|
|
* established using a different protocol
|
|
* @throws SecurityException if a SecurityManager exists and the
|
|
* caller does not have the required
|
|
* {@linkplain CardPermission permission}
|
|
*/
|
|
public abstract Card connect(String protocol) throws CardException;
|
|
|
|
/**
|
|
* Returns whether a card is present in this terminal.
|
|
*
|
|
* @return whether a card is present in this terminal.
|
|
*
|
|
* @throws CardException if the status could not be determined
|
|
*/
|
|
public abstract boolean isCardPresent() throws CardException;
|
|
|
|
/**
|
|
* Waits until a card is present in this terminal or the timeout
|
|
* expires. If the method returns due to an expired timeout, it returns
|
|
* false. Otherwise it return true.
|
|
*
|
|
* <P>If a card is present in this terminal when this
|
|
* method is called, it returns immediately.
|
|
*
|
|
* @param timeout if positive, block for up to <code>timeout</code>
|
|
* milliseconds; if zero, block indefinitely; must not be negative
|
|
* @return false if the method returns due to an expired timeout,
|
|
* true otherwise.
|
|
*
|
|
* @throws IllegalArgumentException if timeout is negative
|
|
* @throws CardException if the operation failed
|
|
*/
|
|
public abstract boolean waitForCardPresent(long timeout) throws CardException;
|
|
|
|
/**
|
|
* Waits until a card is absent in this terminal or the timeout
|
|
* expires. If the method returns due to an expired timeout, it returns
|
|
* false. Otherwise it return true.
|
|
*
|
|
* <P>If no card is present in this terminal when this
|
|
* method is called, it returns immediately.
|
|
*
|
|
* @param timeout if positive, block for up to <code>timeout</code>
|
|
* milliseconds; if zero, block indefinitely; must not be negative
|
|
* @return false if the method returns due to an expired timeout,
|
|
* true otherwise.
|
|
*
|
|
* @throws IllegalArgumentException if timeout is negative
|
|
* @throws CardException if the operation failed
|
|
*/
|
|
public abstract boolean waitForCardAbsent(long timeout) throws CardException;
|
|
|
|
}
|