/protocols/smpp/src/main/java/org/mobicents/protocols/smpp/message/ParamRetrieve.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 * Parameter retrieve. Gets the current value of a configurable parameter at the
 33 * SMSC.
 34 * 
 35 * @version $Id: ParamRetrieve.java 457 2009-01-15 17:37:42Z orank $
 36 */
 37public class ParamRetrieve extends SMPPPacket {
 38    private static final long serialVersionUID = 2L;
 39
 40    /** Name of the parameter to retrieve */
 41    private String paramName;
 42
 43    /**
 44     * Construct a new ParamRetrieve.
 45     */
 46    public ParamRetrieve() {
 47        super(CommandId.PARAM_RETRIEVE);
 48    }
 49
 50    /**
 51     * Set the name of the parameter to retrieve
 52     * @param paramName
 53     */
 54    public void setParamName(String paramName) {
 55        this.paramName = paramName;
 56    }
 57
 58    /** Get the parameter name */
 59    public String getParamName() {
 60        return paramName;
 61    }
 62
 63    @Override
 64    public boolean equals(Object obj) {
 65        boolean equals = super.equals(obj);
 66        if (equals) {
 67            ParamRetrieve other = (ParamRetrieve) obj;
 68            equals |= safeCompare(paramName, other.paramName);
 69        }
 70        return equals;
 71    }
 72    
 73    @Override
 74    public int hashCode() {
 75        int hc = super.hashCode();
 76        hc += (paramName != null) ? paramName.hashCode() : 0;
 77        return hc;
 78    }
 79
 80    @Override
 81    protected void toString(StringBuilder buffer) {
 82        buffer.append("paramName=").append(paramName);
 83    }
 84
 85    @Override
 86    protected void validateMandatory(SMPPVersion smppVersion) {
 87        smppVersion.validateParamName(paramName);
 88    }
 89
 90    @Override
 91    protected void readMandatory(PacketDecoder decoder) {
 92        paramName = decoder.readCString();
 93    }
 94    
 95    @Override
 96    protected void writeMandatory(PacketEncoder encoder) throws IOException {
 97        encoder.writeCString(paramName);
 98    }
 99    
100    @Override
101    protected int getMandatorySize() {
102        return 1 + sizeOf(paramName);
103    }
104}