org.mobicents.slee.resource.parlay.fw
Interface FwSession

All Known Implementing Classes:

BypassedFwSession, FwSessionImpl

public interface FwSession

Forms the API for the Provider to the Parlay Framework. The implementation of this class will abstract all detailed framework interactions from the core RA implementation.

Method Summary

void	addFwSessionListener(FwSessionListener listener) Adds an application listener.
void	authenticate() This method authenticates a client with the Parlay framework.
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) Indicates if another object is equal to this one.
FwSessionProperties	getFwSessionProperties()
org.omg.CORBA.ORB	getORB() Returns a reference to the ORB used by this FwSession.
org.omg.PortableServer.POA	getRootPOA() Returns the root poa
ServiceAndToken	getService(java.lang.String serviceTypeName, org.csapi.fw.TpServiceProperty[] serviceProperties) Returns a reference to a Service interface.
int	hashCode() Returns a hash code value for the object
void	init() Initialises FwSession, only use when created with default constructor.
void	releaseService(ServiceAndToken service) Releses the specified Service.
void	removeFwSessionListener(FwSessionListener listener) Removes an application listener.
void	shutdown() This method will shutdown all resources used by this object.
java.lang.String	toString() Defines a method used to provide the caller with a string representationof the class.

Method Detail

init

void init()
          throws FwSessionException

Initialises FwSession, only use when created with default constructor.

Throws:

FwSessionException

addFwSessionListener

void addFwSessionListener(FwSessionListener listener)

Adds an application listener.

removeFwSessionListener

void removeFwSessionListener(FwSessionListener listener)

Removes an application listener.

authenticate

void authenticate()
                  throws FwSessionException

This method authenticates a client with the Parlay framework.

Throws:

FwSessionException

endAccess

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

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

Parameters:

endAccessProperties - properties to be passed to gateway framework on endAccess.

Throws:

FwSessionException

equals

boolean equals(java.lang.Object obj)

Indicates if another object is equal to this one.

Overrides:

equals in class java.lang.Object

hashCode

int hashCode()

Returns a hash code value for the object

Overrides:

hashCode in class java.lang.Object

releaseService

void releaseService(ServiceAndToken service)
                    throws FwSessionException

Releses the specified Service.

Throws:

FwSessionException

getService

ServiceAndToken getService(java.lang.String serviceTypeName,
                           org.csapi.fw.TpServiceProperty[] serviceProperties)
                           throws FwSessionException

Returns a reference to a Service interface.

Parameters:

serviceTypeName -

serviceProperties -

Returns:

a service and token for the selected service

Throws:

FwSessionException

shutdown

void shutdown()

This method will shutdown all resources used by this object.

getORB

org.omg.CORBA.ORB getORB()

Returns a reference to the ORB used by this FwSession.

Returns:

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

getFwSessionProperties

FwSessionProperties getFwSessionProperties()

Returns:

getRootPOA

org.omg.PortableServer.POA getRootPOA()

Returns the root poa

Returns: