/protocols/smpp/src/main/java/org/mobicents/protocols/smpp/message/ParamRetrieveResp.java

  1/*
  2 * JBoss, Home of Professional Open Source
  3 * Copyright 2011, Red Hat, Inc. and individual contributors
  4 * by the @authors tag. See the copyright.txt in the distribution for a
  5 * full listing of individual contributors.
  6 *
  7 * This is free software; you can redistribute it and/or modify it
  8 * under the terms of the GNU Lesser General Public License as
  9 * published by the Free Software Foundation; either version 2.1 of
 10 * the License, or (at your option) any later version.
 11 *
 12 * This software is distributed in the hope that it will be useful,
 13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 15 * Lesser General Public License for more details.
 16 *
 17 * You should have received a copy of the GNU Lesser General Public
 18 * License along with this software; if not, write to the Free
 19 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 20 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 21 */
 22
 23package org.mobicents.protocols.smpp.message;
 24
 25import java.io.IOException;
 26
 27import org.mobicents.protocols.smpp.util.PacketDecoder;
 28import org.mobicents.protocols.smpp.util.PacketEncoder;
 29import org.mobicents.protocols.smpp.version.SMPPVersion;
 30
 31/**
 32 * SMSC response to a ParamRetrieve request. Returns the value of the requested
 33 * parameter.
 34 * 
 35 * @version $Id: ParamRetrieveResp.java 457 2009-01-15 17:37:42Z orank $
 36 */
 37public class ParamRetrieveResp extends SMPPPacket {
 38    private static final long serialVersionUID = 2L;
 39
 40    /** String value of the requested parameter */
 41    private String paramValue;
 42
 43    /**
 44     * Construct a new BindReceiverResp.
 45     */
 46    public ParamRetrieveResp() {
 47        super(CommandId.PARAM_RETRIEVE_RESP);
 48    }
 49
 50    /**
 51     * Create a new ParamRetrieveResp packet in response to a BindReceiver. This
 52     * constructor will set the sequence number to it's expected value.
 53     * 
 54     * @param request
 55     *            The Request packet the response is to
 56     */
 57    public ParamRetrieveResp(SMPPPacket request) {
 58        super(request);
 59    }
 60
 61    /**
 62     * Set the parameter value.
 63     * @param paramValue
 64     *            Value to be returned for the requested parameter.
 65     */
 66    public void setParamValue(String paramValue) {
 67        this.paramValue = paramValue;
 68    }
 69
 70    /** Get the value of the parameter */
 71    public String getParamValue() {
 72        return paramValue;
 73    }
 74
 75    @Override
 76    public boolean equals(Object obj) {
 77        boolean equals = super.equals(obj);
 78        if (equals) {
 79            ParamRetrieveResp other = (ParamRetrieveResp) obj;
 80            equals |= safeCompare(paramValue, other.paramValue);
 81        }
 82        return equals;
 83    }
 84    
 85    @Override
 86    public int hashCode() {
 87        int hc = super.hashCode();
 88        hc += (paramValue != null) ? paramValue.hashCode() : 0;
 89        return hc;
 90    }
 91
 92    @Override
 93    protected void toString(StringBuilder buffer) {
 94        buffer.append("paramValue=").append(paramValue);
 95    }
 96    
 97    @Override
 98    protected void validateMandatory(SMPPVersion smppVersion) {
 99        smppVersion.validateParamValue(paramValue);
100    }
101    
102    @Override
103    protected void readMandatory(PacketDecoder decoder) {
104        paramValue = decoder.readCString();
105    }
106    
107    @Override
108    protected void writeMandatory(PacketEncoder encoder) throws IOException {
109        encoder.writeCString(paramValue);
110    }
111    
112    @Override
113    protected int getMandatorySize() {
114        return 1 + sizeOf(paramValue);
115    }
116}