Micro Focus Visual COBOL 3.0 for Eclipse (Windows) > General Reference > Java Artifacts > Micro Focus Resource Adapters > COBOL Resource Adapter > COBOL Connector Class Library > Package com.microfocus.cobol.connector.cci > Class CobolInteractionSpec

Class CobolInteractionSpec

An implementation class that holds properties for driving an Interaction with an EIS instance. Because this class is a Java Bean, it supports bound properties.

Restriction: This topic applies only when the Enterprise Server feature is enabled.

java.lang.Object

extended by com.microfocus.cobol.connector.cci.CobolInteractionSpec

All Implemented Interfaces

InteractionSpec, Serializable

Class Specifications

public class CobolInteractionSpec

extends Object

implements InteractionSpec, Serializable

See Also:

Serialized Form

Fields

Field Summary
protected int	argumentCount
protected Vector	arguments
protected int	authenticationMechanism
static int	CALLER_PRINCIPAL
protected Principal	callerPrincipal
protected PropertyChangeSupport	changes
protected int	executionTimeout
protected String	functionName
protected int	interactionVerb
protected String	password
protected String	realm
protected int	returnCode
static int	UNINITIALIZED
protected Vector	usages
static int	USE_USERPWD
protected String	userName

Fields inherited from interface javax.resource.cci.InteractionSpec
SYNC_RECEIVE, SYNC_SEND, SYNC_SEND_RECEIVE

Constructor Summary

CobolInteractionSpec(): Create a CobolInteractionSpec instance.

Methods

Method Summary
void	`addPropertyChangeListener(PropertyChangeListener l)` Add a property change listener.
Object	`getArgument(int index)` Get an argument.
int	`getArgumentCount()` Get argument count.
int	`getAuthenticationMechanism()` Get authentication mechanism.
Principal	`getCallerPrincipal()`
int	`getExecutionTimeout()` Get Execution timeout.
String	`getFunctionName()` Get the function name to be executed.
int	`getInteractionVerb()` Get the interaction verb
CobolInteractionSpecMetaData	`getMetaData()` Get CobolInteractionSpecMetaData.
String	`getPassword()` Get password.
String	`getRealm()` Get realm.
int	`getReturnCode()` Get return code.
int	`getUsage(int index)` Get a usage.
String	`getUserName()` Get user name.
void	`removePropertyChangeListener(PropertyChangeListener 1)` Remove a property change listener.
void	`setArgument(int index, int usage)` Set an argument to be held in an interaction spec.
void	`setArgument(int index, Object obj)` Set an argument to be held in an interaction spec.
void	`setArgument(int index, Object obj, int usage)` Set an argument to be held in an interaction spec.
void	`setArgumentCount(int argumentCount)` Set argument count.
void	`setAuthenticationMechanism(int am)` set authentication mechanism
void	`setCallerPrincipal(Principal principal)` Set caller principal.
void	`setFunctionName(String functionName)` Set the function name to be executed.
void	`setPassword(String password)` Set password.
void	`setRealm(String realm)` Set realm.
void	`setReturnCode(int returnCode)` Set return code.
void	`setUserName( String userName)` Set user name.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

functionName

protected String functionName

interactionVerb

protected int  interactionVerb

executionTimeout

protected int executionTimeout

returnCode

protected int returnCode

argumentCount

protected int argumentCount

arguments

protected Vector arguments

usages

protected Vector usages

userName

protected String userName

password

protected String password

realm

protected String realm

authenticationMechanism

protected int authenticationMechanism

changes

protected PropertyChangeSupport changes

callerPrincipal

protected Principal callerPrincipal

USE_USERPWD

public static final int USE_USERPWD

See Also:

Constant Field Values

UNINITIALIZED

public static final int UNINITIALIZED

See Also:

Constant Field Values

CALLER_PRINCIPAL

public static final int CALLER_PRINCIPAL

See Also:

Constant Field Values

Constructor Detail

CobolInteractionSpec

public CobolInteractionSpec()

Construct a new CobolInteractionSpec instance.

Method Detail

getFunctionName

public String getFunctionName()

Get the function name to be executed.

Returns:: The function name.

setFunctionName

public void setFunctionName(String functionName)

Set the function name to be executed.

Parameters:

functionName

The function name.

getInteractionVerb

public int getInteractionVerb()

Get the interaction verb.

Returns:: The interaction verb. Only SYNC_SEND_RECEIVE is supported.

getExecutionTimeout

public int getExecutionTimeout()

Get the execution timeout.

Returns:: The execution timeout.

setReturnCode

public void setReturnCode(int returnCode)

Set the return code.

Parameters:

returnCode

The return code from COBOL Server.

getReturnCode

public int getReturnCode()

Get the return code.

Returns:: The return code from COBOL Server.

setArgument

public void setArgument(int, index
                        Object obj)

Set an argument to be held in an interaction spec.

Parameters:

`index`	The argument index.
`obj`	The actual object.

setArgument

public void setArgument(int, index
                        Object obj
                        int usage)

Set an argument to be held in an interaction spec.

Parameters:

`index`	The argument index.
`obj`	The actual object.
`usage`	The usage for the argument.

setArgument

public void setArgument(int, index
                        int usage)

Set an argument to be held in an interaction spec.

Parameters:

`index`	The argument index.
`usage`	The usage for the argument.

getArgument

public Object getArgument(int, index)

Get an argument.

Parameters:

index

The argument index.

Returns:

The actual argument.

getUsage

public int getUsage(int, index)

Get a usage.

Parameters:

index

The argument index.

Returns:

The usage.

getArgumentCount

public int getArgumentCount()

Get the argument count.

Returns:: The argument count.

setArgumentCount

public void setArgumentCount(int argumentCount)

Set the argument count.

Parameters:

argumentCount

The argument count.

setUserName

public void setUserName(String userName)

Set the user name.

Parameters:

userName

The user name.

setPassword

public void setPassword(String password)

Set the password.

Parameters:

password

The password.

setRealm

public void setRealm(String realm)

Set the realm.

Parameters:

realm

The realm.

getUserName

public String getUserName()

Get the user name.

Returns:: The user name.

getPassword

public String getPassword()

Get the password.

Returns:: The password.

getRealm

public String getRealm()

Get the realm.

Returns:: The realm.

getAuthenticationMechanism

public int getAuthenticationMechanism()

Get the authentication mechanism.

Returns:: The authentication mechanism. Possible values are UNINITIALIZED USE_USERPWD.

setAuthenticationMechanism

public void setAuthenticationMechanism(int am)

Set the authentication mechanism.

Parameters:

`am`	The authentication mechanism. UNINITIALIZED USE_USERPWD CALLER_PRINCIPAL

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener 1)

Add a property change listener.

Parameters:

`1`	The listener instance.

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener 1)

Remove a property change listener.

Parameters:

`1`	The listener instance.

getMetaData

public CobolInteractionSpecMetaData getMetaData()

Get CobolInteractionSpecMetaData.

Returns:: CobolInteractionSpecMetaData instance.

setCallerPrincipal

public void setCallerPrincipal(Principal principal)

Set caller principal.

getCallerPrincipal

public void getCallerPrincipal(Principal principal)

Get caller principal.