/*
* Copyright (c) 2005, 2006, 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.*;
/** {@collect.stats}
* The TerminalFactorySpi class defines the service provider interface.
* Applications do not access this class directly, instead see
* {@linkplain TerminalFactory}.
*
* <P>Service providers that want to write a new implementation should define
* a concrete subclass of TerminalFactorySpi with a constructor that takes
* an <code>Object</code> as parameter. That class needs to be registered
* in a {@linkplain java.security.Provider}. The engine
* {@linkplain java.security.Provider.Service#getType type} is
* <code>TerminalFactory</code>.
* Service providers also need to implement subclasses of the abstract classes
* {@linkplain CardTerminals}, {@linkplain CardTerminal}, {@linkplain Card},
* and {@linkplain CardChannel}.
*
* <p>For example:
* <pre><em>file MyProvider.java:</em>
*
* package com.somedomain.card;
*
* import java.security.Provider;
*
* public class MyProvider extends Provider {
* public MyProvider() {
* super("MyProvider", 1.0d, "Smart Card Example");
* put("TerminalFactory.MyType", "com.somedomain.card.MySpi");
* }
* }
*
*<em>file MySpi.java</em>
*
* package com.somedomain.card;
*
* import javax.smartcardio.*;
*
* public class MySpi extends TerminalFactoySpi {
* public MySpi(Object parameter) {
* // initialize as appropriate
* }
* protected CardTerminals engineTerminals() {
* // add implementation code here
* }
* }
* </pre>
*
* @see TerminalFactory
* @see java.security.Provider
*
* @since 1.6
* @author Andreas Sterbenz
* @author JSR 268 Expert Group
*/
public abstract class TerminalFactorySpi {
/** {@collect.stats}
* Constructs a new TerminalFactorySpi object.
*
* <p>This class is part of the service provider interface and not accessed
* directly by applications. Applications
* should use TerminalFactory objects, which can be obtained by calling
* one of the
* {@linkplain TerminalFactory#getInstance TerminalFactory.getInstance()}
* methods.
*
* <p>Concrete subclasses should define a constructor that takes an
* <code>Object</code> as parameter. It will be invoked when an
* application calls one of the {@linkplain TerminalFactory#getInstance
* TerminalFactory.getInstance()} methods and receives the <code>params</code>
* object specified by the application.
*/
protected TerminalFactorySpi() {
// empty
}
/** {@collect.stats}
* Returns the CardTerminals created by this factory.
*
* @return the CardTerminals created by this factory.
*/
protected abstract CardTerminals engineTerminals();
}