com.sap.mw.jco
Interface IMiddleware.IClient

Enclosing class:

IMiddleware

public static interface IMiddleware.IClient

Middleware methods needed to implement a client

Method Summary

void	abort(JCO.Client client, java.lang.String message) Closes a connection and tries to send a final message to the caller
void	confirmTID(JCO.Client client, java.lang.String tid) Method that actually confirms a transaction
void	connect(JCO.Client client, java.lang.String params) Opens a client connection
java.lang.String	createTID(JCO.Client client) Method that creates a transaction ID
void	disconnect(JCO.Client client) Closes a connection
void	execute(JCO.Client client, java.lang.String name, JCO.ParameterList imp, JCO.ParameterList imptab, JCO.ParameterList exp, JCO.ParameterList exptab, java.lang.String tid, java.lang.String qname, int qcount) Executes a function on the server
void	getAttributes(JCO.Client client) Method that actually retrieves the attributes of a connection.
java.lang.String[][]	getPropertyInfo() Returns information about the properties which are understood by the client implementation.
void	initialize(JCO.Client client, java.util.Properties params) Called to initialize the client just after its creation.
boolean	isAlive(JCO.Client client) Checks whether the connection is alive
void	reset(JCO.Client client) Method to reset a connection

Method Detail

getPropertyInfo

public java.lang.String[][] getPropertyInfo()

Returns information about the properties which are understood by the client implementation. Each element of the array should be a set of two Strings containg the name and description of a property. For example

  String pinfo[][] = {
     { "jco.client.user",     "Logon user name" },
     { "jco.client.password", "Logon password"  },
     { "jco.client.language", "Logon language"  },
  };
  

initialize

public void initialize(JCO.Client client,
                       java.util.Properties params)

Called to initialize the client just after its creation. This routine has to parse the properties and must set the conn_param field in the client.

Parameters:

client - the client that calls the method

params - connection parameters as property list

connect

public void connect(JCO.Client client,
                    java.lang.String params)

Opens a client connection

Parameters:

client - the client that calls the method

params - implementation dependent arguments which specify the connection

disconnect

public void disconnect(JCO.Client client)

Closes a connection

Parameters:

client - the client that calls the method

abort

public void abort(JCO.Client client,
                  java.lang.String message)

Closes a connection and tries to send a final message to the caller

Parameters:

client - the client that calls the method

message - the messages to send to the partner before closing the connection

reset

public void reset(JCO.Client client)

Method to reset a connection

Parameters:

client - the client that calls the method

isAlive

public boolean isAlive(JCO.Client client)

Checks whether the connection is alive

Parameters:

client - the client that calls the method

Returns:

true if the connection is alive, false otherwise

getAttributes

public void getAttributes(JCO.Client client)

Method that actually retrieves the attributes of a connection. An implementation has to set the attributes variable in the client object.

Parameters:

client - the client that calls the method

execute

public void execute(JCO.Client client,
                    java.lang.String name,
                    JCO.ParameterList imp,
                    JCO.ParameterList imptab,
                    JCO.ParameterList exp,
                    JCO.ParameterList exptab,
                    java.lang.String tid,
                    java.lang.String qname,
                    int qcount)

Executes a function on the server

Parameters:

client - the client that calls the method

confirmTID

public void confirmTID(JCO.Client client,
                       java.lang.String tid)

Method that actually confirms a transaction

Parameters:

client - the client that calls the method

tid - the transaction ID to confirm

createTID

public java.lang.String createTID(JCO.Client client)

Method that creates a transaction ID

Parameters:

client - the client that calls the method

Returns:

tid the newly created TID