gnu.io.rfc2217.SignatureCommand Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of nrjavaserial Show documentation
Show all versions of nrjavaserial Show documentation
A fork of the RXTX library with a focus on ease of use and embeddability in other libraries.
/*-------------------------------------------------------------------------
| RXTX License v 2.1 - LGPL v 2.1 + Linking Over Controlled Interface.
| Copyright 2010 by Archie L. Cobbs and others.
|
| A copy of the LGPL v 2.1 may be found at
| http://www.gnu.org/licenses/lgpl.txt on March 4th 2007. A copy is
| here for your convenience.
|
| This library is free software; you can redistribute it and/or
| modify it under the terms of the GNU Lesser General Public
| License as published by the Free Software Foundation; either
| version 2.1 of the License, or (at your option) any later version.
|
| This library 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
| Lesser General Public License for more details.
|
| An executable that contains no derivative of any portion of RXTX, but
| is designed to work with RXTX by being dynamically linked with it,
| is considered a "work that uses the Library" subject to the terms and
| conditions of the GNU Lesser General Public License.
|
| The following has been added to the RXTX License to remove
| any confusion about linking to RXTX. We want to allow in part what
| section 5, paragraph 2 of the LGPL does not permit in the special
| case of linking over a controlled interface. The intent is to add a
| Java Specification Request or standards body defined interface in the
| future as another exception but one is not currently available.
|
| http://www.fsf.org/licenses/gpl-faq.html#LinkingOverControlledInterface
|
| As a special exception, the copyright holders of RXTX give you
| permission to link RXTX with independent modules that communicate with
| RXTX solely through the Sun Microsytems CommAPI interface version 2,
| regardless of the license terms of these independent modules, and to copy
| and distribute the resulting combined work under terms of your choice,
| provided that every copy of the combined work is accompanied by a complete
| copy of the source code of RXTX (the version of RXTX used to produce the
| combined work), being distributed under the terms of the GNU Lesser General
| Public License plus this exception. An independent module is a
| module which is not derived from or based on RXTX.
|
| Note that people who make modified versions of RXTX are not obligated
| to grant this special exception for their modified versions; it is
| their choice whether to do so. The GNU Lesser General Public License
| gives permission to release a modified version without this exception; this
| exception also makes it possible to release a modified version which
| carries forward this exception.
|
| You should have received a copy of the GNU Lesser General Public
| License along with this library; if not, write to the Free
| Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
| All trademarks belong to their respective owners.
--------------------------------------------------------------------------*/
package gnu.io.rfc2217;
import java.io.UnsupportedEncodingException;
import static gnu.io.rfc2217.RFC2217.COM_PORT_OPTION;
import static gnu.io.rfc2217.RFC2217.SERVER_OFFSET;
import static gnu.io.rfc2217.RFC2217.SIGNATURE;
/**
* RFC 2217 {@code SIGNATURE} command.
*
* @see RFC 2217
*/
public class SignatureCommand extends ComPortCommand {
public static final String ENCODING = "ISO-8859-1";
private final String signature;
private boolean decodeFailed;
/**
* Decoding constructor.
*
* @param bytes encoded option starting with the {@code COM-PORT-OPTION} byte
* NullPointerException if {@code bytes} is null
* IllegalArgumentException if {@code bytes} has length that is too short or too long
* IllegalArgumentException if {@code bytes[0]} is not {@link RFC2217#COM_PORT_OPTION}
* IllegalArgumentException if {@code bytes[1]} is not {@link RFC2217#SIGNATURE} (client or server)
*/
public SignatureCommand(int[] bytes) {
super("SIGNATURE", SIGNATURE, bytes);
String sig;
boolean failed = false;
try {
sig = new String(this.getPayload(), ENCODING);
} catch (UnsupportedEncodingException e) {
sig = "(string decode failed)";
failed = true;
}
this.signature = sig;
this.decodeFailed = failed;
}
/**
* Encoding constructor.
*
* @param signature signature string
* @param client true for the client-to-server command, false for the server-to-client command
*/
public SignatureCommand(boolean client, String signature) {
this(encode(client, signature));
}
/**
* Encoding constructor for signature requests.
*
* @param client true for the client command, false for the server command
*/
public SignatureCommand(boolean client) {
this(encode(client, ""));
}
@Override
public String toString() {
return this.getName() + " " + (this.signature.length() > 0 ? "\"" + this.signature + "\"" : "REQUEST");
}
@Override
public void visit(ComPortCommandSwitch sw) {
sw.caseSignature(this);
}
public String getSignature() {
return this.signature;
}
public boolean decodeFailed() {
return this.decodeFailed;
}
@Override
int getMinPayloadLength() {
return 0;
}
@Override
int getMaxPayloadLength() {
return Integer.MAX_VALUE - 2;
}
private static int[] encode(boolean client, String signature) {
byte[] buf;
try {
buf = signature.getBytes(ENCODING);
} catch (UnsupportedEncodingException e) {
buf = new byte[] { (byte)'?' };
}
int[] ibuf = new int[2 + buf.length];
ibuf[0] = COM_PORT_OPTION;
ibuf[1] = client ? SIGNATURE : SIGNATURE + SERVER_OFFSET;
for (int i = 0; i < buf.length; i++)
ibuf[2 + i] = buf[i] & 0xff;
return ibuf;
}
}