Class CobolResourceAdapter

This represents a resource adapter instance and contains operations for lifecycle management and message endpoint setup.
Restriction: This topic applies only when the Enterprise Server feature is enabled.
java.lang.Object

extended by com.microfocus.cobol.connector.spi.CobolResourceAdapter

All Implemented Interfaces

ResourceAdapter, Serializable

Class Specifications

public class CobolResourceAdapter

extends Object

implements ResourceAdapter, Serializable

See Also:

Serialized Form

Field Summary

Constructor Summary

CobolResourceAdapter()
Constructor.

Methods

Method Summary
void start(BootstrapContext ctx)
stop stop()
void endpointActivation(MessageEndpointFactory endpointFactory, ActivationSpec spec)

Called by the Application Server when a message-driven bean (MessageEndpoint) is deployed. Causes the resource adapter instance to do the necessary setup (setting up message delivery for the message endpoint with a message provider).

void endpointDeactivation(MessageEndpointFactory endpointFactory, ActivationSpec spec)

Called by Application Server when the MessageEndpoint (message-driven bean) is undeployed. The instance passed as arguments to this method call should be identical to that passed in for the corresponding endpointActivation call. This causes the resource adapter to stop delivering messages to the message endpoint.

XAResource[] getXAResources(ActivationSpec[] specs)

This method is called by the application server during crash recovery. This method takes in an array of ActivationSpec JavaBeans and returns an array of XAResource objects each of which represents a unique resource manager. The resource adapter may return null if it does not implement the XAResource interface. Otherwise, it must return an array of XAResource objects, each of which represents a unique resource manager that was used by the endpoint applications. The application server uses the XAResource objects to query each resource manager for a list of in-doubt transactions. It then completes each pending transaction by sending the commit decision to the participating resource managers.

void setServerHost(String serverHost)

Set the server host.

String getServerHost()

Get the server host.

void setServerPort(String serverPort)

Set the server port.

String getServerPort()

Get the server port.

void setLogHost(String logHost)

Set the log host.

String getLogHost()

Get the log host.

void setLogPort(String logPort)

Set the log port.

String getLogPort()

Get the log port.

void setTrace(Boolean trace)

Set tracing.

Boolean getTrace()

Check if tracing is enabled.

void setSecureGUID(Boolean s)

Set secure GUID.

Boolean getSecureGUID()

Get secure GUID

void setReadTimeoutInSeconds(Integer readTimeoutInSeconds)

Set ReadTimeoutInSeconds

Integer getReadTimeoutInSeconds()

Get ReadTimeoutInSeconds

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

Field Detail

serverHost
protected String serverHost
serverPort
protected String serverPort
logHost
protected String logHost
logPort
protected String logPort
trace
protected Boolean trace
secureGUID
protected Boolean secureGUID
readTimeoutInSeconds
protected Integer readTimeoutInSeconds

Constructor Detail

CobolResourceAdapter
public CobolResourceAdapter

Constructor.

Method Detail

start
public void start(BootstrapContext ctx)
                        throws ResourceAdapterInternalException

Called by the AppServer to initialize the Resource Adapter.

Specified by:
start in interface ResourceAdapter
Parameters:
ctx The bootstrapContext.
Throws:
ResourceAdapterInternalException
stop
public void stop()
Specified by:
stop in interface ResourceAdapter
endPointActivation
public void endPointActivation(MessageEndpointFactory endpointFactory,
                               ActivationSpec spec)
                        throws NotSupportedException

Called by the Application Server when a message-driven bean (MessageEndpoint) is deployed. Causes the resource adapter instance to do the necessary setup (setting up message delivery for the message endpoint with a message provider).

Specified by:
endpointActivation in interface ResourceAdapter
Parameters:
endpointFactory A message endpoint factory instance.
spec An ActivationSpec instance.
Throws:
NotSupportedException
endpointDeactivation
public void endPointDeactivation(MessageEndpointFactory endpointFactory,
                                 ActivationSpec spec)

Called by Application Server when the MessageEndpoint (message-driven bean) is undeployed. The instance passed as arguments to this method call should be identical to that passed in for the corresponding endpointActivation call. This causes the resource adapter to stop delivering messages to the message endpoint.

Specified by:
getXAResources in interface ResourceAdapter
Parameters:
endpointFactory A message endpoint factory instance.
specs An ActivationSpec instance.
getXAResources
public XAResource[] getXAResources(ActivationSpec[] specs)
                                  throws ResourceException

This method is called by the application server during crash recovery. This method takes in an array of ActivationSpec JavaBeans and returns an array of XAResource objects each of which represents a unique resource manager. The resource adapter may return null if it does not implement the XAResource interface. Otherwise, it must return an array of XAResource objects, each of which represents a unique resource manager that was used by the endpoint applications. The application server uses the XAResource objects to query each resource manager for a list of in-doubt transactions. It then completes each pending transaction by sending the commit decision to the participating resource managers.

Specified by:
matchManagedConnections in interface ManagedConnectionFactory
Parameters:
specs An array of ActivationSpec JavaBeans each of which corresponds to an deployed endpoint application that was active prior to the system crash.
Returns:
An array of XAResource objects each of which represents a unique resource manager.
Throws:
ResourceException
setServerHost
public void setServerHost (String serverHost)

Set the server host.

Parameters:
serverHost
getServerHost
public String getServerHost()

Get the server host.

Returns:
The server host.
setServerPort
public void setServerPort(String serverPort)

Set the server port.

Parameters:
serverPort
getServerPort
public String getServerPort()

Get the server port.

Returns:
The server port.
setLogHost
public void setLogHost(String logHost)

Set the log host.

Parameters:
logHost
getLogHost
public String getLogHost()

Get the log host.

Returns:
The log host.
setLogPort
public void setLogPort(String logPort)

Set the log port

Parameters:
logPort
getLogPort
public String getLogPort()

Get the log port.

Returns:
The log port.
setTrace
public void setTrace(Boolean trace)

Set tracing.

Parameters:
trace
getTrace
public Boolean getTrace()

Check if tracing is enabled.

Returns:
true if it does; false otherwise
setSecureGUID
public void setSecureGUID(Boolean s)

Set secure GUID.

Parameters:
s
getSecureGUID
public Boolean getSecureGUID()

Check if secure GUID is enabled.

Returns:
true if it does; false otherwise
setReadTimeoutInSeconds
public void setReadTimeoutInSeconds(Integer readTimeoutInSeconds)

Set ReadTimeoutInSeconds.

Parameters:
readTimeoutInSeconds
getReadTimeoutInSeconds
public Integer getReadTimeoutInSeconds()

Get ReadTimeoutInSeconds

Returns:
readTimeoutInSeconds