at.spardat.xma.boot.component
Interface IRtXMASessionClient


public interface IRtXMASessionClient

This is the interface used by the boot runtime to communicate with an application-session of the runtime.


Method Summary
 AppContainer getAppContainer()
          get the application container object, that holds information about this application
 java.lang.String getId()
          Gets the id of the session; with http-comunication this is the session cookie.
 byte[] inverseTransform(java.lang.String transform, byte[] data)
          Reverse the transformations, e.g. compression, applied at the server.
 boolean login()
          Deprecated.  
 boolean login(java.util.Properties properties)
          Login method for runtime version 1.7.0 and newer.
 void logout()
          The boot runtime calls logout after the last component is closed and the application will be deleted.
 void setId(java.lang.String id)
          Sets the id of the session; with http-comunication this is the session cookie.
 

Method Detail

login

public boolean login()
Deprecated.  

Login method for runtime versions befor 1.7.0 The boot runtime will call login for each application on startup.

Returns:
boolean returns false if the login has failed

login

public boolean login(java.util.Properties properties)
Login method for runtime version 1.7.0 and newer. The boot runtime will call login for each application on startup.

Parameters:
properties - All properties send to the first component. The LoginModule can be parametrized by them.
Returns:
boolean returns false if the login has failed

logout

public void logout()
The boot runtime calls logout after the last component is closed and the application will be deleted.


getAppContainer

public AppContainer getAppContainer()
get the application container object, that holds information about this application

Returns:
AppContainer

getId

public java.lang.String getId()
Gets the id of the session; with http-comunication this is the session cookie.

Returns:
the id of the session

setId

public void setId(java.lang.String id)
Sets the id of the session; with http-comunication this is the session cookie. This method must only be called by the runtime!

Parameters:
id - the new session id.

inverseTransform

public byte[] inverseTransform(java.lang.String transform,
                               byte[] data)
Reverse the transformations, e.g. compression, applied at the server.

Parameters:
transform - string encoded names of transformations applied at the server
data - original data
Returns:
result of the inverse transformations applied on the data