Sun Adapter for File API

com.stc.connector.fileadapter.appconn
Class FileApplicationConnection

java.lang.Object
  extended by com.stc.connector.fileadapter.appconn.FileApplicationConnection
All Implemented Interfaces:
com.stc.connector.appconn.common.ApplicationConnection, com.stc.connector.framework.client.AssociateableHandle

public class FileApplicationConnection
extends java.lang.Object
implements com.stc.connector.appconn.common.ApplicationConnection, com.stc.connector.framework.client.AssociateableHandle

This class implements the ApplicationConnection interface for the File application connection.


Constructor Summary
FileApplicationConnection(com.stc.connector.framework.eway.ManagedConnectionCallback mc, FileOutboundConfiguration aConfiguration, com.stc.connector.framework.jca.system.MessageResourceManager aResourceManager)
          Creates a new instance of FileApplicationConnection.
 
Method Summary
 void close()
          Closes the application connection handle.
 java.lang.Object createApplication(java.lang.String appName)
          Creates an Application from the Application Connection.
 com.stc.connector.appconn.common.OutputHandler createOutputHandler()
          Creates an OutputHandler for "sending" data to the EIS.
 FileOutboundConfiguration getEwayConfiguration()
          Returns the instance of FileOutboundConfiguration populated with default configuration values
 com.stc.connector.management.util.ObjectReference getMonitor()
           
 com.stc.connector.framework.jca.system.MessageResourceManager getResourceManager()
           
 void initConfig()
          Creates an new instance of FileOutboundConfiguration and initializes it with default configuration values.
 void invalidateConnection()
          This is called by the ManagedConnection to invalidate the connection handle.
 void reassociateConnection(com.stc.connector.framework.eway.ManagedConnectionCallback mc)
          This is called by the ManagedConnection to associate the connection handle to the ManagedConnection.
 void setMonitor(com.stc.connector.management.util.ObjectReference mbean)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FileApplicationConnection

public FileApplicationConnection(com.stc.connector.framework.eway.ManagedConnectionCallback mc,
                                 FileOutboundConfiguration aConfiguration,
                                 com.stc.connector.framework.jca.system.MessageResourceManager aResourceManager)
                          throws FileApplicationException
Creates a new instance of FileApplicationConnection.

Parameters:
mc - The ManagedConnection which created this connection.
Throws:
FileApplicationException
Method Detail

close

public void close()
           throws com.stc.connector.appconn.common.ApplicationConnectionException
Closes the application connection handle. Once the close method is called, using the application created from the application connection must be forbidden and must result in an ApplicationConnectionException. The association between an application connection and the application is implementation specific.

Specified by:
close in interface com.stc.connector.appconn.common.ApplicationConnection
Throws:
com.stc.connector.appconn.common.ApplicationConnectionException - upon error.

createApplication

public java.lang.Object createApplication(java.lang.String appName)
                                   throws com.stc.connector.appconn.common.ApplicationException
Creates an Application from the Application Connection. The application is an API which can be used to interact with the underlying EIS. The application API must be invalidated once the close method is called on the Application Connection. If null is passed for the application name, then the default application will be created. Otherwise, the application name will be used to create the appropriate connection.

Specified by:
createApplication in interface com.stc.connector.appconn.common.ApplicationConnection
Parameters:
appName - The name of the application to create.
Returns:
A java.lang.Object representing the EIS specific application component to interact with the EIS.
Throws:
com.stc.connector.appconn.common.ApplicationException - upon error.

createOutputHandler

public com.stc.connector.appconn.common.OutputHandler createOutputHandler()
                                                                   throws com.stc.connector.appconn.common.ApplicationException
Creates an OutputHandler for "sending" data to the EIS. If the eWay does not support an OutputHandler, then it should return null for its implementation of this method.

Specified by:
createOutputHandler in interface com.stc.connector.appconn.common.ApplicationConnection
Returns:
The eWay specific OutputHandler for handling "sending" data to the external system or null if the eWay does not have an OutputHandler.
Throws:
com.stc.connector.appconn.common.ApplicationException - upon error.

invalidateConnection

public void invalidateConnection()
                          throws javax.resource.ResourceException
This is called by the ManagedConnection to invalidate the connection handle.

Specified by:
invalidateConnection in interface com.stc.connector.framework.client.AssociateableHandle
Throws:
javax.resource.ResourceException - upon error.

reassociateConnection

public void reassociateConnection(com.stc.connector.framework.eway.ManagedConnectionCallback mc)
                           throws javax.resource.ResourceException
This is called by the ManagedConnection to associate the connection handle to the ManagedConnection. The implementation should disassociate the associated ManagedConnection and associate itself to the ManagedConnection passed in as the argument.

Specified by:
reassociateConnection in interface com.stc.connector.framework.client.AssociateableHandle
Parameters:
mc - The ManagedConnection instance with which the connection handle will associate.
Throws:
javax.resource.ResourceException - upon error.

initConfig

public void initConfig()
                throws FileApplicationException
Creates an new instance of FileOutboundConfiguration and initializes it with default configuration values.

Throws:
FileApplicationException - upon error.

getEwayConfiguration

public FileOutboundConfiguration getEwayConfiguration()
Returns the instance of FileOutboundConfiguration populated with default configuration values

Returns:
the FileOutboundConfiguration

getResourceManager

public com.stc.connector.framework.jca.system.MessageResourceManager getResourceManager()

setMonitor

public void setMonitor(com.stc.connector.management.util.ObjectReference mbean)

getMonitor

public com.stc.connector.management.util.ObjectReference getMonitor()

Sun Adapter for File API

Copyright © 2008 Sun Microsystems, Inc. All Rights Reserved.