com.microfocus.cobol.connector.transport
Class CobolConnection

java.lang.Object
  extended bycom.microfocus.cobol.connector.transport.CobolConnection
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
BINPCall, InProcCall, TimerTransport, com.microfocus.cobol.connector.transport.TraceTransport
public abstract class CobolConnection
extends Object
implements Serializable

Abstract CobolConnection interface

Copyright: Copyright (c) 2002-2003 Company: Micro Focus International Ltd

See Also:
Serialized Form

Field Summary
static int OPTYPE_CANCEL
           
static int OPTYPE_COBCALL
           
static int OPTYPE_COBLOAD
           
static int OPTYPE_DISPOSE
           
static int OPTYPE_PING
           
static int OPTYPE_SETISINITIAL
           
static int OPTYPE_TRAN_LOCAL_COMMIT
           
static int OPTYPE_TRAN_LOCAL_ROLLBACK
           
static int OPTYPE_TRAN_LOCAL_START
           
static int OPTYPE_TRAN_XA_COMMIT
           
static int OPTYPE_TRAN_XA_END
           
static int OPTYPE_TRAN_XA_FORGET
           
static int OPTYPE_TRAN_XA_PREPARE
           
static int OPTYPE_TRAN_XA_RECOVER
           
static int OPTYPE_TRAN_XA_ROLLBACK
           
static int OPTYPE_TRAN_XA_START
           
 
Constructor Summary
CobolConnection()
           
 
Method Summary
abstract  void Activate()
          Activate a connection.
 void begin()
          begin a transaction
 void commit()
          Commit a transaction
 void connect()
          Make a logical connection to the server.
static CobolConnection createConnection(String serviceName)
          Create a CobolConnection for a specific serviceName and connectionID
 void disconnect()
          Logically disconnection.
abstract  Object execute(int operation, String className, String programName, Class retCodeType, Object inParameters, Object outParameters)
          Execute a operation on the server.
 Object getConnectionProperty(String key2property)
          gets a connection property
 Object getConnectionProperty(String key2property, Object defaultProperty)
          get a connection property or return a default property
 String getServerURN()
          getServerURN() for this CobolConnection
 String getSessionID()
          getSessionID() for this CobolConnection
abstract  boolean isActive()
          is a CobolConnection active? (method should be overridden)
abstract  void Passivate()
          Passivate a connection.
abstract  void reconnect()
          Reconnect transport layer
static void registerConnectionHandler(String name, Object handler)
          register a connection handler
 void removeConnectionProperty(String key2property)
          Remove a connection property
 void rollback()
          Rollback a transaction
 void setConnectionProperty(String key2property, Object property)
          sets a named property to the connection e.g: username password
 void xa_commit()
          Method declaration
 void xa_commit(Xid xid, boolean onePhase)
          xa_commit method
 void xa_end()
          Method declaration
 void xa_end(Xid xid, int flags)
          Method declaration
 void xa_forget()
          Method declaration
 void xa_forget(Xid xid)
          Method declaration
 void xa_prepare()
          Method declaration
 void xa_recover()
          Method declaration
 void xa_recover(int flags)
          Method declaration
 void xa_rollback()
          Method declaration
 void xa_rollback(Xid xid)
          Method declaration
 void xa_start()
          Method declaration
 void xa_start(Xid xid)
          start a xa transaction
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

OPTYPE_PING

public static final int OPTYPE_PING
See Also:
Constant Field Values

OPTYPE_COBCALL

public static final int OPTYPE_COBCALL
See Also:
Constant Field Values

OPTYPE_COBLOAD

public static final int OPTYPE_COBLOAD
See Also:
Constant Field Values

OPTYPE_DISPOSE

public static final int OPTYPE_DISPOSE
See Also:
Constant Field Values

OPTYPE_CANCEL

public static final int OPTYPE_CANCEL
See Also:
Constant Field Values

OPTYPE_SETISINITIAL

public static final int OPTYPE_SETISINITIAL
See Also:
Constant Field Values

OPTYPE_TRAN_LOCAL_START

public static final int OPTYPE_TRAN_LOCAL_START
See Also:
Constant Field Values

OPTYPE_TRAN_LOCAL_ROLLBACK

public static final int OPTYPE_TRAN_LOCAL_ROLLBACK
See Also:
Constant Field Values

OPTYPE_TRAN_LOCAL_COMMIT

public static final int OPTYPE_TRAN_LOCAL_COMMIT
See Also:
Constant Field Values

OPTYPE_TRAN_XA_PREPARE

public static final int OPTYPE_TRAN_XA_PREPARE
See Also:
Constant Field Values

OPTYPE_TRAN_XA_COMMIT

public static final int OPTYPE_TRAN_XA_COMMIT
See Also:
Constant Field Values

OPTYPE_TRAN_XA_ROLLBACK

public static final int OPTYPE_TRAN_XA_ROLLBACK
See Also:
Constant Field Values

OPTYPE_TRAN_XA_END

public static final int OPTYPE_TRAN_XA_END
See Also:
Constant Field Values

OPTYPE_TRAN_XA_FORGET

public static final int OPTYPE_TRAN_XA_FORGET
See Also:
Constant Field Values

OPTYPE_TRAN_XA_RECOVER

public static final int OPTYPE_TRAN_XA_RECOVER
See Also:
Constant Field Values

OPTYPE_TRAN_XA_START

public static final int OPTYPE_TRAN_XA_START
See Also:
Constant Field Values
Constructor Detail

CobolConnection

public CobolConnection()
Method Detail

getServerURN

public final String getServerURN()
getServerURN() for this CobolConnection

Returns:
String

getSessionID

public final String getSessionID()
getSessionID() for this CobolConnection

Returns:
String

createConnection

public static final CobolConnection createConnection(String serviceName)
                                              throws com.microfocus.cobol.CobolException
Create a CobolConnection for a specific serviceName and connectionID

Parameters:
serviceName -
Returns:
CobolConnection
Throws:
com.microfocus.cobol.CobolException

connect

public void connect()
             throws com.microfocus.cobol.CobolException
Make a logical connection to the server. The physical connection occurs when you do a execute/isActive method.

Throws:
com.microfocus.cobol.CobolException

disconnect

public void disconnect()
                throws com.microfocus.cobol.CobolException
Logically disconnection. No interaction with the server is performed.

Throws:
com.microfocus.cobol.CobolException

reconnect

public abstract void reconnect()
                        throws com.microfocus.cobol.CobolException
Reconnect transport layer

Throws:
com.microfocus.cobol.CobolException

execute

public abstract Object execute(int operation,
                               String className,
                               String programName,
                               Class retCodeType,
                               Object inParameters,
                               Object outParameters)
                        throws com.microfocus.cobol.CobolException,
                               Exception
Execute a operation on the server.

Parameters:
operation -
className -
programName -
retCodeType -
inParameters -
outParameters -
Returns:
return-code
Throws:
com.microfocus.cobol.CobolException
Exception

isActive

public abstract boolean isActive()
                          throws com.microfocus.cobol.CobolException
is a CobolConnection active? (method should be overridden)

Returns:
a boolean
Throws:
com.microfocus.cobol.CobolException

begin

public void begin()
           throws com.microfocus.cobol.CobolException
begin a transaction

Throws:
com.microfocus.cobol.CobolException

xa_start

public void xa_start(Xid xid)
              throws com.microfocus.cobol.CobolException
start a xa transaction

Parameters:
xid - a j2ee xid
Throws:
com.microfocus.cobol.CobolException

xa_start

public void xa_start()
              throws com.microfocus.cobol.CobolException
Method declaration

Throws:
com.microfocus.cobol.CobolException

xa_commit

public void xa_commit(Xid xid,
                      boolean onePhase)
               throws com.microfocus.cobol.CobolException
xa_commit method

Parameters:
xid -
onePhase -
Throws:
com.microfocus.cobol.CobolException

xa_commit

public void xa_commit()
               throws com.microfocus.cobol.CobolException
Method declaration

Throws:
com.microfocus.cobol.CobolException

xa_end

public void xa_end(Xid xid,
                   int flags)
            throws com.microfocus.cobol.CobolException
Method declaration

Parameters:
xid -
flags -
Throws:
com.microfocus.cobol.CobolException

xa_end

public void xa_end()
            throws com.microfocus.cobol.CobolException
Method declaration

Throws:
com.microfocus.cobol.CobolException

xa_forget

public void xa_forget(Xid xid)
               throws com.microfocus.cobol.CobolException
Method declaration

Parameters:
xid -
Throws:
com.microfocus.cobol.CobolException

xa_forget

public void xa_forget()
               throws com.microfocus.cobol.CobolException
Method declaration

Throws:
com.microfocus.cobol.CobolException

xa_prepare

public void xa_prepare()
                throws com.microfocus.cobol.CobolException
Method declaration

Throws:
com.microfocus.cobol.CobolException

xa_recover

public void xa_recover(int flags)
                throws com.microfocus.cobol.CobolException
Method declaration

Parameters:
flags -
Throws:
com.microfocus.cobol.CobolException

xa_recover

public void xa_recover()
                throws com.microfocus.cobol.CobolException
Method declaration

Throws:
com.microfocus.cobol.CobolException

xa_rollback

public void xa_rollback(Xid xid)
                 throws com.microfocus.cobol.CobolException
Method declaration

Parameters:
xid -
Throws:
com.microfocus.cobol.CobolException

xa_rollback

public void xa_rollback()
                 throws com.microfocus.cobol.CobolException
Method declaration

Throws:
com.microfocus.cobol.CobolException

commit

public void commit()
            throws com.microfocus.cobol.CobolException
Commit a transaction

Throws:
com.microfocus.cobol.CobolException

rollback

public void rollback()
              throws com.microfocus.cobol.CobolException
Rollback a transaction

Throws:
com.microfocus.cobol.CobolException

registerConnectionHandler

public static final void registerConnectionHandler(String name,
                                                   Object handler)
register a connection handler

Parameters:
name -
handler -

setConnectionProperty

public void setConnectionProperty(String key2property,
                                  Object property)
sets a named property to the connection e.g: username password

Parameters:
key2property -
property -

getConnectionProperty

public Object getConnectionProperty(String key2property)
gets a connection property

Parameters:
key2property -
Returns:
a object or null

removeConnectionProperty

public void removeConnectionProperty(String key2property)
Remove a connection property

Parameters:
key2property -

getConnectionProperty

public Object getConnectionProperty(String key2property,
                                    Object defaultProperty)
get a connection property or return a default property

Parameters:
key2property -
defaultProperty -
Returns:
a object or defaultProperty

Activate

public abstract void Activate()
                       throws com.microfocus.cobol.CobolException
Activate a connection.

Throws:
com.microfocus.cobol.CobolException

Passivate

public abstract void Passivate()
                        throws com.microfocus.cobol.CobolException
Passivate a connection.

Throws:
com.microfocus.cobol.CobolException

Copyright © 2000 Micro Focus International Limited. All rights reserved.
This document and the proprietary marks and names used herein are protected by international law.