com.prowidesoftware.swift.model.mx

Class BusinessHeader

java.lang.Object

com.prowidesoftware.swift.model.mx.BusinessHeader

All Implemented Interfaces:

AppHdr

Deprecated.

use specific implementation of AppHdr instead, such as BusinessAppHdrV01

@Deprecated
 @ProwideDeprecated(phase2=SRU2021)
public class BusinessHeader
extends java.lang.Object
implements AppHdr

This header model was original implemented as a holder for the two available headers:

• The ISO 20022 business application header: ApplicationHeader
• The application header originally defined by swift: BusinessApplicationHeaderV01

A more flexible and scalable solution is done is provided now by the AppHdr interface and its implementing classes. Usage of this BusinessHeader is discourage in favor of AppHdr implementations such as BusinessAppHdrV01 or LegacyAppHdr

Since:

7.7

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAMESPACE_AH Deprecated. use LegacyAppHdr.NAMESPACE instead
static java.lang.String	NAMESPACE_BAH Deprecated. use BusinessAppHdrV01.NAMESPACE instead

Fields inherited from interface com.prowidesoftware.swift.model.mx.AppHdr

HEADER_LOCALNAME

Constructor Summary

Constructors

Constructor and Description
BusinessHeader() Deprecated. use specific implementation of AppHdr instead, such as BusinessAppHdrV01
BusinessHeader(com.prowidesoftware.swift.model.mx.dic.ApplicationHeader applicationHeader) Deprecated. use specific implementation of AppHdr instead, such as LegacyAppHdr
BusinessHeader(BusinessAppHdrV01 businessAppHdrV01) Deprecated. use specific implementation of AppHdr instead, such as BusinessAppHdrV01
BusinessHeader(com.prowidesoftware.swift.model.mx.dic.BusinessApplicationHeaderV01 businessApplicationHeader) Deprecated. use specific implementation of AppHdr instead, such as BusinessAppHdrV01
BusinessHeader(LegacyAppHdr legacyAppHdr) Deprecated. use specific implementation of AppHdr instead, such as LegacyAppHdr

Method Summary

Modifier and Type	Method and Description
static BusinessHeader	create(java.lang.String sender, java.lang.String receiver, java.lang.String reference, MxId id) Deprecated. use AppHdrFactory.createBusinessAppHdrV01(String, String, String, MxId) instead
static com.prowidesoftware.swift.model.mx.dic.ApplicationHeader	createApplicationHeader(java.lang.String sender, java.lang.String receiver, java.lang.String reference, MxId id) Deprecated. use AppHdrFactory.createLegacyAppHdr(String, String, String, MxId) instead
static com.prowidesoftware.swift.model.mx.dic.BusinessApplicationHeaderV01	createBusinessApplicationHeaderV01(java.lang.String sender, java.lang.String receiver, java.lang.String reference, MxId id) Deprecated. use AppHdrFactory.createBusinessAppHdrV01(String, String, String, MxId) instead
javax.xml.datatype.XMLGregorianCalendar	creationDate() Deprecated. Gets the message creation date from the "CreDate" (BAH) or "CrDate" (AH) element.
boolean	duplicate() Deprecated. Gets the duplicate flag from the "PssblDplct" (BAH) or "Dup" (AH) element
org.w3c.dom.Element	element() Deprecated. Gets the header as an Element object.
java.lang.String	from() Deprecated. Gets the sender BIC code.
com.prowidesoftware.swift.model.mx.dic.ApplicationHeader	getApplicationHeader() Deprecated.
com.prowidesoftware.swift.model.mx.dic.BusinessApplicationHeaderV01	getBusinessApplicationHeader() Deprecated.
java.lang.String	messageName() Deprecated. Gets the message name from the "MsgDefIdr" (BAH) or "MsgName" (AH) element.
java.lang.String	reference() Deprecated. Get the message reference.
java.lang.String	serviceName() Deprecated. Gets the service name from the "BizSvc" (BAH) or "SvcName" (AH) element.
void	setApplicationHeader(com.prowidesoftware.swift.model.mx.dic.ApplicationHeader applicationHeader) Deprecated.
void	setBusinessApplicationHeader(com.prowidesoftware.swift.model.mx.dic.BusinessApplicationHeaderV01 businessApplicationHeader) Deprecated.
void	setCreationDate(boolean overwrite) Deprecated. Sets the creation date in the inner header object with current moment in UTC time zone.
java.lang.String	to() Deprecated. Gets the receiver BIC code If the header is a BAH, tries to gets the BIC code from this elements in the following order: BusinessApplicationHeaderV01/To/FIId/FinInstnId/BICFI BusinessApplicationHeaderV01/To/OrgId/Id/OrgId/Id/AnyBIC If the header is an AH, gets the same from ApplicationHeader/To/Type+Id where if Type is BIC the Id is returned as is, otherwise the domain name is parsed to extract the SWIFT BIC
java.lang.String	xml() Deprecated. Get this header as an XML string.
java.lang.String	xml(java.lang.String prefix, boolean includeXMLDeclaration) Deprecated. Get this header as an XML string.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.prowidesoftware.swift.model.mx.AppHdr

namespace, xml

Field Detail

NAMESPACE_AH

@Deprecated
 @ProwideDeprecated(phase2=SRU2021)
public static final transient java.lang.String NAMESPACE_AH

Deprecated. use LegacyAppHdr.NAMESPACE instead

See Also:

Constant Field Values

NAMESPACE_BAH

@Deprecated
 @ProwideDeprecated(phase2=SRU2021)
public static final transient java.lang.String NAMESPACE_BAH

Deprecated. use BusinessAppHdrV01.NAMESPACE instead

See Also:

Constant Field Values

Constructor Detail

BusinessHeader

@Deprecated
 @ProwideDeprecated(phase2=SRU2021)
public BusinessHeader()

Deprecated. use specific implementation of AppHdr instead, such as BusinessAppHdrV01

BusinessHeader

@Deprecated
 @ProwideDeprecated(phase2=SRU2021)
public BusinessHeader(com.prowidesoftware.swift.model.mx.dic.ApplicationHeader applicationHeader)

Deprecated. use specific implementation of AppHdr instead, such as LegacyAppHdr

BusinessHeader

@Deprecated
 @ProwideDeprecated(phase2=SRU2021)
public BusinessHeader(LegacyAppHdr legacyAppHdr)

Deprecated. use specific implementation of AppHdr instead, such as LegacyAppHdr

BusinessHeader

@Deprecated
 @ProwideDeprecated(phase2=SRU2021)
public BusinessHeader(com.prowidesoftware.swift.model.mx.dic.BusinessApplicationHeaderV01 businessApplicationHeader)

Deprecated. use specific implementation of AppHdr instead, such as BusinessAppHdrV01

BusinessHeader

@Deprecated
 @ProwideDeprecated(phase2=SRU2021)
public BusinessHeader(BusinessAppHdrV01 businessAppHdrV01)

Deprecated. use specific implementation of AppHdr instead, such as BusinessAppHdrV01

Method Detail

createBusinessApplicationHeaderV01

@Deprecated
 @ProwideDeprecated(phase2=SRU2021)
public static com.prowidesoftware.swift.model.mx.dic.BusinessApplicationHeaderV01 createBusinessApplicationHeaderV01(java.lang.String sender,
                                                                                                                                                                     java.lang.String receiver,
                                                                                                                                                                     java.lang.String reference,
                                                                                                                                                                     MxId id)

Deprecated. use AppHdrFactory.createBusinessAppHdrV01(String, String, String, MxId) instead

create

@Deprecated
 @ProwideDeprecated(phase2=SRU2021)
public static BusinessHeader create(java.lang.String sender,
                                                                                    java.lang.String receiver,
                                                                                    java.lang.String reference,
                                                                                    MxId id)

Deprecated. use AppHdrFactory.createBusinessAppHdrV01(String, String, String, MxId) instead

createApplicationHeader

@Deprecated
 @ProwideDeprecated(phase2=SRU2021)
public static com.prowidesoftware.swift.model.mx.dic.ApplicationHeader createApplicationHeader(java.lang.String sender,
                                                                                                                                               java.lang.String receiver,
                                                                                                                                               java.lang.String reference,
                                                                                                                                               MxId id)

Deprecated. use AppHdrFactory.createLegacyAppHdr(String, String, String, MxId) instead

getApplicationHeader

public com.prowidesoftware.swift.model.mx.dic.ApplicationHeader getApplicationHeader()

Deprecated.

setApplicationHeader

public void setApplicationHeader(com.prowidesoftware.swift.model.mx.dic.ApplicationHeader applicationHeader)

Deprecated.

getBusinessApplicationHeader

public com.prowidesoftware.swift.model.mx.dic.BusinessApplicationHeaderV01 getBusinessApplicationHeader()

Deprecated.

setBusinessApplicationHeader

public void setBusinessApplicationHeader(com.prowidesoftware.swift.model.mx.dic.BusinessApplicationHeaderV01 businessApplicationHeader)

Deprecated.

from

public java.lang.String from()

Deprecated.

Gets the sender BIC code.
If the header is a BAH, tries to gets the BIC code from this elements in the following order:

1. BusinessApplicationHeaderV01/Fr/FIId/FinInstnId/BICFI
2. BusinessApplicationHeaderV01/Fr/OrgId/Id/OrgId/Id/AnyBIC

If the header is an AH, gets the same from ApplicationHeader/From/Type+Id where if Type is BIC the Id is returned as is, otherwise the domain name is parsed to extract the SWIFT BIC

Specified by:

from in interface AppHdr

Returns:

found BIC or null if not present or cannot be parsed

to

public java.lang.String to()

Deprecated.

Gets the receiver BIC code
If the header is a BAH, tries to gets the BIC code from this elements in the following order:

1. BusinessApplicationHeaderV01/To/FIId/FinInstnId/BICFI
2. BusinessApplicationHeaderV01/To/OrgId/Id/OrgId/Id/AnyBIC

If the header is an AH, gets the same from ApplicationHeader/To/Type+Id where if Type is BIC the Id is returned as is, otherwise the domain name is parsed to extract the SWIFT BIC

Specified by:

to in interface AppHdr

Returns:

found BIC or null if not present or cannot be parsed

reference

public java.lang.String reference()

Deprecated.

Get the message reference.

Specified by:

reference in interface AppHdr

Returns:

the message reference from the header or null if the element is not found

Since:

7.8

See Also:

BusinessApplicationHeaderV01Impl.getBizMsgIdr(), ApplicationHeaderImpl.getMsgRef()

messageName

public java.lang.String messageName()

Deprecated.

Description copied from interface: AppHdr

Gets the message name from the "MsgDefIdr" (BAH) or "MsgName" (AH) element.

Specified by:

messageName in interface AppHdr

Returns:

the message name from the header or null if the element is not found

Since:

9.0.1

serviceName

public java.lang.String serviceName()

Deprecated.

Description copied from interface: AppHdr

Gets the service name from the "BizSvc" (BAH) or "SvcName" (AH) element.

Specified by:

serviceName in interface AppHdr

Returns:

the service name from the header or null if the element is not found

Since:

9.0.1

duplicate

public boolean duplicate()

Deprecated.

Description copied from interface: AppHdr

Gets the duplicate flag from the "PssblDplct" (BAH) or "Dup" (AH) element

Specified by:

duplicate in interface AppHdr

Returns:

true if the element is present, false otherwise

Since:

9.0.1

creationDate

public javax.xml.datatype.XMLGregorianCalendar creationDate()

Deprecated.

Description copied from interface: AppHdr

Gets the message creation date from the "CreDate" (BAH) or "CrDate" (AH) element.

Specified by:

creationDate in interface AppHdr

Returns:

found date or null if the element is not found

Since:

9.0.1

xml

public java.lang.String xml()

Deprecated.

Get this header as an XML string.

Specified by:

xml in interface AppHdr

Returns:

header serialized into XML string or null if neither header version is present

Since:

7.8

See Also:

xml(String, boolean)

xml

public java.lang.String xml(java.lang.String prefix,
                            boolean includeXMLDeclaration)

Deprecated.

Get this header as an XML string. Since this class contains a dual model supporting two type of headers (swift and ISO), if both headers are present in the object the BusinessApplicationHeaderV01 will be used.

Specified by:

xml in interface AppHdr

Parameters:

prefix - optional prefix for namespace (empty by default)

includeXMLDeclaration - true to include the XML declaration (false by default)

Returns:

header serialized into XML string or null if neither header version is present

Since:

7.8

element

public org.w3c.dom.Element element()

Deprecated.

Gets the header as an Element object.

Specified by:

element in interface AppHdr

Returns:

Element this header parsed into Element or null if header is null

Since:

7.8

setCreationDate

public void setCreationDate(boolean overwrite)

Deprecated.

Sets the creation date in the inner header object with current moment in UTC time zone.
Either of the inner headers must be not null. If both are null this method does nothing.

Specified by:

setCreationDate in interface AppHdr

Parameters:

overwrite - if true, the creation date will always be set overwriting any previous value; if false it will be set only if it is not already set

Since:

7.8.5