bindreceiver.java

Java写的smpp实现

/*
 * Java SMPP API
 * Copyright (C) 1998 - 2001 by Oran Kelly
 * 
 * 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.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 * 
 * A copy of the LGPL can be viewed at http://www.gnu.org/copyleft/lesser.html
 * Java SMPP API author: [e-mail]
 * Java SMPP API Homepage: http://smppapi.sourceforge.net/
 */
package ie.omk.smpp.message;

import java.io.*;
import ie.omk.smpp.SMPPException;
import ie.omk.smpp.BadCommandIDException;
import ie.omk.smpp.StringTooLongException;
import ie.omk.smpp.BadInterfaceVersionException;
import ie.omk.smpp.util.SMPPIO;
import ie.omk.debug.Debug;

/** Bind to the SMSC as receiver.
  * This message is used to bind to the SMSC as a Receiver ESME.
  * @author Oran Kelly
  * @version 1.0
  */
public class BindReceiver
    extends ie.omk.smpp.message.SMPPRequest
{
    /** System Id */
    private String sysId;

    /** Authentication password */
    private String password;

    /** System type */
    private String sysType;

    /** Address range for message routing */
    private String addressRange;

    /** Interface version */
    private int interfaceVer = 0x33;

    /** Address Type Of Number for message routing */
    private int addrTon;

    /** Address Numbering Plan Indicator for message routing */
    private int addrNpi;


    /** Constructs a new BindReceiver.
      */
    public BindReceiver()
    {
	super(ESME_BNDRCV);

	// Initialise the packets fields to null values
	sysId = password = sysType = addressRange = null;
	interfaceVer = addrTon = addrNpi = 0;
    }

    /** Constructs a new BindReceiver with specified sequence number.
      * @param seqNum The sequence number to be used by this packet
      * @deprecated
      */
    public BindReceiver(int seqNum)
    {
	super(ESME_BNDRCV, seqNum);

	// Initialise the packets fields to null values
	sysId = password = sysType = addressRange = null;
	interfaceVer = addrTon = addrNpi = 0;
    }


    /** Read a BindReceiver packet from an InputStream.  An entire packet
      * must exist in the stream, including the header information.
      * @param in The InputStream to read from
      * @exception java.io.IOException if there's a read error.
      */
    public BindReceiver(InputStream in)
	throws java.io.IOException, ie.omk.smpp.SMPPException
    {
	super(in);

	if (getCommandId() != SMPPPacket.ESME_BNDRCV)
	    throw new BadCommandIDException(SMPPPacket.ESME_BNDRCV,
		    getCommandId());

	if (getCommandStatus() != 0)
	    return;

	// First the system ID
	sysId = SMPPIO.readCString(in);

	// Get the password
	password = SMPPIO.readCString(in);

	// System type
	sysType = SMPPIO.readCString(in);

	// Interface version
	interfaceVer =  SMPPIO.readInt(in, 1);

	// Address TON
	addrTon =  SMPPIO.readInt(in, 1);

	// Address NPI
	addrNpi =  SMPPIO.readInt(in, 1);

	// Address range
	addressRange = SMPPIO.readCString(in);
    }

    /** Set the System Id for this Receiver.
      * @param sysId The new System Id (Up to 15 characters in length)
      * @exception ie.omk.smpp.StringTooLongException if the system id is too
      * long.
      */
    public void setSystemId(String sysId)
	throws ie.omk.smpp.SMPPException
    {
	if (sysId == null) {
	    this.sysId = null;
	    return;
	}

	if(sysId.length() < 16)
	    this.sysId = sysId;
	else
	    throw new StringTooLongException(16);
    }

    /** Set the password for this receiver.
      * @param password The new password to use (Up to 8 characters in length)
      * @exception ie.omk.smpp.StringTooLongException if the password is too
      * long.
      */
    public void setPassword(String password)
	throws ie.omk.smpp.SMPPException
    {
	if(password == null) {
	    this.password = null;
	    return;
	}

	if(password.length() < 9)
	    this.password = password;
	else
	    throw new StringTooLongException(8);
    }

    /** Set the system type for this receiver.
      * @param sysType The new system type (Up to 12 characters in length)
      * @exception ie.omk.smpp.StringTooLongException if the system type is too
      * long.
      */
    public void setSystemType(String sysType)
	throws ie.omk.smpp.SMPPException
    {
	if(sysType == null) {
	    this.sysType = null;
	    return;
	}

	if(sysType.length() < 13)
	    this.sysType = sysType;
	else
	    throw new StringTooLongException(12);
    }

    /** Set the interface version being used by this receiver.
      * @param interfaceVer The interface version to report to the SMSC
      * (major version number only)
      * @exception ie.omk.smpp.BadInterfaceVersionException if the interface
      * version is invalid.
      */ 
    public void setInterfaceVersion(int interfaceVer)
	throws ie.omk.smpp.SMPPException
    {
	if (interfaceVer != 0x33)
	    throw new BadInterfaceVersionException(interfaceVer);
	else
	    this.interfaceVer = interfaceVer;
    }

    /** Set the message routing Ton for this receiver
      * @param addrTon The new Type Of Number to use.
      * @exception ie.omk.smpp.InvalidTONException if the TON is invalid.
      */
    public void setAddressTon(int addrTon)
	throws ie.omk.smpp.SMPPException
    {
	// XXX check the TON value?
	this.addrTon = addrTon;
    }

    /** Set the message routing Npi for this receiver
      * @param addrNpi The new Numbering plan indicator to use
      * @exception ie.omk.smpp.InvalidNPIException if the NPI is invalid
      */
    public void setAddressNpi(int addrNpi)
	throws ie.omk.smpp.SMPPException
    {
	// XXX check the NPI?
	this.addrNpi = addrNpi;
    }

    /** Set the message routing address range for this receiver. The address
      * range can be either a number (for a single address) or a routing
      * expression. Routing expressions are specified using regular expressions.
      * See the SMPP specification for more details.
      * If the address range is blank (or null), the default address range for
      * this SystemId is used.
      * @param addressRange The new address range to use (Up to 40 characters)
      * @exception ie.omk.smpp.StringTooLongException if the address range is
      * too long.
      * @exception ie.omk.smpp.InvalidAddressRangeException if the address range
      * is invalid.
      */
    public void setAddressRange(String addressRange)
	throws ie.omk.smpp.SMPPException
    {
	if(addressRange == null) {
	    this.addressRange = null;
	    return;
	}

	if(addressRange.length() < 41)
	    this.addressRange = new String(addressRange);
	else
	    throw new StringTooLongException(40);
    }

    /** Get the system Id */
    public String getSystemId()
    {
	return (sysId);
    }

    /** Get the authentication password */
    public String getPassword()
    {
	return (password);
    }

    /** Get the current system type */
    public String getSystemType()
    {
	return (sysType);
    }

    /** Get the routing address regular expression */
    public String getAddressRange()
    {
	return (addressRange);
    }

    /** Get the Type of number */
    public int getAddressTon()
    {
	return (addrTon);
    }

    /** Get the Numbering plan indicator */
    public int getAddressNpi()
    {
	return (addrNpi);
    }

    /** Get the interface version */
    public int getInterfaceVersion()
    {
	return (interfaceVer);
    }


    /** Return the number of bytes this packet would be encoded as to an
      * OutputStream.
      * @return the number of bytes this packet would encode as.
      */
    public int getCommandLen()
    {
	int len = (getHeaderLen()
		+ ((sysId != null) ? sysId.length() : 0)
		+ ((password != null) ? password.length() : 0)
		+ ((sysType != null) ? sysType.length() : 0)
		+ ((addressRange != null) ? addressRange.length() : 0));

	// 3 1-byte integers, 4 c-strings.
	return (len + 3 + 4);
    }

    /** Write the byte representation of this packet to an OutputStream.
      * @param out The output stream to write to
      * @exception java.io.IOException If there is an error writing to the
      * stream.
      */
    protected void encodeBody(OutputStream out)
	throws java.io.IOException, ie.omk.smpp.SMPPException
    {
	SMPPIO.writeCString(sysId, out);
	SMPPIO.writeCString(password, out);
	SMPPIO.writeCString(sysType, out);
	SMPPIO.writeInt((int)interfaceVer, 1, out);
	SMPPIO.writeInt((int)addrTon, 1, out);
	SMPPIO.writeInt((int)addrNpi, 1, out);
	SMPPIO.writeCString(addressRange, out);
    }

    /** Convert this packet to a String. Not to be interpreted programmatically,
      * it's just dead handy for debugging!
      */
    public String toString()
    {
	return ("bind_receiver");
    }
}