com.prowidesoftware.swift.model.mt.mt5xx.MT526 Maven / Gradle / Ivy
Show all versions of pw-swift-core Show documentation
/*
* Copyright 2006-2023 Prowide
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.prowidesoftware.swift.model.mt.mt5xx;
import com.prowidesoftware.Generated;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;
import java.util.Collections;
import org.apache.commons.lang3.StringUtils;
import com.prowidesoftware.swift.model.*;
import com.prowidesoftware.swift.internal.*;
import com.prowidesoftware.swift.internal.SequenceStyle.Type;
import com.prowidesoftware.swift.model.field.*;
import com.prowidesoftware.swift.model.mt.AbstractMT;
import com.prowidesoftware.swift.utils.Lib;
import java.io.File;
import java.io.InputStream;
import java.io.IOException;
/**
* MT 526 - General Securities Lending/Borrowing Message.
*
*
* SWIFT MT526 (ISO 15022) message structure:
*
-
Sequence A (M)
- Field 20 (M)
- Field 21 (O)
- Field 23 (M)
- Field 83 C (O)
- Field 29 A (O)
- Field 29 B (O)
-
Sequence B (M) (repetitive)
- Field 35 B (M)
- Field 35 A (O)
- Field 30 (O)
- Field 31 F (O)
- Field 87 A,D (O)
- Field 72 (O)
*
*
* This source code is specific to release SRU 2023
*
* For additional resources check https://www.prowidesoftware.com/resources
*/
@Generated
public class MT526 extends AbstractMT implements Serializable {
/**
* Constant identifying the SRU to which this class belongs to.
*/
public static final int SRU = 2023;
private static final long serialVersionUID = 1L;
private static final java.util.logging.Logger log = java.util.logging.Logger.getLogger(MT526.class.getName());
/**
* Constant for MT name, this is part of the classname, after MT.
*/
public static final String NAME = "526";
/**
* Creates an MT526 initialized with the parameter SwiftMessage.
* @param m swift message with the MT526 content
*/
public MT526(final SwiftMessage m) {
super(m);
sanityCheck(m);
}
/**
* Creates an MT526 initialized with the parameter MtSwiftMessage.
* @param m swift message with the MT526 content, the parameter can not be null
* @see #MT526(String)
*/
public MT526(final MtSwiftMessage m) {
this(m.message());
}
/**
* Creates an MT526 initialized with the parameter MtSwiftMessage.
*
* @param m swift message with the MT526 content
* @return the created object or null if the parameter is null
* @see #MT526(String)
* @since 7.7
*/
public static MT526 parse(final MtSwiftMessage m) {
if (m == null) {
return null;
}
return new MT526(m);
}
/**
* Creates and initializes a new MT526 input message setting TEST BICS as sender and receiver.
* All mandatory header attributes are completed with default values.
*
* @since 7.6
*/
public MT526() {
this(BIC.TEST8, BIC.TEST8);
}
/**
* Creates and initializes a new MT526 input message from sender to receiver.
* All mandatory header attributes are completed with default values.
* In particular the sender and receiver addresses will be filled with proper default LT identifier
* and branch codes if not provided,
*
* @param sender the sender address as a bic8, bic11 or full logical terminal consisting of 12 characters
* @param receiver the receiver address as a bic8, bic11 or full logical terminal consisting of 12 characters
* @since 7.7
*/
public MT526(final String sender, final String receiver) {
super(526, sender, receiver);
}
/**
* Creates a new MT526 by parsing a String with the message content in its swift FIN format.
* If the fin parameter is null or the message cannot be parsed, the internal message object
* will be initialized (blocks will be created) but empty.
* If the string contains multiple messages, only the first one will be parsed.
*
* @param fin a string with the MT message in its FIN swift format
* @since 7.7
*/
public MT526(final String fin) {
super();
if (fin != null) {
final SwiftMessage parsed = read(fin);
if (parsed != null) {
super.m = parsed;
sanityCheck(parsed);
}
}
}
private void sanityCheck(final SwiftMessage param) {
if (param.isServiceMessage()) {
log.warning("Creating an MT526 object from FIN content with a Service Message. Check if the MT526 you are intended to read is prepended with and ACK.");
} else if (!StringUtils.equals(param.getType(), "526")) {
log.warning("Creating an MT526 object from FIN content with message type "+param.getType());
}
}
/**
* Creates a new MT526 by parsing a String with the message content in its swift FIN format.
* If the fin parameter cannot be parsed, the returned MT526 will have its internal message object
* initialized (blocks will be created) but empty.
* If the string contains multiple messages, only the first one will be parsed.
*
* @param fin a string with the MT message in its FIN swift format. fin may be null in which case this method returns null
* @return a new instance of MT526 or null if fin is null
* @since 7.7
*/
public static MT526 parse(final String fin) {
if (fin == null) {
return null;
}
return new MT526(fin);
}
/**
* Creates a new MT526 by parsing a input stream with the message content in its swift FIN format, using "UTF-8" as encoding.
* If the message content is null or cannot be parsed, the internal message object
* will be initialized (blocks will be created) but empty.
* If the stream contains multiple messages, only the first one will be parsed.
*
* @param stream an input stream in UTF-8 encoding with the MT message in its FIN swift format.
* @throws IOException if the stream data cannot be read
* @since 7.7
*/
public MT526(final InputStream stream) throws IOException {
this(Lib.readStream(stream));
}
/**
* Creates a new MT526 by parsing a input stream with the message content in its swift FIN format, using "UTF-8" as encoding.
* If the stream contains multiple messages, only the first one will be parsed.
*
* @param stream an input stream in UTF-8 encoding with the MT message in its FIN swift format.
* @return a new instance of MT526 or null if stream is null or the message cannot be parsed
* @throws IOException if the stream data cannot be read
* @since 7.7
*/
public static MT526 parse(final InputStream stream) throws IOException {
if (stream == null) {
return null;
}
return new MT526(stream);
}
/**
* Creates a new MT526 by parsing a file with the message content in its swift FIN format.
* If the file content is null or cannot be parsed as a message, the internal message object
* will be initialized (blocks will be created) but empty.
* If the file contains multiple messages, only the first one will be parsed.
*
* @param file a file with the MT message in its FIN swift format.
* @throws IOException if the file content cannot be read
* @since 7.7
*/
public MT526(final File file) throws IOException {
this(Lib.readFile(file));
}
/**
* Creates a new MT526 by parsing a file with the message content in its swift FIN format.
* If the file contains multiple messages, only the first one will be parsed.
*
* @param file a file with the MT message in its FIN swift format.
* @return a new instance of MT526 or null if; file is null, does not exist, can't be read, is not a file or the message cannot be parsed
* @throws IOException if the file content cannot be read
* @since 7.7
*/
public static MT526 parse(final File file) throws IOException {
if (file == null) {
return null;
}
return new MT526(file);
}
/**
* Returns this MT number.
* @return the message type number of this MT
* @since 6.4
*/
@Override
public String getMessageType() {
return "526";
}
/**
* Add all tags from block to the end of the block4.
*
* @param block to append
* @return this object to allow method chaining
* @since 7.6
*/
@Override
public MT526 append(final SwiftTagListBlock block) {
super.append(block);
return this;
}
/**
* Add all tags to the end of the block4.
*
* @param tags to append
* @return this object to allow method chaining
* @since 7.6
*/
@Override
public MT526 append(final Tag... tags) {
super.append(tags);
return this;
}
/**
* Add all the fields to the end of the block4.
*
* @param fields to append
* @return this object to allow method chaining
* @since 7.6
*/
@Override
public MT526 append(final Field... fields) {
super.append(fields);
return this;
}
/**
* Creates an MT526 messages from its JSON representation.
*
* For generic conversion of JSON into the corresponding MT instance
* see {@link AbstractMT#fromJson(String)}
*
* @param json a JSON representation of an MT526 message
* @return a new instance of MT526
* @since 7.10.3
*/
public static MT526 fromJson(final String json) {
return (MT526) AbstractMT.fromJson(json);
}
/**
* Iterates through block4 fields and return the first one whose name matches 20,
* or null if none is found.
* The first occurrence of field 20 at MT526 is expected to be the only one.
*
* @return a Field20 object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field20 getField20() {
final Tag t = tag("20");
if (t != null) {
return new Field20(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 21,
* or null if none is found.
* The first occurrence of field 21 at MT526 is expected to be the only one.
*
* @return a Field21 object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field21 getField21() {
final Tag t = tag("21");
if (t != null) {
return new Field21(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 23,
* or null if none is found.
* The first occurrence of field 23 at MT526 is expected to be the only one.
*
* @return a Field23 object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field23 getField23() {
final Tag t = tag("23");
if (t != null) {
return new Field23(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 83C,
* or null if none is found.
* The first occurrence of field 83C at MT526 is expected to be the only one.
*
* @return a Field83C object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field83C getField83C() {
final Tag t = tag("83C");
if (t != null) {
return new Field83C(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 29A,
* or null if none is found.
* The first occurrence of field 29A at MT526 is expected to be the only one.
*
* @return a Field29A object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field29A getField29A() {
final Tag t = tag("29A");
if (t != null) {
return new Field29A(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 29B,
* or null if none is found.
* The first occurrence of field 29B at MT526 is expected to be the only one.
*
* @return a Field29B object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field29B getField29B() {
final Tag t = tag("29B");
if (t != null) {
return new Field29B(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return all occurrences of fields whose names matches 35B,
* or Collections.emptyList() if none is found.
* Multiple occurrences of field 35B at MT526 are expected at one sequence or across several sequences.
*
* @return a List of Field35B objects or Collections.emptyList() if none is not found
* @see SwiftTagListBlock#getTagsByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public List getField35B() {
final List result = new ArrayList<>();
final Tag[] tags = tags("35B");
if (tags != null && tags.length > 0) {
for (Tag tag : tags) {
result.add(new Field35B(tag.getValue()));
}
}
return result;
}
/**
* Iterates through block4 fields and return all occurrences of fields whose names matches 35A,
* or Collections.emptyList() if none is found.
* Multiple occurrences of field 35A at MT526 are expected at one sequence or across several sequences.
*
* @return a List of Field35A objects or Collections.emptyList() if none is not found
* @see SwiftTagListBlock#getTagsByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public List getField35A() {
final List result = new ArrayList<>();
final Tag[] tags = tags("35A");
if (tags != null && tags.length > 0) {
for (Tag tag : tags) {
result.add(new Field35A(tag.getValue()));
}
}
return result;
}
/**
* Iterates through block4 fields and return all occurrences of fields whose names matches 30,
* or Collections.emptyList() if none is found.
* Multiple occurrences of field 30 at MT526 are expected at one sequence or across several sequences.
*
* @return a List of Field30 objects or Collections.emptyList() if none is not found
* @see SwiftTagListBlock#getTagsByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public List getField30() {
final List result = new ArrayList<>();
final Tag[] tags = tags("30");
if (tags != null && tags.length > 0) {
for (Tag tag : tags) {
result.add(new Field30(tag.getValue()));
}
}
return result;
}
/**
* Iterates through block4 fields and return all occurrences of fields whose names matches 31F,
* or Collections.emptyList() if none is found.
* Multiple occurrences of field 31F at MT526 are expected at one sequence or across several sequences.
*
* @return a List of Field31F objects or Collections.emptyList() if none is not found
* @see SwiftTagListBlock#getTagsByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public List getField31F() {
final List result = new ArrayList<>();
final Tag[] tags = tags("31F");
if (tags != null && tags.length > 0) {
for (Tag tag : tags) {
result.add(new Field31F(tag.getValue()));
}
}
return result;
}
/**
* Iterates through block4 fields and return all occurrences of fields whose names matches 87A,
* or Collections.emptyList() if none is found.
* Multiple occurrences of field 87A at MT526 are expected at one sequence or across several sequences.
*
* @return a List of Field87A objects or Collections.emptyList() if none is not found
* @see SwiftTagListBlock#getTagsByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public List getField87A() {
final List result = new ArrayList<>();
final Tag[] tags = tags("87A");
if (tags != null && tags.length > 0) {
for (Tag tag : tags) {
result.add(new Field87A(tag.getValue()));
}
}
return result;
}
/**
* Iterates through block4 fields and return all occurrences of fields whose names matches 87D,
* or Collections.emptyList() if none is found.
* Multiple occurrences of field 87D at MT526 are expected at one sequence or across several sequences.
*
* @return a List of Field87D objects or Collections.emptyList() if none is not found
* @see SwiftTagListBlock#getTagsByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public List getField87D() {
final List result = new ArrayList<>();
final Tag[] tags = tags("87D");
if (tags != null && tags.length > 0) {
for (Tag tag : tags) {
result.add(new Field87D(tag.getValue()));
}
}
return result;
}
/**
* Iterates through block4 fields and return all occurrences of fields whose names matches 72,
* or Collections.emptyList() if none is found.
* Multiple occurrences of field 72 at MT526 are expected at one sequence or across several sequences.
*
* @return a List of Field72 objects or Collections.emptyList() if none is not found
* @see SwiftTagListBlock#getTagsByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public List getField72() {
final List result = new ArrayList<>();
final Tag[] tags = tags("72");
if (tags != null && tags.length > 0) {
for (Tag tag : tags) {
result.add(new Field72(tag.getValue()));
}
}
return result;
}
/**
* Class to model Sequence "A" in MT 526.
*/
public static class SequenceA extends SwiftTagListBlock {
private static final long serialVersionUID = 1L;
/**
* Constructs an empty sequence.
*/
private SequenceA() {
super(new ArrayList<>());
}
/**
* Creates a sequence with the given content.
* @see SwiftTagListBlock
*/
private SequenceA(final SwiftTagListBlock content) {
super(content.getTags());
}
/**
* First mandatory tag name of the sequence: "20" .
* Array format is for cases when more than one letter options is allowed
*/
public static final String[] START = { "20" } ;
/**
* Last mandatory tag name of the sequence: "23"
* Array format is for cases when more than one letter options is allowed
*/
protected static final String[] END = { "23" };
/**
* List of optional tags after the last mandatory tag.
*/
protected static final String[] TAIL = new String[]{ "83C", "29A", "29B" };
/**
* Same as {@link #newInstance(int, int, Tag...)} using zero for the indexes.
* @param tags the list of tags to set as sequence content
* @return a new instance of the sequence, initialized with the parameter tags
*/
@SequenceStyle(Type.GENERATED_FIXED_WITH_OPTIONAL_TAIL)
public static SequenceA newInstance(final Tag... tags) {
return newInstance(0, 0, tags);
}
/**
* Creates a sequence with starting and ending tags set to the indicated tags in from the
* {@link #START} and {@link #END} lists of mandatory fields, and with the content between
* the starting and ending tag initialized with the given optional tags.
*
* @param start a zero-based index within the list of mandatory starting tags in the sequence
* @param end a zero-based index within the list of mandatory ending tags in the sequence
* @param tags the list of tags to set as sequence content
* @return a new instance of the sequence, initialized with the parameter tags
*/
@SequenceStyle(Type.GENERATED_FIXED_WITH_OPTIONAL_TAIL)
public static SequenceA newInstance(final int start, final int end, final Tag... tags) {
final SequenceA result = new SequenceA();
result.append(new Tag(START[start], ""));
if (tags != null && tags.length > 0) {
for (final Tag t : tags) {
result.append(t);
}
}
result.append(new Tag(END[end], ""));
return result;
}
}
/**
* Get the single occurrence of SequenceA delimited by leading tag and end, with an optional tail.
* The presence of this method indicates that this sequence can occur only once according to the Standard.
* If block 4 is empty this method returns null.
*
* @return the found sequence or an empty sequence if none is found
* @see SwiftTagListBlock#getSubBlockDelimitedWithOptionalTail(String[], String[], String[])
*/
@SequenceStyle(Type.GENERATED_FIXED_WITH_OPTIONAL_TAIL)
public SequenceA getSequenceA() {
return getSequenceA(super.getSwiftMessageNotNullOrException().getBlock4());
}
/**
* Get the single occurrence of SequenceA delimited by leading tag and end, with an optional tail.
* The presence of this method indicates that this sequence can occur only once according to the Standard.
* If block 4 is empty this method returns null.
*
* @see SwiftTagListBlock#getSubBlockDelimitedWithOptionalTail(String[], String[], String[])
* @param parentSequence a not null parent sequence to find SequenceA within it
* @return the found sequence or an empty sequence if none is found, or null if the parent sequence is null or empty
* @since 7.7
*/
@SequenceStyle(Type.GENERATED_FIXED_WITH_OPTIONAL_TAIL)
public SequenceA getSequenceA(SwiftTagListBlock parentSequence) {
if (parentSequence != null && !parentSequence.isEmpty()) {
final SwiftTagListBlock content = parentSequence.getSubBlockDelimitedWithOptionalTail(SequenceA.START, SequenceA.END, SequenceA.TAIL);
if (log.isLoggable(java.util.logging.Level.FINE)) {
if (content == null) {
log.fine("content for sequence SequenceA: is null");
} else {
log.fine("content for sequence SequenceA: "+content.tagNamesList());
}
}
if (content == null) {
return new SequenceA();
} else {
return new SequenceA(content);
}
}
return null;
}
/**
* Class to model Sequence "B" in MT 526.
*/
public static class SequenceB extends SwiftTagListBlock {
private static final long serialVersionUID = 1L;
/**
* Constructs an empty sequence.
*/
private SequenceB() {
super(new ArrayList<>());
}
/**
* Creates a sequence with the given content.
* @see SwiftTagListBlock
*/
private SequenceB(final SwiftTagListBlock content) {
super(content.getTags());
}
/**
* The name of the first tag in the sequence which must be mandatory.
* May be null if we cannot determine this safely
*/
public static final String START_NAME = "35B" ;
}
}