src/org/simalliance/openmobileapi/service/IChannel.java

/*
 * Copyright (C) 2011, The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
/*
 * Contributed by: Giesecke & Devrient GmbH.
 */

package org.simalliance.openmobileapi.service;


import org.simalliance.openmobileapi.service.security.ChannelAccess;

import org.simalliance.openmobileapi.service.ISmartcardServiceCallback;

/**
 * Smartcard service interface for channel resources.
 */
public interface IChannel {

    /**
     * Closes this channel.
     *
     * @throws CardException if closing the channel failed.
     */
    void close() throws CardException;

    /**
     * Returns the channel number according to ISO 7816-4.
     *
     * @return the channel number according to ISO 7816-4.
     */
    int getChannelNumber();

    /**
     * Returns if this channel is a basic channel
     *
     * @return true if this channel is a basic channel
     */
    boolean isBasicChannel();

    /**
     * Returns the associated terminal.
     *
     * @return the associated terminal.
     */
    ITerminal getTerminal();

    /**
     * Transmits the specified command APDU and returns the response APDU.
     * MANAGE channel commands are not allowed. Applet selection commands are
     * not allowed if this is a logical channel.
     *
     * @param command the command APDU to be transmitted.
     * @return the response APDU.
     * @throws CardException if command transmission failed or the command is
     *             not allowed.
     */
    byte[] transmit(byte[] command) throws CardException;


    /**
     * @param channelAccess
     */
    void setChannelAccess(ChannelAccess channelAccess);

    /**
     * @return channelAccess
     */
    ChannelAccess getChannelAccess();

    /**
     * Sets calling pid for validation in checkCommand.
     * @param pid calling pid of the device application
     */
    void setCallingPid( int pid );


    /**
     * @return
     */
    ISmartcardServiceCallback getCallback();

    /**
     * true if aid during open xxx channel coud be selected.
     * false if aid could not be or was not selected.
     * @return
     */
    boolean hasSelectedAid();

    /**
     * set selected aid flag and aid (may be null)
     */
    void hasSelectedAid(boolean has, byte[] aid);

    /**
     * Returns the data as received from the application select command inclusively the status word.
     * The returned byte array contains the data bytes in the following order:
     * [<first data byte>, ..., <last data byte>, <sw1>, <sw2>]
     * @return The data as returned by the application select command inclusively the status word.
     * @return Only the status word if the application select command has no returned data.
     * @return null if an application select command has not been performed or the selection response can not
     * be retrieved by the reader implementation.
     */
    public byte[] getSelectResponse();
}