org.mobicents.slee.resource.parlay.fw.access
Interface TSMBean

All Known Implementing Classes:

TSMBeanImpl

public interface TSMBean

* This interface represents the trust and security management Framework services.
It is used by clients to perform its part of the mutual authentication process with the Framework necessary to be allowed to use any of the other interfaces supported by the Framework. It can then be used to access the other interfaces. This is a higher level bean which encompasses all of the interfaces within the Parlay trust_and_security module.

Method Summary

void	addTSMBeanListener(TSMBeanListener listener) Adds application listener to the bean.
void	authenticate() This method authenticates a client with the Parlay Framework.
void	cleanup() This method will clean up all internal object references with the exception of registered listeners which are the responsibility of the application.
SABean	createSABean() Creates an instance of the ServiceAgreementManagementBean.
void	destroySABean() This method releases an instance of the ServiceAgreementManagementBean.
void	endAccess(org.csapi.fw.TpProperty[] endAccessProperties) This method ends a client's access session with the Parlay Framework.
boolean	equals(java.lang.Object obj) Indicated if an other object is equal to this one.
void	fireTerminateAccess(org.mobicents.csapi.jr.slee.fw.TerminateAccessEvent e) Method fireTerminateAccess.
java.lang.Object	getAuthenticationMonitor() Returns an object that can be used as a monitor for authentication.
java.lang.String	getClientDomain(org.csapi.fw.TpDomainID domainID) Retrieves the client domain ID to be used for checking the HA database.
org.csapi.fw.TpDomainID	getClientDomainID() Returns the client domain ID to be used for authentication.
java.lang.String	getClientID() Returns the client ID (without type) to be used for authentication.
java.lang.String	getEncryptionMethod() Returns the encryption method chosen by the framework during the authentication sequence.
EDU.oswego.cs.dl.util.concurrent.Executor	getEventsQueue() Returns the Executor of events.
FwSessionProperties	getFwProperties()
org.csapi.fw.fw_access.trust_and_security.IpInitial	getInitial() Returns the Initial object used by this bean.
ORBHandler	getOrbHandler()
SABean	getSABean() Returns a previously created instance of the ServiceAgreementManagementBean
int	getState() Returns the current state of this bean
int	hashCode() Returns a hash code value for the object.
void	initialize() This method must be called before attempting to make an Parlay requests via this object.
org.csapi.fw.fw_application.discovery.IpServiceDiscovery	obtainDiscoveryInterface() Returns an instance of the ServiceDiscovery interface.
void	releaseDiscoveryInterface() Releases an instance of the ServiceDiscovery interface.
void	removeTSMBeanListener(TSMBeanListener listener) Removes registered application listener.
void	setClientDomainID(org.csapi.fw.TpDomainID id) Stores the client domain id to be used for authentication.
void	setFwAuthenticationSucceeded(boolean value) Called to indicate to this bean that the framework has indicated successful authentication.
void	setFwProperties(FwSessionProperties properties)
void	shutdown() This method must be called when an application has no more use for this object to ensure a graceful shutdown.
java.lang.String	toString() Defines a method used to provide the caller with a String represenation of the class.

Method Detail

addTSMBeanListener

void addTSMBeanListener(TSMBeanListener listener)

Adds application listener to the bean.

removeTSMBeanListener

void removeTSMBeanListener(TSMBeanListener listener)

Removes registered application listener.

authenticate

void authenticate()
                  throws TSMBeanException

This method authenticates a client with the Parlay Framework.

Throws:

TSMBeanException

createSABean

SABean createSABean()
                    throws TSMBeanException

Creates an instance of the ServiceAgreementManagementBean.

Throws:

TSMBeanException

destroySABean

void destroySABean()
                   throws TSMBeanException

This method releases an instance of the ServiceAgreementManagementBean.

Throws:

TSMBeanException

endAccess

void endAccess(org.csapi.fw.TpProperty[] endAccessProperties)
               throws TSMBeanException

This method ends a client's access session with the Parlay Framework.

Throws:

TSMBeanException

equals

boolean equals(java.lang.Object obj)

Indicated if an other object is equal to this one.

Overrides:

equals in class java.lang.Object

getClientDomain

java.lang.String getClientDomain(org.csapi.fw.TpDomainID domainID)

Retrieves the client domain ID to be used for checking the HA database.

getClientDomainID

org.csapi.fw.TpDomainID getClientDomainID()

Returns the client domain ID to be used for authentication.

getClientID

java.lang.String getClientID()

Returns the client ID (without type) to be used for authentication.

getEncryptionMethod

java.lang.String getEncryptionMethod()

Returns the encryption method chosen by the framework during the authentication sequence.

getEventsQueue

EDU.oswego.cs.dl.util.concurrent.Executor getEventsQueue()

Returns the Executor of events.

getSABean

SABean getSABean()

Returns a previously created instance of the ServiceAgreementManagementBean

getState

int getState()

Returns the current state of this bean

hashCode

int hashCode()

Returns a hash code value for the object.

Overrides:

hashCode in class java.lang.Object

initialize

void initialize()
                throws TSMBeanException

This method must be called before attempting to make an Parlay requests via this object.

Throws:

TSMBeanException

obtainDiscoveryInterface

org.csapi.fw.fw_application.discovery.IpServiceDiscovery obtainDiscoveryInterface()
                                                                                  throws TSMBeanException

Returns an instance of the ServiceDiscovery interface.

Throws:

TSMBeanException

releaseDiscoveryInterface

void releaseDiscoveryInterface()
                               throws TSMBeanException

Releases an instance of the ServiceDiscovery interface.

Throws:

TSMBeanException

setClientDomainID

void setClientDomainID(org.csapi.fw.TpDomainID id)

Stores the client domain id to be used for authentication.

shutdown

void shutdown()

This method must be called when an application has no more use for this object to ensure a graceful shutdown.

toString

java.lang.String toString()

Defines a method used to provide the caller with a String represenation of the class.

Overrides:

toString in class java.lang.Object

getInitial

org.csapi.fw.fw_access.trust_and_security.IpInitial getInitial()

Returns the Initial object used by this bean.

Returns:

the object reference.

cleanup

void cleanup()

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

getAuthenticationMonitor

java.lang.Object getAuthenticationMonitor()

Returns an object that can be used as a monitor for authentication.

Returns:

the object reference.

setFwAuthenticationSucceeded

void setFwAuthenticationSucceeded(boolean value)

Called to indicate to this bean that the framework has indicated successful authentication.

Parameters:

value - true if it successful.

fireTerminateAccess

void fireTerminateAccess(org.mobicents.csapi.jr.slee.fw.TerminateAccessEvent e)

Method fireTerminateAccess.

Parameters:

e -

getFwProperties

FwSessionProperties getFwProperties()

Returns:

The framework specific properties.

setFwProperties

void setFwProperties(FwSessionProperties properties)

Parameters:

properties -

getOrbHandler

ORBHandler getOrbHandler()

Returns:

the ORBHandler for this TSM session.