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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MCL_ESM
static final String	MCL_KSM
static final String	MCL_RSI
static final String	MCL_RSM
static final String	TAG_CTP
static final String	TAG_CTR
static final String	TAG_ERF
static final String	TAG_KD
static final String	TAG_ORG
static final String	TAG_RCV
static final String	TAG_SVR

Constructor Summary

Constructors

Constructor	Description
CryptographicServiceMessage()
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()
static CryptographicServiceMessage	parse(String csmString)	Parses a csm string
void	removeField(String tag)	Remove field from CSM
void	removeFields(String... tags)	Remove fields from CSM
void	setMCL(String mcl)
String	toString()	Formats the CSM as a string, suitable for transfer.

Methods inherited from class Object

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

Methods inherited from interface Loggeable

dump

Field Details

MCL_RSI

public static final String MCL_RSI

See Also:

• Constant Field Values

MCL_KSM

public static final String MCL_KSM

See Also:

• Constant Field Values

MCL_RSM

public static final String MCL_RSM

See Also:

• Constant Field Values

MCL_ESM

public static final String MCL_ESM

See Also:

• Constant Field Values

TAG_RCV

public static final String TAG_RCV

See Also:

• Constant Field Values

TAG_ORG

public static final String TAG_ORG

See Also:

• Constant Field Values

TAG_SVR

public static final String TAG_SVR

See Also:

• Constant Field Values

TAG_KD

public static final String TAG_KD

See Also:

• Constant Field Values

TAG_CTP

public static final String TAG_CTP

See Also:

• Constant Field Values

TAG_CTR

public static final String TAG_CTR

See Also:

• Constant Field Values

TAG_ERF

public static final String TAG_ERF

See Also:

• Constant Field Values

Constructor Details

CryptographicServiceMessage

public CryptographicServiceMessage()

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)

getMCL

public String getMCL()

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 -

Returns:

field Field Content, or null if tag not found

toString

public String toString()

Formats the CSM as a string, suitable for transfer. This is the inverse of parse

Overrides:

toString in class Object

Returns:

the CSM in string format

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

Parameters:

csmString -

Returns:

CSM object

Throws:

CryptographicServiceMessage.ParsingException