org.mobicents.slee.resource.parlay.fw.application
Interface SABean

All Known Implementing Classes:

SABeanImpl

public interface SABean

This interface represents the framework application service agreement module. The application may use this class to identify which services it wishes to use and sign the corresponding service agreements.

Method Summary

void	addSABeanListener(SABeanListener listener) Adds an application listener to the bean.
void	cleanup() This method cleans up all internal object references with the exception of registered listeners which are the responsibility of the application.
void	fireTerminateServiceAgreement(org.mobicents.csapi.jr.slee.fw.TerminateServiceAgreementEvent e)
byte[]	generateDigitalSignature(java.lang.String text, java.lang.String serviceToken, java.lang.String signingAlgorithm) Called to genearte digital signature of service token and text received from framework
org.csapi.fw.fw_application.service_agreement.IpAppServiceAgreementManagement	getAppServiceAgreementManagement() Returns the AppServiceAgreementManagement interface.
org.csapi.fw.fw_application.service_agreement.IpServiceAgreementManagement	getServiceAgreementManagement() Returns the ServiceAgreementManagement interface.
java.lang.Object	getServiceAgreementMonitor() Returns an object that can be used as a monitor for signing service agreements.
TSMBean	getTSMBean() Returns the tsmBean.
void	initialise()
void	putServiceTokenSigningAlgorithm(java.lang.String serviceToken, java.lang.String signingAlgorithm)
void	removeSABeanListener(SABeanListener listener) Removes the registered application listener.
java.lang.String	removeSigningAlgorithm(java.lang.String serviceToken)
ServiceAndToken	selectAndSignServiceAgreement(java.lang.String serviceID, java.lang.String agreementText) This method selects a service and signs an agreement for it with the Parlay framework.
void	setIsAgreementSigned(boolean value) Called to indicate sign service agreement has been called by the framework.
void	setServiceAgreementManagement(org.csapi.fw.fw_application.service_agreement.IpServiceAgreementManagement serviceAgreement) Stores the ServiceAgreementManagement interface to be used by the bean.
void	terminateServiceAgreement(java.lang.String serviceToken, java.lang.String terminationText) This method terminates the service agreement between the client and the Parlay framework.
java.lang.String	toString() Defines a method used to provide the caller with a string representationof the class.
boolean	verifyDigitalSignature(java.lang.String text, java.lang.String serviceToken, java.lang.String signingAlgorithm, byte[] digitalSignature) Called to verify signature received from framework

Method Detail

initialise

void initialise()
                throws SABeanException

Throws:

SABeanException

toString

java.lang.String toString()

Defines a method used to provide the caller with a string representationof the class.

Overrides:

toString in class java.lang.Object

setServiceAgreementManagement

void setServiceAgreementManagement(org.csapi.fw.fw_application.service_agreement.IpServiceAgreementManagement serviceAgreement)

Stores the ServiceAgreementManagement interface to be used by the bean.

getServiceAgreementManagement

org.csapi.fw.fw_application.service_agreement.IpServiceAgreementManagement getServiceAgreementManagement()

Returns the ServiceAgreementManagement interface.

getAppServiceAgreementManagement

org.csapi.fw.fw_application.service_agreement.IpAppServiceAgreementManagement getAppServiceAgreementManagement()

Returns the AppServiceAgreementManagement interface.

addSABeanListener

void addSABeanListener(SABeanListener listener)

Adds an application listener to the bean.

removeSABeanListener

void removeSABeanListener(SABeanListener listener)

Removes the registered application listener.

terminateServiceAgreement

void terminateServiceAgreement(java.lang.String serviceToken,
                               java.lang.String terminationText)
                               throws SABeanException

This method terminates the service agreement between the client and the Parlay framework.

Throws:

SABeanException

selectAndSignServiceAgreement

ServiceAndToken selectAndSignServiceAgreement(java.lang.String serviceID,
                                              java.lang.String agreementText)
                                              throws SABeanException

This method selects a service and signs an agreement for it with the Parlay framework.

Throws:

SABeanException

getServiceAgreementMonitor

java.lang.Object getServiceAgreementMonitor()

Returns an object that can be used as a monitor for signing service agreements.

Returns:

the object reference.

removeSigningAlgorithm

java.lang.String removeSigningAlgorithm(java.lang.String serviceToken)

putServiceTokenSigningAlgorithm

void putServiceTokenSigningAlgorithm(java.lang.String serviceToken,
                                     java.lang.String signingAlgorithm)

setIsAgreementSigned

void setIsAgreementSigned(boolean value)

Called to indicate sign service agreement has been called by the framework.

Parameters:

value - true if it has been called.

verifyDigitalSignature

boolean verifyDigitalSignature(java.lang.String text,
                               java.lang.String serviceToken,
                               java.lang.String signingAlgorithm,
                               byte[] digitalSignature)

Called to verify signature received from framework

Returns:

boolean

generateDigitalSignature

byte[] generateDigitalSignature(java.lang.String text,
                                java.lang.String serviceToken,
                                java.lang.String signingAlgorithm)

Called to genearte digital signature of service token and text received from framework

Returns:

digitalSignature

cleanup

void cleanup()

This method cleans up all internal object references with the exception of registered listeners which are the responsibility of the application. The PCP uses this method when the object is no longer to be used.

getTSMBean

TSMBean getTSMBean()

Returns the tsmBean.

Returns:

TSMBean

fireTerminateServiceAgreement

void fireTerminateServiceAgreement(org.mobicents.csapi.jr.slee.fw.TerminateServiceAgreementEvent e)