com.prowidesoftware.swift.model.SwiftBlock2Input Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of wife Show documentation
Prowide Core Libraries for SWIFT (TM) messages
The newest version!
/* 
 * 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.
*/
/*
 * Created on Sep 23, 2005 
 */
package com.prowidesoftware.swift.model;

import java.io.Serializable;

import org.apache.commons.lang.Validate;

/**
 * Base class for SWIFT Application Header Block (block 2)
 * for INPUT (to SWIFT).

 * This block is used to construct messages that are going 
 * to be input to the SWIFT network. From the application point
 * of view, it correspond to the SENT messages.


 * 
 * It's value is fixed-length and continuous with no field delimiters. 
 * This class contains its elements as individual attributes for 
 * easier management of the block value.

 * This is an optional block.
 * 
 * @author www.prowidesoftware.com
 * @since 4.0
 * @version $Id: SwiftBlock2Input.java,v 1.3 2013/03/07 00:58:28 zubri Exp $
 */
//TODO: add parameter checks (Validate.*) and complete javadocs 
public class SwiftBlock2Input extends SwiftBlock2 implements Serializable {
	//private static transient final java.util.logging.Logger log = java.util.logging.Logger.getLogger(SwiftBlock2.class);

	private static final long serialVersionUID = 1L;

	/**
	 * Receiver's address with X in position 9.
 
	 * It is fixed at 12 characters; it must have X in position 9
	 * (padded with "X" if no branch is required).
	 */
	private String receiverAddress;

	/**
	 * String of 1 character containing the Delivery Monitoring field is as follows:

	 * 1 = Non-Delivery Warning

	 * 2 = Delivery Notification

	 * 3 = Both valid, Non-Delivery Warning and Delivery Notification

	 * This value is optional.

	 * If the priority is U, delivery monitoring must be: 1 or 3.
 
	 * If the priority is N, delivery monitoring must be: 2 or not included.
	 */
	private String deliveryMonitoring;

	/**
	 * String of 3 characters containing the Obsolescence Period.
 
	 * It specifies when a non-delivery notification is generated as follows:

	 * Valid for U = 003 (15 minutes)

	 * Valid for N = 020 (100 minutes)

	 * This value is optional.
	 */
	private String obsolescencePeriod;

	/**
	 * Constructor for specific values
	 * 
	 * @param messageType the message type
	 * @param receiverAddress the receiver address
	 * @param messagePriority the message priority (S=system, U=urgent, N=normal)
	 * @param deliveryMonitoring the delivery monitoring option (1 or 3 for U priority, 2 for N priority)
	 * @param obsolescencePeriod the obsolescence period, measured in 5 minutes units (3 for priority U, 20 for priority N).

	 * According to SWIFT documentation, this value is ignored by the system
	 */
	public SwiftBlock2Input(final String messageType, final String receiverAddress, final String messagePriority, final String deliveryMonitoring, final String obsolescencePeriod) {
		this.messageType = messageType;
		this.receiverAddress = receiverAddress;
		this.messagePriority = messagePriority;
		this.deliveryMonitoring = deliveryMonitoring;
		this.obsolescencePeriod = obsolescencePeriod;
	}

	/**
	 * Creates a block 2 output object setting attributes by parsing the 
	 * string argument containing the blocks value. 
	 * This value can be in different
	 * flavors because some fields are optional.

	 * Example of supported values:
 
	 * "I100BANKDEFFXXXXU3003" (21) or "2:I100BANKDEFFXXXXU3003" (23)
	 * "I100BANKDEFFXXXXU3" (18) or "2:I100BANKDEFFXXXXU3" (20)
	 * "I100BANKDEFFXXXXU" (17) or "2:I100BANKDEFFXXXXU" (19)
	 * 
	 * @param value a string with length between 17 and 23 containing the blocks value
	 */
	public SwiftBlock2Input(final String value) {
		this.setValue(value);
	}

	/**
	 * Default constructor
	 */
	public SwiftBlock2Input() {
		super();
	}

	/**
	 * Sets the Message Type (MT) as classified and numbered by SWIFT.
	 * Three-digit FIN message type, 000 � 999.
	 * 
	 * @param messageType String of 3 character
	 */
	public void setMessageType(final String messageType) {
		this.messageType = messageType;
	}

	public String getMessageType() {
		return messageType;
	}

	/**
	 * Receiver's address with X in position 9.
 
	 * It is fixed at 12 characters; it must have X in position 9
	 * (padded with "X" if no branch is required).
	 * 
	 * @param receiverAddress 12 characters String
	 */
	public void setReceiverAddress(final String receiverAddress) {
		this.receiverAddress = receiverAddress;
	}

	/**
	 * Gets the receiver's address field in block 2 input
	 * @return receiver address
	 */
	public String getReceiverAddress() {
		return receiverAddress;
	}

	/**
	 * Sets the message priority as follows:

	 * S = System

	 * N = Normal

	 * U = Urgent
	 * 
	 * @param messagePriority String of 1 character 
	 */
	public void setMessagePriority(final String messagePriority) {
		this.messagePriority = messagePriority;
	}

	/**
	 * Gets the the message priority field in block 2 input
	 * @return message priority
	 */
	public String getMessagePriority() {
		return messagePriority;
	}

	/**
	 * Sets the Delivery Monitoring field is as follows:

	 * 1 = Non-Delivery Warning

	 * 2 = Delivery Notification

	 * 3 = Both valid, Non-Delivery Warning and Delivery Notification

	 * This value is optional.

	 * If the priority is U, delivery monitoring must be: 1 or 3.
 
	 * If the priority is N, delivery monitoring must be: 2 or not included.
	 * 
	 * @param deliveryMonitoring String of 1 character containing the Delivery Monitoring field
	 */
	public void setDeliveryMonitoring(final String deliveryMonitoring) {
		this.deliveryMonitoring = deliveryMonitoring;
	}

	/**
	 * Gets the Delivery Monitoring field in block 2 input
	 * @return the delivery monitoring
	 */
	public String getDeliveryMonitoring() {
		return deliveryMonitoring;
	}

	/**
	 * Sets the Obsolescence Period.
 
	 * It specifies when a non-delivery notification is generated as follows:

	 * Valid for U = 003 (15 minutes)

	 * Valid for N = 020 (100 minutes)

	 * This value is optional.
	 * 
	 * @param obsolescencePeriod String of 3 characters containing the Obsolescence Period
	 */
	public void setObsolescencePeriod(final String obsolescencePeriod) {
		this.obsolescencePeriod = obsolescencePeriod;
	}

	/**
	 * Gets the obsolescence period field in block 2 input
	 * @return the obsolescence period
	 */
	public String getObsolescencePeriod() {
		return obsolescencePeriod;
	}

	/**
	 * Tell if this block is empty or not.
	 * This block is considered to be empty if all its attributes are set to null.
	 * @return true if all fields are null and false in other case
	 */
	public boolean isEmpty() {
		return (messageType == null && receiverAddress == null && messagePriority == null && deliveryMonitoring == null && obsolescencePeriod == null);
	}

	/**
	 * Gets the fixed length block 2 value, as a result of
	 * concatenating its individual elements as follow:

	 * Message Type +
	 * Receivers address +
	 * Message Priority +
	 * Delivery Monitoring +
	 * Obsolescence Period.
	 */
	public String getValue() {
		if (isEmpty()) {
			return null;
		}
		final StringBuffer v = new StringBuffer("I");
		if (messageType != null) {
			v.append(messageType);
		}
		if (receiverAddress != null) {
			v.append(receiverAddress);
		}
		if (messagePriority != null) {
			v.append(messagePriority);
		}
		if (deliveryMonitoring != null) {
			v.append(deliveryMonitoring);
		}
		if (obsolescencePeriod != null) {
			v.append(obsolescencePeriod);
		}
		return v.toString();
	}

	/**
	 * Returns the block value
	 * @see #getValue()
	 */
	public String getBlockValue() {
		return getValue();
	}

	/**
	 * Sets the block's attributes by parsing the string argument
	 * containing the blocks value. This value can be in different
	 * flavors because some fields are optional.

	 * Example of supported values:

	 * 	 * "I100BANKDEFFXXXX"      (16) or "2:I100BANKDEFFXXXX"      (18)   // used for service/system messages
	 * "I100BANKDEFFXXXXU"     (17) or "2:I100BANKDEFFXXXXU"     (19)
	 * "I100BANKDEFFXXXXU3"    (18) or "2:I100BANKDEFFXXXXU3"    (20)
	 * "I100BANKDEFFXXXXU3003" (21) or "2:I100BANKDEFFXXXXU3003" (23)
	 * 


	 * 
	 * @param value a string with length between 17 and 23 containing the blocks value
	 */
	public void setValue(final String value) {

		// check parameters
		int slen = value.length();
		Validate.notNull(value, "value must not be null");
		Validate.isTrue(slen >= 16 && slen <= 23, "expected a string value of 17 up to 23 chars and obtained a " + slen + " chars string: '" + value + "'");

		// figure out the starting point and check the input value has proper optional
		int offset = 0;
		if (value.startsWith("2:I")) { // accept 2:...
			offset = 2;
		}
		;
		slen -= offset;
		if (slen != 16 && slen != 17 && slen != 18 && slen != 21) {
			throw new IllegalArgumentException("Value must match: I[[[]]]");
		}
		;
		if (Character.toUpperCase(value.charAt(offset)) != 'I') {
			throw new IllegalArgumentException("Value must match: I[[[]]]");
		}
		;
		offset++; // skip the input mark

		// separate value fragments
		int len;
		len = 3;
		this.setMessageType(this.getValuePart(value, offset, len));
		offset += len;
		len = 12;
		this.setReceiverAddress(this.getValuePart(value, offset, len));
		offset += len;
		len = 1;
		this.setMessagePriority(this.getValuePart(value, offset, len));
		offset += len; // optional (system messages)
		len = 1;
		this.setDeliveryMonitoring(this.getValuePart(value, offset, len));
		offset += len; // optional
		len = 3;
		this.setObsolescencePeriod(this.getValuePart(value, offset, len));
		offset += len; // optional
	}

	/**
	 * @see #setValue(String)
	 */
	public void setBlockValue(final String value) {
		setValue(value);
	}

	/**
	 * Sets all attributes to null
	 * @since 6.4
	 */
	public void clean() {
		super.messagePriority = null;
		super.messageType = null;
		this.receiverAddress = null;
		this.deliveryMonitoring = null;
		this.obsolescencePeriod = null;
	}

	public int hashCode() {
		final int prime = 31;
		int result = super.hashCode();
		result = prime * result + ((deliveryMonitoring == null) ? 0 : deliveryMonitoring.hashCode());
		result = prime * result + ((messagePriority == null) ? 0 : messagePriority.hashCode());
		result = prime * result + ((messageType == null) ? 0 : messageType.hashCode());
		result = prime * result + ((obsolescencePeriod == null) ? 0 : obsolescencePeriod.hashCode());
		result = prime * result + ((receiverAddress == null) ? 0 : receiverAddress.hashCode());
		return result;
	}

	public boolean equals(final Object obj) {
		if (this == obj) {
			return true;
		}
		if (!super.equals(obj)) {
			return false;
		}
		if (getClass() != obj.getClass()) {
			return false;
		}
		final SwiftBlock2Input other = (SwiftBlock2Input) obj;
		if (deliveryMonitoring == null) {
			if (other.deliveryMonitoring != null) {
				return false;
			}
		} else if (!deliveryMonitoring.equals(other.deliveryMonitoring)) {
			return false;
		}
		if (messagePriority == null) {
			if (other.messagePriority != null) {
				return false;
			}
		} else if (!messagePriority.equals(other.messagePriority)) {
			return false;
		}
		if (messageType == null) {
			if (other.messageType != null) {
				return false;
			}
		} else if (!messageType.equals(other.messageType)) {
			return false;
		}
		if (obsolescencePeriod == null) {
			if (other.obsolescencePeriod != null) {
				return false;
			}
		} else if (!obsolescencePeriod.equals(other.obsolescencePeriod)) {
			return false;
		}
		if (receiverAddress == null) {
			if (other.receiverAddress != null) {
				return false;
			}
		} else if (!receiverAddress.equals(other.receiverAddress)) {
			return false;
		}
		return true;
	}
}