Class CryptographicServiceMessage

java.lang.Object

org.jpos.security.CryptographicServiceMessage

All Implemented Interfaces:

Loggeable

public class CryptographicServiceMessage
extends Object
implements Loggeable

Cryptographic Service Message (CSM for short). A message for transporting keys or related information used to control a keying relationship. It is typically the contents of ISOField(123). For more information refer to ANSI X9.17: Financial Institution Key Mangement (Wholesale).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CryptographicServiceMessage.ParsingException	Exception thrown when CSM parsing fails.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MCL_ESM	Message Class Label for ESM.
static final String	MCL_KSM	Message Class Label for KSM (Key Service Message).
static final String	MCL_RSI	Message Class Label for RSI.
static final String	MCL_RSM	Message Class Label for RSM.
static final String	TAG_CTP	Tag name for Clear Text PIN.
static final String	TAG_CTR	Tag name for Counter.
static final String	TAG_ERF	Tag name for Error Flag.
static final String	TAG_KD	Tag name for Key Data.
static final String	TAG_ORG	Tag name for Originator.
static final String	TAG_RCV	Tag name for Receiver.
static final String	TAG_SVR	Tag name for Server.

Constructor Summary

Constructors

Constructor	Description
CryptographicServiceMessage()	Default constructor.
CryptographicServiceMessage(String mcl)	Creates a CSM and sets its Message Class

Method Summary

Modifier and Type	Method	Description
void	addField(String tag, String content)	adds a field to the CSM
void	dump(PrintStream p, String indent)	dumps CSM basic information
String	getFieldContent(String tag)	Returns the field content of a field with the given tag.
String	getMCL()	Returns the message class label.
static CryptographicServiceMessage	parse(String csmString)	Parses a CSM string into a CryptographicServiceMessage object.
void	removeField(String tag)	Remove field from CSM
void	removeFields(String... tags)	Remove fields from CSM
void	setMCL(String mcl)	Sets the message class label.
String	toString()

Methods inherited from class Object

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

Methods inherited from interface Loggeable

dump

Modifier and Type	Method	Description
default void	dump(PrintStream p, String indent, LogRenderer.Type type)	Dumps a representation of this object using the specified renderer type.

Field Details

MCL_RSI

public static final String MCL_RSI

Message Class Label for RSI.

See Also:

• Constant Field Values

MCL_KSM

public static final String MCL_KSM

Message Class Label for KSM (Key Service Message).

See Also:

• Constant Field Values

MCL_RSM

public static final String MCL_RSM

Message Class Label for RSM.

See Also:

• Constant Field Values

MCL_ESM

public static final String MCL_ESM

Message Class Label for ESM.

See Also:

• Constant Field Values

TAG_RCV

public static final String TAG_RCV

Tag name for Receiver.

See Also:

• Constant Field Values

TAG_ORG

public static final String TAG_ORG

Tag name for Originator.

See Also:

• Constant Field Values

TAG_SVR

public static final String TAG_SVR

Tag name for Server.

See Also:

• Constant Field Values

TAG_KD

public static final String TAG_KD

Tag name for Key Data.

See Also:

• Constant Field Values

TAG_CTP

public static final String TAG_CTP

Tag name for Clear Text PIN.

See Also:

• Constant Field Values

TAG_CTR

public static final String TAG_CTR

Tag name for Counter.

See Also:

• Constant Field Values

TAG_ERF

public static final String TAG_ERF

Tag name for Error Flag.

See Also:

• Constant Field Values

Constructor Details

CryptographicServiceMessage

public CryptographicServiceMessage()

Default constructor.

CryptographicServiceMessage

public CryptographicServiceMessage(String mcl)

Creates a CSM and sets its Message Class

Parameters:

mcl - message class name. e.g. MCL_KSM, MCL_RSM...

Method Details

setMCL

public void setMCL(String mcl)

Sets the message class label.

Parameters:

mcl - the message class label (e.g. MCL_KSM, MCL_RSM)

getMCL

public String getMCL()

Returns the message class label.

Returns:

the message class label

addField

public void addField(String tag,
 String content)

adds a field to the CSM

Parameters:

tag - Field Tag

content - Field Content, can't be null, use an empty string ("") instead

Throws:

NullPointerException - if tag or content is null

removeField

public void removeField(String tag)

Remove field from CSM

Parameters:

tag - Field Tag

Throws:

NullPointerException - on null tag

removeFields

public void removeFields(String... tags)

Remove fields from CSM

Parameters:

tags - tag list

Throws:

NullPointerException - on null tag

getFieldContent

public String getFieldContent(String tag)

Returns the field content of a field with the given tag.

Parameters:

tag - the field tag (case-insensitive)

Returns:

field content, or null if tag not found

toString

public String toString()

Overrides:

toString in class Object

dump

public void dump(PrintStream p,
 String indent)

dumps CSM basic information

Specified by:

dump in interface Loggeable

Parameters:

p - a PrintStream usually supplied by Logger

indent - indention string, usually suppiled by Logger

See Also:

• Loggeable

parse

public static CryptographicServiceMessage parse(String csmString)
                                         throws CryptographicServiceMessage.ParsingException

Parses a CSM string into a CryptographicServiceMessage object.

Parameters:

csmString - the CSM string to parse

Returns:

the parsed CSM object

Throws:

CryptographicServiceMessage.ParsingException - if the string cannot be parsed