ie.omk.smpp.version.SMPPVersion Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of smppapi Show documentation
Show all versions of smppapi Show documentation
Java Implementation of the Short Message Peer to Peer API.
The newest version!
package ie.omk.smpp.version;
import ie.omk.smpp.Address;
import ie.omk.smpp.util.APIConfig;
import ie.omk.smpp.util.AlphabetEncoding;
import ie.omk.smpp.util.MessageEncoding;
/**
* Class representing an SMPP protocol version. Instances of this object are
* used by the rest of the API to determine is an SMPP message is supported by a
* certain version of the protocol.
*
* @since 0.3.0
* @author Oran Kelly
*/
public abstract class SMPPVersion {
/** Constant representing the message payload mandatory parameter. */
public static final int MESSAGE_PAYLOAD = 5;
/** Static SMPPVersion instance representing version SMPP v3.3. */
public static final SMPPVersion V33 = new SMPPVersion33();
/** Static SMPPVersion instance representing version SMPP v3.4. */
public static final SMPPVersion V34 = new SMPPVersion34();
/**
* Integer representing this version number. The SMPP specification states
* integer values that represent protocol revisions. These values are used
* mainly in the bind_* and bind response messages. Integer value 0x33
* represents version 3.3 of the protocol, integer value 0x34 represents
* version 3.4...it's assumed further major and minor revisions of the SMPP
* specification will continue this numbering scheme.
*/
private int versionID;
/**
* Descriptive text for this protocol version. This value is used only to
* return a representative string from toString.
*/
private String versionString;
/**
* Create a new SMPPVersion object.
*/
protected SMPPVersion(int versionID, String versionString) {
this.versionID = versionID;
this.versionString = versionString;
}
/**
* Get an object representing the default version of the API, which is 3.4.
*/
public static final SMPPVersion getDefaultVersion() {
return V34;
}
public static final SMPPVersion getVersion(int id) throws VersionException {
if (id == V33.getVersionID()) {
return V33;
} else if (id == V34.getVersionID()) {
return V34;
} else {
if (APIConfig.getInstance().getBoolean(APIConfig.LAX_VERSIONS, false)) {
if (id >= 0x00 && id <= 0x32) {
return V33;
}
}
}
throw new VersionException("Unknown version id: 0x"
+ Integer.toHexString(id));
}
/**
* Get the integer value for this protocol version object.
*/
public int getVersionID() {
return versionID;
}
/**
* Check if a version is older than this one. If ver is equal
* to this version, false will be returned.
*/
public boolean isOlder(SMPPVersion ver) {
return ver.versionID < this.versionID;
}
/**
* Check if a version is newer than this one. If ver is equal
* to this version, false will be returned.
*/
public boolean isNewer(SMPPVersion ver) {
return ver.versionID > this.versionID;
}
/**
* Test another SMPPVersion object for equality with this one.
*/
public boolean equals(Object obj) {
if (obj instanceof SMPPVersion) {
return ((SMPPVersion) obj).versionID == this.versionID;
} else {
return false;
}
}
/**
* @return the hash code for this SMPP version.
*/
public int hashCode() {
return new Integer(versionID).hashCode();
}
/**
* Test versionNum is the numeric representation of this SMPP
* version.
*/
public boolean equals(int versionNum) {
return versionNum == this.versionID;
}
/**
* Return a descriptive string of this protocol version.
*/
public String toString() {
return versionString;
}
/**
* Get the maximum allowed length for a particular field.
*/
public abstract int getMaxLength(int field);
/**
* Determine if a particular command is supported by this protocol version.
* This method takes any valid SMPP command ID (for both requests and
* responses) and returns true or false based on whether the protocol
* version this object represents supports that command or not.
*
* @param commandID
* the SMPP command ID to check support for.
*/
public abstract boolean isSupported(int commandID);
/**
* Determine if this SMPP version supports optional parameters.
*
* @return true if optional parameters are supported, false if they are not.
*/
public abstract boolean isSupportOptionalParams();
/**
* Validate and SMPP address for this SMPP version number.
*/
public abstract boolean validateAddress(Address s);
/**
* Validate the ESM class mandatory parameter.
*/
public abstract boolean validateEsmClass(int c);
/**
* Validate the Protocol ID mandatory parameter.
*/
public abstract boolean validateProtocolID(int id);
/**
* Validate the data coding mandatory parameter.
*/
public abstract boolean validateDataCoding(int dc);
/**
* Validate the default message ID mandatory parameter.
*/
public abstract boolean validateDefaultMsg(int id);
/**
* Validate the message text length.
*/
public abstract boolean validateMessageText(String text,
AlphabetEncoding alphabet);
/**
* Validate the length of the message bytes.
*/
public abstract boolean validateMessage(byte[] message,
MessageEncoding encoding);
/**
* Validate the service type mandatory parameter.
*/
public abstract boolean validateServiceType(String type);
/**
* Validate the message ID mandatory parameter.
*/
public abstract boolean validateMessageId(String id);
/**
* Validate the message state mandatory parameter. The message state and
* message status are the same. The name of the parameter changed between
* version 3.3 and version 3.4. The semantics, however, remain the same.
*/
public final boolean validateMessageStatus(int st) {
return validateMessageState(st);
}
/**
* Validate the message state mandatory parameter. The message state and
* message status are the same. The name of the parameter changed between
* version 3.3 and version 3.4. The semantics, however, remain the same.
*/
public abstract boolean validateMessageState(int state);
/**
* Validate the error code mandatory parameter.
*/
public abstract boolean validateErrorCode(int code);
public abstract boolean validatePriorityFlag(int flag);
public abstract boolean validateRegisteredDelivery(int flag);
public abstract boolean validateReplaceIfPresent(int flag);
public abstract boolean validateNumberOfDests(int num);
public abstract boolean validateNumUnsuccessful(int num);
public abstract boolean validateDistListName(String name);
public abstract boolean validateSystemId(String sysId);
public abstract boolean validatePassword(String password);
public abstract boolean validateSystemType(String sysType);
public abstract boolean validateAddressRange(String addressRange);
public abstract boolean validateParamName(String paramName);
public abstract boolean validateParamValue(String paramValue);
}