org.eclipse.keyple.calypso.command.po.AbstractPoCommandBuilder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of keyple-java-calypso Show documentation

Keyple Calypso

There is a newer version: 1.0.0

/* **************************************************************************************
 * Copyright (c) 2018 Calypso Networks Association https://www.calypsonet-asso.org/
 *
 * See the NOTICE file(s) distributed with this work for additional information
 * regarding copyright ownership.
 *
 * This program and the accompanying materials are made available under the terms of the
 * Eclipse Public License 2.0 which is available at http://www.eclipse.org/legal/epl-2.0
 *
 * SPDX-License-Identifier: EPL-2.0
 ************************************************************************************** */
package org.eclipse.keyple.calypso.command.po;

import org.eclipse.keyple.core.card.command.AbstractApduResponseParser;
import org.eclipse.keyple.core.card.command.AbstractIso7816CommandBuilder;
import org.eclipse.keyple.core.card.message.ApduRequest;
import org.eclipse.keyple.core.card.message.ApduResponse;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/** Abstract class for all PO command builders. */
public abstract class AbstractPoCommandBuilder
    extends AbstractIso7816CommandBuilder {

  /** common logger for all builders */
  protected static Logger logger = LoggerFactory.getLogger(AbstractPoCommandBuilder.class);

  /**
   * Constructor dedicated for the building of referenced Calypso commands
   *
   * @param commandRef a command reference from the Calypso command table
   * @param request the ApduRequest (the instruction byte will be overwritten)
   */
  public AbstractPoCommandBuilder(CalypsoPoCommand commandRef, ApduRequest request) {
    super(commandRef, request);
  }

  /**
   * Create the response parser matching the builder
   *
   * @param apduResponse the response data from the the card
   * @return an {@link AbstractApduResponseParser}
   */
  public abstract T createResponseParser(ApduResponse apduResponse);

  /** {@inheritDoc} */
  @Override
  public CalypsoPoCommand getCommandRef() {
    return (CalypsoPoCommand) commandRef;
  }

  /**
   * Indicates if the session buffer is used when executing this command.
   *
   * Allows the management of the overflow of this buffer.
   *
   * @return true if this command uses the session buffer
   */
  public abstract boolean isSessionBufferUsed();
}