jain.protocol.ss7.tcap.dialogue
Class DialoguePortion

java.lang.Object
  |
  +--jain.protocol.ss7.tcap.dialogue.DialoguePortion

All Implemented Interfaces:

java.io.Serializable

public final class DialoguePortion

extends java.lang.Object

implements java.io.Serializable

This class represents the optional Dialogue Portion of a dialogue handling primitive. An ITU 1992 or ITU 1996 implementation of the JAIN TCAP API should only use the Application Context and User Information parameters within this class. An ANSI 1992 implementation does not include a Dialogue Portion therefore should not use this class and an ANSI 1996 implementation may use all the parameters within this class.

Version:

1.1

Author:

Sun Microsystems Inc.

See Also:

Serialized Form

Constructor Summary

DialoguePortion()
Constructs a new DialoguePortion

Method Summary

void	clearAllParameters() Clears all previously set parameters .
int	getAppContextIdentifier() Gets the Application Context Identifier parameter of the Dialogue Portion.
byte[]	getAppContextName() Gets the Application Context Name parameter of the Dialogue Portion.
byte[]	getConfidentialityInformation() Gets the Confidentiality Information parameter of the Dialogue Portion.
int	getProtocolVersion() Gets the Protocol Version parameter of the Dialogue Portion.
int	getSecurityContextIdentifier() Gets the Security Context Identifier parameter of the Dialogue Portion.
byte[]	getSecurityContextInfo() Gets the Security Context Information parameter of the Dialogue Portion.
byte[]	getUserInformation() Gets the User Information parameter of this Dialogue Portion.
boolean	isAppContextNamePresent() Indicates if the Application Context Name parameter is present in this Event.
boolean	isConfidentialityInformationPresent() Indicates if the Confidentiality Information parameter is present in this Event.
boolean	isProtocolVersionPresent() Indicates if the Protocol Version parameter is present in this Event.
boolean	isSecurityContextInfoPresent() Indicates if the Security Context Information parameter is present in this Event.
boolean	isUserInformationPresent() Indicates if the User Information parameter is present in this Event.
void	setAppContextIdentifier(int appContextIdentifier) Sets the Application Context Identifier parameter of the Dialogue Portion.
void	setAppContextName(byte[] appContextName) Sets the Application Context Name parameter of the Dialogue Portion.
void	setConfidentialityInformation(byte[] confidentialityInfo) Sets the Confidentiality Information parameter of the Dialogue Portion.
void	setProtocolVersion(int protocolVersion) Sets the Protocol Version parameter of the Dialogue Portion.
void	setSecurityContextIdentifier(int securityContextIdentifier) Sets the Security Context Identifier parameter of the Dialogue Portion.
void	setSecurityContextInfo(byte[] securityContextInformation) Sets the Security Context Information parameter of the Dialogue Portion.
void	setUserInformation(byte[] userInformation) Sets the User Information parameter of of this Dialogue Portion.
java.lang.String	toString() String representation of class DialoguePortion

Methods inherited from class java.lang.Object

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

Constructor Detail

DialoguePortion

public DialoguePortion()

Constructs a new DialoguePortion

Method Detail

setProtocolVersion

public void setProtocolVersion(int protocolVersion)

Sets the Protocol Version parameter of the Dialogue Portion. The protocol version is only specific to an ANSI 1996 implementation of the ANSI 1996 specification. A Begin or UNI Request event or the first backwards Continue or End event may optionally include a protocol version.

Parameters:

protocolVersion - This can only have he following value until futher releases of the ANSI TCAP Specification:

• DP_PROTOCOL_VERSION_ANSI_96

setAppContextIdentifier

public void setAppContextIdentifier(int appContextIdentifier)

Sets the Application Context Identifier parameter of the Dialogue Portion. This field is specific only to an ANSI 1996 implementation of the JAIN TCAP API, as ITU has only one value for the Application Context Tag. This field informs an application how to interpret the application context information within this object. This can have the following values:

• APPLICATION_CONTEXT_INTEGER
• APPLICATION_CONTEXT_OBJECT

Note to Developers:- The Application Context Identifier is defaulted to "APPLICATION_CONTEXT_INTEGER".

Parameters:

appContextIdentifier - The new Application Context Identifier

Since:

JAIN TCAP v1.1

setAppContextName

public void setAppContextName(byte[] appContextName)

Sets the Application Context Name parameter of the Dialogue Portion. The contents of the byte[] are not inspected by TCAP. A Begin, UNI or UserAbort Request event or the first backwards Continue or End event may optionally include an application context.

Parameters:

appContextName - The new Application Context Name value

setSecurityContextIdentifier

public void setSecurityContextIdentifier(int securityContextIdentifier)

Sets the Security Context Identifier parameter of the Dialogue Portion. This field informs an application how to interpret the Security context information within this object. This can have the following values:

• SECURITY_CONTEXT_INTEGER
• SECURITY_CONTEXT_OBJECT

Note to Developers- The Security Context Identifier is defaulted to "SECURITY_CONTEXT_INTEGER".

Parameters:

securityContextIdentifier - The new Security Context Identifier value

setSecurityContextInfo

public void setSecurityContextInfo(byte[] securityContextInformation)

Sets the Security Context Information parameter of the Dialogue Portion. The security context byte[] is not inspected by TCAP. The Security Context parameter is only used in an ANSI 1996 implementation of Jain Tcap.

Parameters:

securityContextInformation - The new Security Context Information

setConfidentialityInformation

public void setConfidentialityInformation(byte[] confidentialityInfo)

Sets the Confidentiality Information parameter of the Dialogue Portion. The Confidentiality parameter is only used in an ANSI 1996 implementation of Jain Tcap, the parameters byte[] is not inspected by TCAP.

Parameters:

confidentialityInfo - The new Confidentiality Information

setUserInformation

public void setUserInformation(byte[] userInformation)

Sets the User Information parameter of of this Dialogue Portion.

Parameters:

userInformation - The new User Information

isProtocolVersionPresent

public boolean isProtocolVersionPresent()

Indicates if the Protocol Version parameter is present in this Event. This method is only used by an ANSI 1996 implementation of the Jain Tcap Specification.

Returns:

true if Protocol Version has been set, false otherwise.

getProtocolVersion

public int getProtocolVersion()
                       throws ParameterNotSetException

Gets the Protocol Version parameter of the Dialogue Portion. The protocol version of the dialogue portion is only specific to an ANSI 1996 implementation of the Jain Tcap specification

Returns:

the Protocol Version of the Dialogue Portion. This can only have the following value until futher releases of the ANSI TCAP Specification:

• DP_PROTOCOL_VERSION_ANSI_96

Throws:

ParameterNotSetException - this exception is thrown if this parameter has not yet been set

getAppContextIdentifier

public int getAppContextIdentifier()

Gets the Application Context Identifier parameter of the Dialogue Portion. This field informs an ANSI 1996 application how to interpret the application context information within this object.

Note to developers :- Application Context Identifier does not have an isPresent method, and can be ignored if no application context is present.

Returns:

the Application Context Identifier of the Dialogue Portion. The Application Context Identifier is initialized to "APPLICATION_CONTEXT_INTEGER", therefore if not previously set this method will always return this value. An application should call the isAppContextNamePresent method before accessing the appContextIdentifier .

Since:

JAIN TCAP v1.1

isAppContextNamePresent

public boolean isAppContextNamePresent()

Indicates if the Application Context Name parameter is present in this Event.

Returns:

true if Application Context Name has been set, false otherwise.

getAppContextName

public byte[] getAppContextName()
                         throws ParameterNotSetException

Gets the Application Context Name parameter of the Dialogue Portion.

Returns:

the Application Context Name of the Dialogue Portion.

Throws:

ParameterNotSetException - this exception is thrown if this parameter has not yet been set

getSecurityContextIdentifier

public int getSecurityContextIdentifier()

Gets the Security Context Identifier parameter of the Dialogue Portion. This field informs an application how to interpret the Security context information within this object.

Note to developers :- Security Context Identifier does not have an isPresent method, as it can be ignored if no Security context is present.

Returns:

the Security Context Identifier of the Dialogue Portion. The Security Context Identifier is initialized to "SECURITY_CONTEXT_INTEGER", therefore if not previously set this method will always return this value. An application should call the isSecurityContextInfoPresent method before accessing the securityContextIdentifier .

Since:

JAIN TCAP v1.1

isSecurityContextInfoPresent

public boolean isSecurityContextInfoPresent()

Indicates if the Security Context Information parameter is present in this Event.

Returns:

true if Security Context Information has been set, false otherwise.

getSecurityContextInfo

public byte[] getSecurityContextInfo()
                              throws ParameterNotSetException

Gets the Security Context Information parameter of the Dialogue Portion. The Security Context parameter is only used in an ANSI 1996 implementation of Jain Tcap.

Returns:

the Security Context Information parameter of the Dialogue Portion

Throws:

ParameterNotSetException - this exception is thrown if this parameter has not yet been set

isConfidentialityInformationPresent

public boolean isConfidentialityInformationPresent()

Indicates if the Confidentiality Information parameter is present in this Event.

Returns:

true if Confidentiality Information has been set, false otherwise.

getConfidentialityInformation

public byte[] getConfidentialityInformation()
                                     throws ParameterNotSetException

Gets the Confidentiality Information parameter of the Dialogue Portion. The Confidentiality Information parameter is only used in an ANSI 1996 implementation of Jain Tcap.

Returns:

the Confidentiality Information of the Dialogue Portion.

Throws:

ParameterNotSetException - this exception is thrown if this parameter has not been set

isUserInformationPresent

public boolean isUserInformationPresent()

Indicates if the User Information parameter is present in this Event.

Returns:

true if User Information has been set, false otherwise.

getUserInformation

public byte[] getUserInformation()
                          throws ParameterNotSetException

Gets the User Information parameter of this Dialogue Portion. User Information is the information which can be exchanged between TCAP applications independently from the remote operation service.

Returns:

the User Information.

Throws:

ParameterNotSetException - this exception is thrown if this parameter has not yet been set

clearAllParameters

public void clearAllParameters()

Clears all previously set parameters .

toString

public java.lang.String toString()

String representation of class DialoguePortion

Overrides:

toString in class java.lang.Object

Returns:

String provides description of class DialoguePortion