com.prowidesoftware.swift.model

Class SwiftBlock1

java.lang.Object

com.prowidesoftware.swift.model.SwiftBlock

com.prowidesoftware.swift.model.SwiftValueBlock

com.prowidesoftware.swift.model.SwiftBlock1

All Implemented Interfaces:

Serializable

public class SwiftBlock1
extends SwiftValueBlock
implements Serializable

Base class for SWIFT Basic Header Block (block 1). It contains information about the source of the message.
The basic header block 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 block is mandatory for all SWIFT messages.

Since:

4.0

Author:

www.prowidesoftware.com

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	APPLICATION_ID_FIN Constant for FIN messages in application id
static String	APPLICATION_ID_GPA Constant for GPA (General Purpose Application) messages in application id
static String	APPLICATION_ID_LOGINS Constant for Logins and so messages in application id

Fields inherited from class com.prowidesoftware.swift.model.SwiftBlock

blockType, id, input, output, unparsedTexts

Constructor Summary

Constructors

Constructor and Description
SwiftBlock1() Default constructor
SwiftBlock1(String value) Creates a block 1 object setting attributes by parsing the fixed string argument; for example "F01BANKBEBBAXXX2222123456" or "1:F01BANKBEBBAXXX2222123456"
SwiftBlock1(String applicationId, String serviceId, String logicalTerminal, String sessionNumber, String sequenceNumber) Constructor for specific values

Method Summary

Methods

Modifier and Type	Method and Description
void	clean() Sets all attributes to null
boolean	equals(Object obj)
String	getApplicationId() Gets the application ID field in block 1
BIC	getBIC() Gets the BIC code from the LT address.
String	getBlockValue() This method should be overwritten by subclasses, calling this method will throw a java.lang.UnsupportedOperationException
String	getLogicalTerminal() Gets the The Logical Terminal address of the sender for messages sent or the receiver for messages received from the SWIFT network.
String	getName() Returns the block name (the value 1 as a string)
Integer	getNumber() Returns the block number (the value 1 as an integer)
String	getSequenceNumber() Gets the sequence number field in block 1
String	getServiceId() Gets the service ID field in block 1
String	getSessionNumber() Gets the session number in block 1
String	getValue() Gets the fixed length block 1 value, as a result of concatenating its individual elements as follow: Application ID Service ID + Logical terminal (LT) address + Session number + Sequence number. Notice that this method does not return the "1:" string.
int	hashCode()
boolean	isEmpty() Tell if this block is empty or not.
void	setApplicationId(String applicationId) Sets the applicationId
protected void	setBlockName(String blockName) Sets the block name.
protected void	setBlockNumber(Integer blockNumber) Sets the block number.
void	setBlockValue(String value) This method should be overwritten by subclasses, calling this method will throw a java.lang.UnsupportedOperationException
void	setLogicalTerminal(BIC bic) Creates and sets a full LT address using the parameter BIC code and a default LT identifier.
void	setLogicalTerminal(LogicalTerminalAddress logicalTerminal) Sets the LT address.
void	setLogicalTerminal(String logicalTerminal) Sets the The Logical Terminal address with the parameter as it is given.
void	setSender(String sender) Completes if necessary and sets the LT address. The sender addresses will be filled with proper default LT identifier and branch codes if not provided.
void	setSequenceNumber(String sequenceNumber) Sets the Sequence number that is generated by the user's computer. For all FIN messages with a Service Identifier of 01 or 05, this number is the next expected sequence number appropriate to the direction of the transmission. For FIN messages with a Service Identifier of 21 or 25, the sequence number is that of the acknowledged service message. It is padded with zeros.
void	setServiceId(String serviceId) Sets the Service ID
void	setSessionNumber(String sessionNumber) Sets the Session number.
void	setValue(String value) Sets the block's attributes by parsing the fixed string argument; For example "F01BANKBEBBAXXX2222123456" or "1:F01BANKBEBBAXXX2222123456".
String	toJson()

Methods inherited from class com.prowidesoftware.swift.model.SwiftValueBlock

getValuePart, size

Methods inherited from class com.prowidesoftware.swift.model.SwiftBlock

getBlockType, getId, getUnparsedTexts, getUnparsedTextsSize, isTagBlock, setBlockType, setId, setInput, setOutput, setUnparsedTexts, toString, unparsedTextAddText, unparsedTextAddText, unparsedTextGetAsMessage, unparsedTextGetText, unparsedTextIsMessage, unparsedTextVerify

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

APPLICATION_ID_FIN

public static final transient String APPLICATION_ID_FIN

Constant for FIN messages in application id

Since:

4.1

See Also:

Constant Field Values

APPLICATION_ID_GPA

public static final transient String APPLICATION_ID_GPA

Constant for GPA (General Purpose Application) messages in application id

Since:

4.1

See Also:

Constant Field Values

APPLICATION_ID_LOGINS

public static final transient String APPLICATION_ID_LOGINS

Constant for Logins and so messages in application id

Since:

4.1

See Also:

Constant Field Values

Constructor Detail

SwiftBlock1

public SwiftBlock1()

Default constructor

SwiftBlock1

public SwiftBlock1(String value)

Creates a block 1 object setting attributes by parsing the fixed string argument;
for example "F01BANKBEBBAXXX2222123456" or "1:F01BANKBEBBAXXX2222123456"

Parameters:

value - a fixed length string of 25 or 27 (which must start with '1:') characters containing the blocks value

SwiftBlock1

public SwiftBlock1(String applicationId,
           String serviceId,
           String logicalTerminal,
           String sessionNumber,
           String sequenceNumber)

Constructor for specific values

Parameters:

applicationId - the application id

serviceId - the service id

logicalTerminal - the logical terminal name

sessionNumber - the session number

sequenceNumber - the message sequence number

Method Detail

clean

public void clean()

Sets all attributes to null

Since:

6.4

equals

public boolean equals(Object obj)

Overrides:

equals in class SwiftBlock

getApplicationId

public String getApplicationId()

Gets the application ID field in block 1

Returns:

application ID field in block 1

getBIC

public BIC getBIC()

Gets the BIC code from the LT address.

Returns:

the BIC object

Since:

7.6

getBlockValue

public String getBlockValue()

Description copied from class: SwiftValueBlock

This method should be overwritten by subclasses, calling this method will throw a java.lang.UnsupportedOperationException

Overrides:

getBlockValue in class SwiftValueBlock

Returns:

N/A

See Also:

getValue()

getLogicalTerminal

public String getLogicalTerminal()

Gets the The Logical Terminal address of the sender for messages sent or the receiver for messages received from the SWIFT network.

Returns:

the 12 characters logical terminal address

getName

public String getName()

Returns the block name (the value 1 as a string)

Specified by:

getName in class SwiftBlock

Returns:

block name

Since:

5.0

getNumber

public Integer getNumber()

Returns the block number (the value 1 as an integer)

Specified by:

getNumber in class SwiftBlock

Returns:

Integer containing the block's number

getSequenceNumber

public String getSequenceNumber()

Gets the sequence number field in block 1

Returns:

sequence number field in block 1

getServiceId

public String getServiceId()

Gets the service ID field in block 1

Returns:

service ID field in block 1

getSessionNumber

public String getSessionNumber()

Gets the session number in block 1

Returns:

session number in block 1

getValue

public String getValue()

Gets the fixed length block 1 value, as a result of concatenating its individual elements as follow:
Application ID Service ID + Logical terminal (LT) address + Session number + Sequence number.
Notice that this method does not return the "1:" string.

Overrides:

getValue in class SwiftValueBlock

Returns:

the blocks value as a single string

hashCode

public int hashCode()

Overrides:

hashCode in class SwiftBlock

isEmpty

public boolean isEmpty()

Tell if this block is empty or not. This block is considered to be empty if all its attributes are set to null.

Overrides:

isEmpty in class SwiftValueBlock

Returns:

true if all fields are null and false in other case

setApplicationId

public void setApplicationId(String applicationId)

Sets the applicationId

Parameters:

applicationId - String of 1 character containing the Application ID (F, A or L)

setBlockName

protected void setBlockName(String blockName)

Sets the block name. Will cause an exception unless setting block number to 1.

Specified by:

setBlockName in class SwiftBlock

Parameters:

blockName - the block name to set

Throws:

IllegalArgumentException - if parameter blockName is not the string "1"

Since:

5.0

setBlockNumber

protected void setBlockNumber(Integer blockNumber)

Sets the block number.

Specified by:

setBlockNumber in class SwiftBlock

Parameters:

blockNumber - the block number to set

Throws:

IllegalArgumentException - if parameter blockName is not the integer 1

Since:

5.0

setBlockValue

public void setBlockValue(String value)

Description copied from class: SwiftValueBlock

This method should be overwritten by subclasses, calling this method will throw a java.lang.UnsupportedOperationException

Overrides:

setBlockValue in class SwiftValueBlock

Parameters:

value - unused

See Also:

setValue(String)

setLogicalTerminal

public void setLogicalTerminal(BIC bic)

Creates and sets a full LT address using the parameter BIC code and a default LT identifier.

Parameters:

bic -

Since:

7.6

See Also:

setLogicalTerminal(LogicalTerminalAddress)

setLogicalTerminal

public void setLogicalTerminal(LogicalTerminalAddress logicalTerminal)

Sets the LT address.

Parameters:

logicalTerminal -

Since:

7.6

See Also:

LogicalTerminalAddress.getSenderLogicalTerminalAddress()

setLogicalTerminal

public void setLogicalTerminal(String logicalTerminal)

Sets the The Logical Terminal address with the parameter as it is given.

Parameters:

logicalTerminal - it is fixed at 12 characters; it must not have X in position 9 (padded with "X" if no branch is required).

setSender

public void setSender(String sender)

Completes if necessary and sets the LT address.
The sender addresses will be filled with proper default LT identifier and branch codes if not provided.

Since:

6.4

See Also:

setLogicalTerminal(LogicalTerminalAddress)

setSequenceNumber

public void setSequenceNumber(String sequenceNumber)

Sets the Sequence number that is generated by the user's computer.
For all FIN messages with a Service Identifier of 01 or 05, this number is the next expected sequence number appropriate to the direction of the transmission.
For FIN messages with a Service Identifier of 21 or 25, the sequence number is that of the acknowledged service message.
It is padded with zeros.

Parameters:

sequenceNumber - 6 numbers

setServiceId

public void setServiceId(String serviceId)

Sets the Service ID

Parameters:

serviceId - string of 2 characters containing Service ID (01, 02, 03, etc...)

setSessionNumber

public void setSessionNumber(String sessionNumber)

Sets the Session number. It is generated by the user's computer. As appropriate, the current application session number based on the Login. It is padded with zeros.

Parameters:

sessionNumber - 4 numbers.

setValue

public void setValue(String value)

Sets the block's attributes by parsing the fixed string argument;
For example "F01BANKBEBBAXXX2222123456" or "1:F01BANKBEBBAXXX2222123456".

Overrides:

setValue in class SwiftValueBlock

Parameters:

value - a fixed length string containing the blocks' value (25 or 24 characters when '1:' is not indicated; 26 or 27 characters when starting string '1:' is included)

toJson

public String toJson()

Since:

7.5